Merge branch '11139-nodemanager-mem-scale-factor'
[arvados.git] / services / nodemanager / doc / azure.example.cfg
1 # Azure configuration for Arvados Node Manager.
2 # All times are in seconds unless specified otherwise.
3
4 [Daemon]
5 # The dispatcher can customize the start and stop procedure for
6 # cloud nodes.  For example, the SLURM dispatcher drains nodes
7 # through SLURM before shutting them down.
8 #dispatcher = slurm
9
10 # Node Manager will ensure that there are at least this many nodes running at
11 # all times.  If node manager needs to start new idle nodes for the purpose of
12 # satisfying min_nodes, it will use the cheapest node type.  However, depending
13 # on usage patterns, it may also satisfy min_nodes by keeping alive some
14 # more-expensive nodes
15 min_nodes = 0
16
17 # Node Manager will not start any compute nodes when at least this
18 # many are running.
19 max_nodes = 8
20
21 # Upper limit on rate of spending (in $/hr), will not boot additional nodes
22 # if total price of already running nodes meets or exceeds this threshold.
23 # default 0 means no limit.
24 max_total_price = 0
25
26 # Poll Azure nodes and Arvados for new information every N seconds.
27 poll_time = 60
28
29 # Polls have exponential backoff when services fail to respond.
30 # This is the longest time to wait between polls.
31 max_poll_time = 300
32
33 # If Node Manager can't succesfully poll a service for this long,
34 # it will never start or stop compute nodes, on the assumption that its
35 # information is too outdated.
36 poll_stale_after = 600
37
38 # If Node Manager boots a cloud node, and it does not pair with an Arvados
39 # node before this long, assume that there was a cloud bootstrap failure and
40 # shut it down.  Note that normal shutdown windows apply (see the Cloud
41 # section), so this should be shorter than the first shutdown window value.
42 boot_fail_after = 1800
43
44 # "Node stale time" affects two related behaviors.
45 # 1. If a compute node has been running for at least this long, but it
46 # isn't paired with an Arvados node, do not shut it down, but leave it alone.
47 # This prevents the node manager from shutting down a node that might
48 # actually be doing work, but is having temporary trouble contacting the
49 # API server.
50 # 2. When the Node Manager starts a new compute node, it will try to reuse
51 # an Arvados node that hasn't been updated for this long.
52 node_stale_after = 14400
53
54 # Scaling factor to be applied to nodes' available RAM size. Usually there's a
55 # variable discrepancy between the advertised RAM value on cloud nodes and the
56 # actual amount available.
57 # If not set, this value will be set to 0.95
58 node_mem_scaling = 0.95
59
60 # File path for Certificate Authorities
61 certs_file = /etc/ssl/certs/ca-certificates.crt
62
63 [Logging]
64 # Log file path
65 file = /var/log/arvados/node-manager.log
66
67 # Log level for most Node Manager messages.
68 # Choose one of DEBUG, INFO, WARNING, ERROR, or CRITICAL.
69 # WARNING lets you know when polling a service fails.
70 # INFO additionally lets you know when a compute node is started or stopped.
71 level = INFO
72
73 # You can also set different log levels for specific libraries.
74 # Pykka is the Node Manager's actor library.
75 # Setting this to DEBUG will display tracebacks for uncaught
76 # exceptions in the actors, but it's also very chatty.
77 pykka = WARNING
78
79 # Setting apiclient to INFO will log the URL of every Arvados API request.
80 apiclient = WARNING
81
82 [Arvados]
83 host = zyxwv.arvadosapi.com
84 token = ARVADOS_TOKEN
85 timeout = 15
86
87 # Accept an untrusted SSL certificate from the API server?
88 insecure = no
89
90 [Cloud]
91 provider = azure
92
93 # Shutdown windows define periods of time when a node may and may not be shut
94 # down.  These are windows in full minutes, separated by commas.  Counting from
95 # the time the node is booted, the node WILL NOT shut down for N1 minutes; then
96 # it MAY shut down for N2 minutes; then it WILL NOT shut down for N3 minutes;
97 # and so on.  For example, "20, 999999" means the node may shut down between
98 # the 20th and 999999th minutes of uptime.
99 # Azure bills by the minute, so it makes sense to agressively shut down idle
100 # nodes.  Specify at least two windows.  You can add as many as you need beyond
101 # that.
102 shutdown_windows = 20, 999999
103
104 [Cloud Credentials]
105 # Use "azure account list" with the azure CLI to get these values.
106 tenant_id = 00000000-0000-0000-0000-000000000000
107 subscription_id = 00000000-0000-0000-0000-000000000000
108
109 # The following directions are based on
110 # https://azure.microsoft.com/en-us/documentation/articles/resource-group-authenticate-service-principal/
111 #
112 # azure config mode arm
113 # azure ad app create --name "<Your Application Display Name>" --home-page "<https://YourApplicationHomePage>" --identifier-uris "<https://YouApplicationUri>" --password <Your_Password>
114 # azure ad sp create "<Application_Id>"
115 # azure role assignment create --objectId "<Object_Id>" -o Owner -c /subscriptions/{subscriptionId}/
116 #
117 # Use <Application_Id> for "key" and the <Your_Password> for "secret"
118 #
119 key = 00000000-0000-0000-0000-000000000000
120 secret = PASSWORD
121 timeout = 60
122 region = East US
123
124 [Cloud List]
125 # The resource group in which the compute node virtual machines will be created
126 # and listed.
127 ex_resource_group = ArvadosResourceGroup
128
129 [Cloud Create]
130 # The image id, in the form "Publisher:Offer:SKU:Version"
131 image = Canonical:UbuntuServer:14.04.3-LTS:14.04.201508050
132
133 # Path to a local ssh key file that will be used to provision new nodes.
134 ssh_key = /home/arvadosuser/.ssh/id_rsa.pub
135
136 # The account name for the admin user that will be provisioned on new nodes.
137 ex_user_name = arvadosuser
138
139 # The Azure storage account that will be used to store the node OS disk images.
140 ex_storage_account = arvadosstorage
141
142 # The virtual network the VMs will be associated with.
143 ex_network = ArvadosNetwork
144
145 # Optional subnet of the virtual network.
146 #ex_subnet = default
147
148 # Node tags
149 tag_arvados-class = dynamic-compute
150 tag_cluster = zyxwv
151
152 # the API server to ping
153 ping_host = hostname:port
154
155 # You can define any number of Size sections to list Azure sizes you're willing
156 # to use.  The Node Manager should boot the cheapest size(s) that can run jobs
157 # in the queue.  You must also provide price per hour as the Azure driver
158 # compute currently does not report prices.
159 #
160 # See https://azure.microsoft.com/en-us/pricing/details/virtual-machines/
161 # for a list of known machine types that may be used as a Size parameter.
162 #
163 # Each size section MUST define the number of cores are available in this
164 # size class (since libcloud does not provide any consistent API for exposing
165 # this setting).
166 # You may also want to define the amount of scratch space (expressed
167 # in GB) for Crunch jobs.  You can also override Microsoft's provided
168 # data fields by setting them here.
169
170 [Size Standard_D3]
171 cores = 4
172 price = 0.56
173
174 [Size Standard_D4]
175 cores = 8
176 price = 1.12