365c8ee9184d8427eb1fd7a4a3ca928ed47891de
[arvados.git] / services / nodemanager / doc / gce.example.cfg
1 # Google Compute Engine configuration for Arvados Node Manager.
2 # All times are in seconds unless specified otherwise.
3
4 [Management]
5 # The management server responds to http://addr:port/status.json with
6 # a snapshot of internal state.
7
8 # Management server listening address (default 127.0.0.1)
9 #address = 0.0.0.0
10
11 # Management server port number (default -1, server is disabled)
12 #port = 8989
13
14 [Daemon]
15 # Node Manager will ensure that there are at least this many nodes running at
16 # all times.  If node manager needs to start new idle nodes for the purpose of
17 # satisfying min_nodes, it will use the cheapest node type.  However, depending
18 # on usage patterns, it may also satisfy min_nodes by keeping alive some
19 # more-expensive nodes
20 min_nodes = 0
21
22 # Node Manager will not start any compute nodes when at least this
23 # running at all times.  By default, these will be the cheapest node size.
24 max_nodes = 8
25
26 # Poll compute nodes and Arvados for new information every N seconds.
27 poll_time = 60
28
29 # Upper limit on rate of spending (in $/hr), will not boot additional nodes
30 # if total price of already running nodes meets or exceeds this threshold.
31 # default 0 means no limit.
32 max_total_price = 0
33
34 # Polls have exponential backoff when services fail to respond.
35 # This is the longest time to wait between polls.
36 max_poll_time = 300
37
38 # If Node Manager can't succesfully poll a service for this long,
39 # it will never start or stop compute nodes, on the assumption that its
40 # information is too outdated.
41 poll_stale_after = 600
42
43 # "Node stale time" affects two related behaviors.
44 # 1. If a compute node has been running for at least this long, but it
45 # isn't paired with an Arvados node, do not shut it down, but leave it alone.
46 # This prevents the node manager from shutting down a node that might
47 # actually be doing work, but is having temporary trouble contacting the
48 # API server.
49 # 2. When the Node Manager starts a new compute node, it will try to reuse
50 # an Arvados node that hasn't been updated for this long.
51 node_stale_after = 14400
52
53 # Scaling factor to be applied to nodes' available RAM size. Usually there's a
54 # variable discrepancy between the advertised RAM value on cloud nodes and the
55 # actual amount available.
56 # If not set, this value will be set to 0.95
57 node_mem_scaling = 0.95
58
59 # File path for Certificate Authorities
60 certs_file = /etc/ssl/certs/ca-certificates.crt
61
62 [Logging]
63 # Log file path
64 file = /var/log/arvados/node-manager.log
65
66 # Log level for most Node Manager messages.
67 # Choose one of DEBUG, INFO, WARNING, ERROR, or CRITICAL.
68 # WARNING lets you know when polling a service fails.
69 # INFO additionally lets you know when a compute node is started or stopped.
70 level = INFO
71
72 # You can also set different log levels for specific libraries.
73 # Pykka is the Node Manager's actor library.
74 # Setting this to DEBUG will display tracebacks for uncaught
75 # exceptions in the actors, but it's also very chatty.
76 pykka = WARNING
77
78 # Setting apiclient to INFO will log the URL of every Arvados API request.
79 apiclient = WARNING
80
81 [Arvados]
82 host = zyxwv.arvadosapi.com
83 token = ARVADOS_TOKEN
84 timeout = 15
85
86 # Accept an untrusted SSL certificate from the API server?
87 insecure = no
88
89 [Cloud]
90 provider = gce
91
92 # Shutdown windows define periods of time when a node may and may not
93 # be shut down.  These are windows in full minutes, separated by
94 # commas.  Counting from the time the node is booted, the node WILL
95 # NOT shut down for N1 minutes; then it MAY shut down for N2 minutes;
96 # then it WILL NOT shut down for N3 minutes; and so on.  For example,
97 # "54, 5, 1" means the node may shut down from the 54th to the 59th
98 # minute of each hour of uptime.
99 # GCE bills by the minute, and does not provide information about when
100 # a node booted.  Node Manager will store this information in metadata
101 # when it boots a node; if that information is not available, it will
102 # assume the node booted at the epoch.  These shutdown settings are
103 # very aggressive.  You may want to adjust this if you want more
104 # continuity of service from a single node.
105 shutdown_windows = 20, 999999
106
107 [Cloud Credentials]
108 user_id = client_email_address@developer.gserviceaccount.com
109 key = path_to_certificate.pem
110 project = project-id-from-google-cloud-dashboard
111 timeout = 60
112
113 # Valid location (zone) names: https://cloud.google.com/compute/docs/zones
114 datacenter = us-central1-a
115
116 # Optional settings. For full documentation see
117 # http://libcloud.readthedocs.org/en/latest/compute/drivers/gce.html#libcloud.compute.drivers.gce.GCENodeDriver
118 #
119 # auth_type = SA               # SA, IA or GCE
120 # scopes = https://www.googleapis.com/auth/compute
121 # credential_file =
122
123 [Cloud List]
124 # A comma-separated list of tags that must be applied to a node for it to
125 # be considered a compute node.
126 # The driver will automatically apply these tags to nodes it creates.
127 tags = zyxwv, compute
128
129 [Cloud Create]
130 # New compute nodes will send pings to Arvados at this host.
131 # You may specify a port, and use brackets to disambiguate IPv6 addresses.
132 ping_host = hostname:port
133
134 # A file path for an SSH key that can log in to the compute node.
135 # ssh_key = path
136
137 # The GCE image name and network zone name to use when creating new nodes.
138 image = debian-7
139 # network = your_network_name
140
141 # JSON string of service account authorizations for this cluster.
142 # See http://libcloud.readthedocs.org/en/latest/compute/drivers/gce.html#specifying-service-account-scopes
143 # service_accounts = [{'email':'account@example.com', 'scopes':['storage-ro']}]
144
145
146 # You can define any number of Size sections to list node sizes you're
147 # willing to use.  The Node Manager should boot the cheapest size(s) that
148 # can run jobs in the queue.
149 #
150 # The Size fields are interpreted the same way as with a libcloud NodeSize:
151 # http://libcloud.readthedocs.org/en/latest/compute/api.html#libcloud.compute.base.NodeSize
152 #
153 # See https://cloud.google.com/compute/docs/machine-types for a list
154 # of known machine types that may be used as a Size parameter.
155 #
156 # Each size section MUST define the number of cores are available in this
157 # size class (since libcloud does not provide any consistent API for exposing
158 # this setting).
159 # You may also want to define the amount of scratch space (expressed
160 # in GB) for Crunch jobs.
161 # You can also override Google's provided data fields (such as price per hour)
162 # by setting them here.
163
164 [Size n1-standard-2]
165 cores = 2
166 price = 0.076
167 scratch = 100
168
169 [Size n1-standard-4]
170 cores = 4
171 price = 0.152
172 scratch = 200