Merge branch '4434-collation' closes #4434
[arvados.git] / services / nodemanager / doc / ec2.example.cfg
1 # EC2 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
6 # running at all times.
7 min_nodes = 0
8
9 # Node Manager will not start any compute nodes when at least this
10 # many are running.
11 max_nodes = 8
12
13 # Poll EC2 nodes and Arvados for new information every N seconds.
14 poll_time = 60
15
16 # Polls have exponential backoff when services fail to respond.
17 # This is the longest time to wait between polls.
18 max_poll_time = 300
19
20 # If Node Manager can't succesfully poll a service for this long,
21 # it will never start or stop compute nodes, on the assumption that its
22 # information is too outdated.
23 poll_stale_after = 600
24
25 # "Node stale time" affects two related behaviors.
26 # 1. If a compute node has been running for at least this long, but it
27 # isn't paired with an Arvados node, do not shut it down, but leave it alone.
28 # This prevents the node manager from shutting down a node that might
29 # actually be doing work, but is having temporary trouble contacting the
30 # API server.
31 # 2. When the Node Manager starts a new compute node, it will try to reuse
32 # an Arvados node that hasn't been updated for this long.
33 node_stale_after = 14400
34
35 # File path for Certificate Authorities
36 certs_file = /etc/ssl/certs/ca-certificates.crt
37
38 [Logging]
39 # Log file path
40 file = /var/log/arvados/node-manager.log
41
42 # Log level for most Node Manager messages.
43 # Choose one of DEBUG, INFO, WARNING, ERROR, or CRITICAL.
44 # WARNING lets you know when polling a service fails.
45 # INFO additionally lets you know when a compute node is started or stopped.
46 level = INFO
47
48 # You can also set different log levels for specific libraries.
49 # Pykka is the Node Manager's actor library.
50 # Setting this to DEBUG will display tracebacks for uncaught
51 # exceptions in the actors, but it's also very chatty.
52 pykka = WARNING
53
54 # Setting apiclient to INFO will log the URL of every Arvados API request.
55 apiclient = WARNING
56
57 [Arvados]
58 host = zyxwv.arvadosapi.com
59 token = ARVADOS_TOKEN
60 timeout = 15
61
62 # Accept an untrusted SSL certificate from the API server?
63 insecure = no
64
65 [Cloud]
66 provider = ec2
67
68 # It's usually most cost-effective to shut down compute nodes during narrow
69 # windows of time.  For example, EC2 bills each node by the hour, so the best
70 # time to shut down a node is right before a new hour of uptime starts.
71 # Shutdown windows define these periods of time.  These are windows in
72 # full minutes, separated by commas.  Counting from the time the node is
73 # booted, the node WILL NOT shut down for N1 minutes; then it MAY shut down
74 # for N2 minutes; then it WILL NOT shut down for N3 minutes; and so on.
75 # For example, "54, 5, 1" means the node may shut down from the 54th to the
76 # 59th minute of each hour of uptime.
77 # Specify at least two windows.  You can add as many as you need beyond that.
78 shutdown_windows = 54, 5, 1
79
80 [Cloud Credentials]
81 key = KEY
82 secret = SECRET_KEY
83 region = us-east-1
84 timeout = 60
85
86 [Cloud List]
87 # This section defines filters that find compute nodes.
88 # Tags that you specify here will automatically be added to nodes you create.
89 # Replace colons in Amazon filters with underscores
90 # (e.g., write "tag:mytag" as "tag_mytag").
91 instance-state-name = running
92 tag_arvados-class = dynamic-compute
93 tag_cluster = zyxwv
94
95 [Cloud Create]
96 # New compute nodes will send pings to Arvados at this host.
97 # You may specify a port, and use brackets to disambiguate IPv6 addresses.
98 ping_host = hostname:port
99
100 # Give the name of an SSH key on AWS...
101 ex_keyname = string
102
103 # ... or a file path for an SSH key that can log in to the compute node.
104 # (One or the other, not both.)
105 # ssh_key = path
106
107 # The EC2 IDs of the image and subnet compute nodes should use.
108 image_id = idstring
109 subnet_id = idstring
110
111 # Comma-separated EC2 IDs for the security group(s) assigned to each
112 # compute node.
113 security_groups = idstring1, idstring2
114
115 [Size t2.medium]
116 # You can define any number of Size sections to list EC2 sizes you're
117 # willing to use.  The Node Manager should boot the cheapest size(s) that
118 # can run jobs in the queue (N.B.: defining more than one size has not been
119 # tested yet).
120 # Each size section MUST define the number of cores it has.  You may also
121 # want to define the number of mebibytes of scratch space for Crunch jobs.
122 # You can also override Amazon's provided data fields by setting the same
123 # names here.
124 cores = 2
125 scratch = 100