tools/compute-images/host_config.example.yml

   1 ### This file documents common cloud-agnostic configuration options to build
   2 ### an Arvados compute node image. To use this file, copy it to
   3 ### `host_config.yml`, then edit it as desired following the comments below.
   4 # Copyright (C) The Arvados Authors. All rights reserved.
   5 #
   6 # SPDX-License-Identifier: Apache-2.0
   7
   8 # `arvados_config_file` is the ABSOLUTE path of an Arvados cluster
   9 # configuration file. Ansible reads various settings from this file to
  10 # make sure system configuration is consistent with cluster configuration.
  11 # This file MUST be readable by the user running Ansible/Packer, along with
  12 # any files it references (e.g., `Containers.DispatchPrivateKey`).
  13 arvados_config_file: /etc/arvados/config.yml
  14
  15 # `arvados_cluster_id` is a five-character cluster identifier defined under
  16 # `Clusters` in `ansible_config_file`. Ansible will use configuration
  17 # settings from this specific cluster.
  18 # If you are running Packer, you do not need to set this; the `arvados_cluster`
  19 # you set there will be passed through to Ansible.
  20 # Otherwise, you MUST set this to the identifier of the cluster you are
  21 # setting up a compute node for.
  22 #arvados_cluster_id: xxxxx
  23
  24 # `arvados_compute_nvidia` is a flag that determines whether or not
  25 # NVIDIA CUDA and associated drivers will be installed in the compute
  26 # node image. Set this to true if you want your Arvados cluster to
  27 # support containers with CUDA requirements.
  28 #arvados_compute_nvidia: true
  29
  30 # `dns_resolver` can be set to the IP address of a DNS server. If you
  31 # set this, compute nodes will be configured to use this DNS server
  32 # before those set by DHCP.
  33 #dns_resolver: "192.0.2.2"
  34
  35 # `arvados_compute_encrypted_tmp` can name a method that will be used
  36 # to provide an encrypted working directory to running containers.
  37 # By default, the image will use dynamically scaling EBS storage if it
  38 # detects that it is being built on AWS EC2, and local storage otherwise.
  39 # If you are building an image for AWS EC2 and do not want to use dynamic
  40 # EBS storage, set this to the empty string.
  41 # If you are building an image for AWS EC2 and the detection fails for
  42 # any reason, you can set this to 'aws_ebs' to force the use of dynamic
  43 # EBS storage.
  44 # EBS autoscaling requires additional configuration in AWS IAM and your
  45 # cluster's `config.yml`. See
  46 # <http://doc.arvados.org/install/crunch2-cloud/install-dispatch-cloud.html#aws-ebs-autoscaler>
  47 #arvados_compute_encrypted_tmp: ""
  48
  49 # `workdir` names a directory where Ansible should write temporary files as
  50 # it sets up the compute node image. The default respects the $TMPDIR
  51 # environment variable on the compute image, or uses `/tmp` if that's not
  52 # set. You can specify another directory if `/tmp` is low on space or
  53 # restricted as a security measure.
  54 #workdir: "{{ ansible_env.HOME }}"
  55
  56 ### The settings below should not be changed for production deployments.
  57 ### These settings help support Arvados testing.
  58 # `arvados_pin_version` identifies the version of Arvados packages that
  59 # should be installed on the compute node. The default matches the release
  60 # of this build tool. You can set this to the empty string to install
  61 # whatever the latest version is at the time you build the image.
  62 #arvados_pin_version: ""
  63
  64 # `arvados_apt_suites` identifies which set of packages to fetch and install
  65 # from apt.arvados.org. The default is to match the release codename of your
  66 # distribution, which will get production releases built for that
  67 # distribution. If this value starts with `-`, the deployment will
  68 # automatically prepend that release codename. You can set this to
  69 # '-testing' or '-dev' to install release candidate or development packages
  70 # for your base distribution, respectively.
  71 #arvados_apt_suites: "-testing"
  72
  73 # `arvados_compute_pin_packages` is a flag that determines whether or not
  74 # to pin third-party dependencies like Docker and NVIDIA CUDA to versions
  75 # that have been tested to work with this release of Arvados. You can set
  76 # this to false to build a compute image with the latest versions of those
  77 # dependencies.
  78 #arvados_compute_pin_packages: true