services/nodemanager/doc/gce.example.cfg

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