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