services/nodemanager/doc/ec2.example.cfg

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: AGPL-3.0
   4
   5 # EC2 configuration for Arvados Node Manager.
   6 # All times are in seconds unless specified otherwise.
   7
   8 [Manage]
   9 # The management server responds to http://addr:port/status.json with
  10 # a snapshot of internal state.
  11
  12 # Management server listening address (default 127.0.0.1)
  13 #address = 0.0.0.0
  14
  15 # Management server port number (default -1, server is disabled)
  16 #port = 8989
  17
  18 [Daemon]
  19 # The dispatcher can customize the start and stop procedure for
  20 # cloud nodes.  For example, the SLURM dispatcher drains nodes
  21 # through SLURM before shutting them down.
  22 #dispatcher = slurm
  23
  24 # Node Manager will ensure that there are at least this many nodes running at
  25 # all times.  If node manager needs to start new idle nodes for the purpose of
  26 # satisfying min_nodes, it will use the cheapest node type.  However, depending
  27 # on usage patterns, it may also satisfy min_nodes by keeping alive some
  28 # more-expensive nodes
  29 min_nodes = 0
  30
  31 # Node Manager will not start any compute nodes when at least this
  32 # many are running.
  33 max_nodes = 8
  34
  35 # Upper limit on rate of spending (in $/hr), will not boot additional nodes
  36 # if total price of already running nodes meets or exceeds this threshold.
  37 # default 0 means no limit.
  38 max_total_price = 0
  39
  40 # Poll EC2 nodes and Arvados for new information every N seconds.
  41 poll_time = 60
  42
  43 # Polls have exponential backoff when services fail to respond.
  44 # This is the longest time to wait between polls.
  45 max_poll_time = 300
  46
  47 # If Node Manager can't succesfully poll a service for this long,
  48 # it will never start or stop compute nodes, on the assumption that its
  49 # information is too outdated.
  50 poll_stale_after = 600
  51
  52 # If Node Manager boots a cloud node, and it does not pair with an Arvados
  53 # node before this long, assume that there was a cloud bootstrap failure and
  54 # shut it down.  Note that normal shutdown windows apply (see the Cloud
  55 # section), so this should be shorter than the first shutdown window value.
  56 boot_fail_after = 1800
  57
  58 # "Node stale time" affects two related behaviors.
  59 # 1. If a compute node has been running for at least this long, but it
  60 # isn't paired with an Arvados node, do not shut it down, but leave it alone.
  61 # This prevents the node manager from shutting down a node that might
  62 # actually be doing work, but is having temporary trouble contacting the
  63 # API server.
  64 # 2. When the Node Manager starts a new compute node, it will try to reuse
  65 # an Arvados node that hasn't been updated for this long.
  66 node_stale_after = 14400
  67
  68 # Scaling factor to be applied to nodes' available RAM size. Usually there's a
  69 # variable discrepancy between the advertised RAM value on cloud nodes and the
  70 # actual amount available.
  71 # If not set, this value will be set to 0.95
  72 node_mem_scaling = 0.95
  73
  74 # File path for Certificate Authorities
  75 certs_file = /etc/ssl/certs/ca-certificates.crt
  76
  77 [Logging]
  78 # Log file path
  79 file = /var/log/arvados/node-manager.log
  80
  81 # Log level for most Node Manager messages.
  82 # Choose one of DEBUG, INFO, WARNING, ERROR, or CRITICAL.
  83 # WARNING lets you know when polling a service fails.
  84 # INFO additionally lets you know when a compute node is started or stopped.
  85 level = INFO
  86
  87 # You can also set different log levels for specific libraries.
  88 # Pykka is the Node Manager's actor library.
  89 # Setting this to DEBUG will display tracebacks for uncaught
  90 # exceptions in the actors, but it's also very chatty.
  91 pykka = WARNING
  92
  93 # Setting apiclient to INFO will log the URL of every Arvados API request.
  94 apiclient = WARNING
  95
  96 [Arvados]
  97 host = zyxwv.arvadosapi.com
  98 token = ARVADOS_TOKEN
  99 timeout = 15
 100 jobs_queue = yes   # Get work request from Arvados jobs queue (jobs API)
 101 slurm_queue = yes  # Get work request from squeue (containers API)
 102
 103 # Accept an untrusted SSL certificate from the API server?
 104 insecure = no
 105
 106 [Cloud]
 107 provider = ec2
 108
 109 # It's usually most cost-effective to shut down compute nodes during narrow
 110 # windows of time.  For example, EC2 bills each node by the hour, so the best
 111 # time to shut down a node is right before a new hour of uptime starts.
 112 # Shutdown windows define these periods of time.  These are windows in
 113 # full minutes, separated by commas.  Counting from the time the node is
 114 # booted, the node WILL NOT shut down for N1 minutes; then it MAY shut down
 115 # for N2 minutes; then it WILL NOT shut down for N3 minutes; and so on.
 116 # For example, "54, 5, 1" means the node may shut down from the 54th to the
 117 # 59th minute of each hour of uptime.
 118 # Specify at least two windows.  You can add as many as you need beyond that.
 119 shutdown_windows = 54, 5, 1
 120
 121 [Cloud Credentials]
 122 key = KEY
 123 secret = SECRET_KEY
 124 region = us-east-1
 125 timeout = 60
 126
 127 [Cloud List]
 128 # This section defines filters that find compute nodes.
 129 # Tags that you specify here will automatically be added to nodes you create.
 130 # Replace colons in Amazon filters with underscores
 131 # (e.g., write "tag:mytag" as "tag_mytag").
 132 instance-state-name = running
 133 tag_arvados-class = dynamic-compute
 134 tag_cluster = zyxwv
 135
 136 [Cloud Create]
 137 # New compute nodes will send pings to Arvados at this host.
 138 # You may specify a port, and use brackets to disambiguate IPv6 addresses.
 139 ping_host = hostname:port
 140
 141 # Give the name of an SSH key on AWS...
 142 ex_keyname = string
 143
 144 # ... or a file path for an SSH key that can log in to the compute node.
 145 # (One or the other, not both.)
 146 # ssh_key = path
 147
 148 # The EC2 IDs of the image and subnet compute nodes should use.
 149 image_id = idstring
 150 subnet_id = idstring
 151
 152 # Comma-separated EC2 IDs for the security group(s) assigned to each
 153 # compute node.
 154 security_groups = idstring1, idstring2
 155
 156
 157 # You can define any number of Size sections to list EC2 sizes you're
 158 # willing to use.  The Node Manager should boot the cheapest size(s) that
 159 # can run jobs in the queue.
 160 #
 161 # Each size section MUST define the number of cores are available in this
 162 # size class (since libcloud does not provide any consistent API for exposing
 163 # this setting).
 164 # You may also want to define the amount of scratch space (expressed
 165 # in GB) for Crunch jobs.  You can also override Amazon's provided
 166 # data fields (such as price per hour) by setting them here.
 167
 168 [Size m4.large]
 169 cores = 2
 170 price = 0.126
 171 scratch = 100
 172
 173 [Size m4.xlarge]
 174 cores = 4
 175 price = 0.252
 176 scratch = 100