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 # `compute_authorized_keys` is the ABSOLUTE path to a file with additional
  25 # public SSH keys to authorize for the Crunch user, in `authorized_keys`
  26 # format. If your copy of `arvados_config_file` does not have
  27 # `Containers.DispatchPrivateKey` set for security reasons, you can name a
  28 # file with the dispatcher's public key here.
  29 #compute_authorized_keys: /dev/null
  30
  31 # `arvados_compute_nvidia` is a flag that determines whether or not
  32 # NVIDIA CUDA and associated drivers will be installed in the compute
  33 # node image. Set this to true if you want your Arvados cluster to
  34 # support containers with CUDA requirements.
  35 #arvados_compute_nvidia: true
  36
  37 # `dns_resolver` can be set to the IP address of a DNS server. If you
  38 # set this, compute nodes will be configured to use this DNS server
  39 # before those set by DHCP.
  40 #dns_resolver: "192.0.2.2"
  41
  42 # `arvados_compute_encrypted_tmp` can name a method that will be used
  43 # to provide an encrypted working directory to running containers.
  44 # By default, the image will use dynamically scaling EBS storage if it
  45 # detects that it is being built on AWS EC2, and local storage otherwise.
  46 # If you are building an image for AWS EC2 and do not want to use dynamic
  47 # EBS storage, set this to the empty string.
  48 # If you are building an image for AWS EC2 and the detection fails for
  49 # any reason, you can set this to 'aws_ebs' to force the use of dynamic
  50 # EBS storage.
  51 # EBS autoscaling requires additional configuration in AWS IAM and your
  52 # cluster's `config.yml`. See
  53 # <http://doc.arvados.org/install/crunch2-cloud/install-dispatch-cloud.html#aws-ebs-autoscaler>
  54 #arvados_compute_encrypted_tmp: ""
  55
  56 # `workdir` names a directory where Ansible should write temporary files as
  57 # it sets up the compute node image. The default respects the $TMPDIR
  58 # environment variable on the compute image, or uses `/tmp` if that's not
  59 # set. You can specify another directory if `/tmp` is low on space or
  60 # restricted as a security measure.
  61 #workdir: "{{ ansible_env.HOME }}"
  62
  63 ### The settings below should not be changed for production deployments.
  64 ### These settings help support Arvados testing.
  65 # `arvados_pin_version` identifies the version of Arvados packages that
  66 # should be installed on the compute node. The default matches the release
  67 # of this build tool. You can set this to the empty string to install
  68 # whatever the latest version is at the time you build the image.
  69 #arvados_pin_version: ""
  70
  71 # `arvados_apt_suites` identifies which set of packages to fetch and install
  72 # from apt.arvados.org. The default is to match the release codename of your
  73 # distribution, which will get production releases built for that
  74 # distribution. If this value starts with `-`, the deployment will
  75 # automatically prepend that release codename. You can set this to
  76 # '-testing' or '-dev' to install release candidate or development packages
  77 # for your base distribution, respectively.
  78 #arvados_apt_suites: "-testing"
  79
  80 # `arvados_compute_pin_packages` is a flag that determines whether or not
  81 # to pin third-party dependencies like Docker and NVIDIA CUDA to versions
  82 # that have been tested to work with this release of Arvados. You can set
  83 # this to false to build a compute image with the latest versions of those
  84 # dependencies.
  85 #arvados_compute_pin_packages: true
  86
  87 # `arvados_compute_amd_rocm` is a flag that determines whether or not
  88 # AMD ROCm and associated drivers will be installed in the compute
  89 # node image. This support is still in development and untested.
  90 # Note this installs >30GB of packages and requires additional space
  91 # to compile the drivers. Make sure you allocate enough disk space for
  92 # this in your Packer configuration.
  93 #arvados_compute_amd_rocm: true