services/nodemanager/doc/ec2.example.cfg

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