tools/compute-images/scripts/base.sh

   1 #!/bin/bash -euxo pipefail
   2
   3 # Copyright (C) The Arvados Authors. All rights reserved.
   4 #
   5 # SPDX-License-Identifier: Apache-2.0
   6
   7 set -eu -o pipefail
   8
   9 SUDO=sudo
  10
  11 wait_for_apt_locks() {
  12   while $SUDO fuser /var/{lib/{dpkg,apt/lists},cache/apt/archives}/lock >/dev/null 2>&1; do
  13     echo "APT: Waiting for apt/dpkg locks to be released..."
  14     sleep 1
  15   done
  16 }
  17
  18 # Run apt-get update
  19 $SUDO DEBIAN_FRONTEND=noninteractive apt-get --yes update
  20
  21 # Install gnupg and dirmgr or gpg key checks will fail
  22 wait_for_apt_locks && $SUDO DEBIAN_FRONTEND=noninteractive apt-get -qq --yes install \
  23   gnupg \
  24   dirmngr \
  25   lsb-release
  26
  27 # For good measure, apt-get upgrade
  28 wait_for_apt_locks && $SUDO DEBIAN_FRONTEND=noninteractive apt-get -qq --yes upgrade
  29
  30 # Make sure cloud-init is installed
  31 wait_for_apt_locks && $SUDO DEBIAN_FRONTEND=noninteractive apt-get -qq --yes install cloud-init
  32 if [[ ! -d /var/lib/cloud/scripts/per-boot ]]; then
  33   mkdir -p /var/lib/cloud/scripts/per-boot
  34 fi
  35
  36 TMP_LSB=`/usr/bin/lsb_release -c -s`
  37 LSB_RELEASE_CODENAME=${TMP_LSB//[$'\t\r\n ']}
  38
  39 # Add the arvados apt repository
  40 echo "# apt.arvados.org" |$SUDO tee --append /etc/apt/sources.list.d/apt.arvados.org.list
  41 echo "deb http://apt.arvados.org/$LSB_RELEASE_CODENAME $LSB_RELEASE_CODENAME${REPOSUFFIX} main" |$SUDO tee --append /etc/apt/sources.list.d/apt.arvados.org.list
  42
  43 # Add the arvados signing key
  44 cat /tmp/1078ECD7.asc | $SUDO apt-key add -
  45 # Add the debian keys
  46 wait_for_apt_locks && $SUDO DEBIAN_FRONTEND=noninteractive apt-get install --yes debian-keyring debian-archive-keyring
  47
  48 # Fix locale
  49 $SUDO /bin/sed -ri 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen
  50 $SUDO /usr/sbin/locale-gen
  51
  52 # Install some packages we always need
  53 wait_for_apt_locks && $SUDO DEBIAN_FRONTEND=noninteractive apt-get --yes update
  54 wait_for_apt_locks && $SUDO DEBIAN_FRONTEND=noninteractive apt-get -qq --yes install \
  55   openssh-server \
  56   apt-utils \
  57   git \
  58   curl \
  59   libcurl3-gnutls \
  60   libcurl4-openssl-dev \
  61   lvm2 \
  62   cryptsetup \
  63   xfsprogs \
  64   squashfs-tools
  65
  66 # Install the Arvados packages we need
  67 wait_for_apt_locks && $SUDO DEBIAN_FRONTEND=noninteractive apt-get -qq --yes install \
  68   python3-arvados-fuse \
  69   arvados-docker-cleaner \
  70   docker.io
  71
  72 # Get Go and build singularity
  73 goversion=1.17.1
  74 mkdir -p /var/lib/arvados
  75 rm -rf /var/lib/arvados/go/
  76 curl -s https://storage.googleapis.com/golang/go${goversion}.linux-amd64.tar.gz | tar -C /var/lib/arvados -xzf -
  77 ln -sf /var/lib/arvados/go/bin/* /usr/local/bin/
  78
  79 singularityversion=3.7.4
  80 curl -Ls https://github.com/sylabs/singularity/archive/refs/tags/v${singularityversion}.tar.gz | tar -C /var/lib/arvados -xzf -
  81 cd /var/lib/arvados/singularity-${singularityversion}
  82
  83 # build dependencies for singularity
  84 wait_for_apt_locks && $SUDO DEBIAN_FRONTEND=noninteractive apt-get -qq --yes install \
  85   make build-essential libssl-dev uuid-dev cryptsetup
  86
  87 echo $singularityversion > VERSION
  88 ./mconfig --prefix=/var/lib/arvados
  89 make -C ./builddir
  90 make -C ./builddir install
  91 ln -sf /var/lib/arvados/bin/* /usr/local/bin/
  92
  93 # set `mksquashfs mem` in the singularity config file if it is configured
  94 if [ "$MKSQUASHFS_MEM" != "" ]; then
  95   echo "mksquashfs mem = ${MKSQUASHFS_MEM}" >> /var/lib/arvados/etc/singularity/singularity.conf
  96 fi
  97
  98 # Print singularity version installed
  99 singularity --version
 100
 101 # Remove unattended-upgrades if it is installed
 102 wait_for_apt_locks && $SUDO DEBIAN_FRONTEND=noninteractive apt-get -qq --yes remove unattended-upgrades --purge
 103
 104 # Configure arvados-docker-cleaner
 105 $SUDO mkdir -p /etc/arvados/docker-cleaner
 106 $SUDO echo -e "{\n  \"Quota\": \"10G\",\n  \"RemoveStoppedContainers\": \"always\"\n}" > /etc/arvados/docker-cleaner/docker-cleaner.json
 107
 108 # Enable cgroup accounting
 109 $SUDO sed -i 's/GRUB_CMDLINE_LINUX=""/GRUB_CMDLINE_LINUX="cgroup_enable=memory swapaccount=1"/g' /etc/default/grub
 110 $SUDO update-grub
 111
 112 # Set a higher ulimit and the resolver (if set) for docker
 113 if [ "x$RESOLVER" != "x" ]; then
 114   SET_RESOLVER="--dns ${RESOLVER}"
 115 fi
 116
 117 $SUDO sed "s/ExecStart=\(.*\)/ExecStart=\1 --default-ulimit nofile=10000:10000 ${SET_RESOLVER}/g" \
 118   /lib/systemd/system/docker.service \
 119   > /etc/systemd/system/docker.service
 120
 121 $SUDO systemctl daemon-reload
 122
 123 # docker should not start on boot: we restart it inside /usr/local/bin/ensure-encrypted-partitions.sh,
 124 # and the BootProbeCommand might be "docker ps -q"
 125 $SUDO systemctl disable docker
 126
 127 # Make sure user_allow_other is set in fuse.conf
 128 $SUDO sed -i 's/#user_allow_other/user_allow_other/g' /etc/fuse.conf
 129
 130 # Add crunch user with sudo powers
 131 $SUDO adduser --disabled-password --gecos "Crunch user,,,," crunch
 132 # Do not require a password to sudo
 133 echo -e "# for the crunch user\ncrunch ALL=(ALL) NOPASSWD:ALL" | $SUDO tee /etc/sudoers.d/91-crunch
 134
 135 # Set up the ssh public key for the crunch user
 136 $SUDO mkdir /home/crunch/.ssh
 137 $SUDO mv /tmp/crunch-authorized_keys /home/crunch/.ssh/authorized_keys
 138 $SUDO chown -R crunch:crunch /home/crunch/.ssh
 139 $SUDO chmod 600 /home/crunch/.ssh/authorized_keys
 140 $SUDO chmod 700 /home/crunch/.ssh/
 141
 142 # Make sure we resolve via the provided resolver IP if set. Prepending is good enough because
 143 # unless 'rotate' is set, the nameservers are queried in order (cf. man resolv.conf)
 144 if [ "x$RESOLVER" != "x" ]; then
 145   $SUDO sed -i "s/#prepend domain-name-servers 127.0.0.1;/prepend domain-name-servers ${RESOLVER};/" /etc/dhcp/dhclient.conf
 146 fi
 147
 148 # AWS_EBS_AUTOSCALE is not always set, work around unset variable check
 149 EBS_AUTOSCALE=${AWS_EBS_AUTOSCALE:-}
 150
 151 if [ "$EBS_AUTOSCALE" != "1" ]; then
 152   # Set up the cloud-init script that will ensure encrypted disks
 153   $SUDO mv /tmp/usr-local-bin-ensure-encrypted-partitions.sh /usr/local/bin/ensure-encrypted-partitions.sh
 154 else
 155   wait_for_apt_locks && $SUDO DEBIAN_FRONTEND=noninteractive apt-get -qq --yes install jq unzip
 156
 157   curl -s "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "/tmp/awscliv2.zip"
 158   unzip -q /tmp/awscliv2.zip -d /tmp && $SUDO /tmp/aws/install
 159   # Pinned to v2.4.5 because we apply a patch below
 160   #export EBS_AUTOSCALE_VERSION=$(curl --silent "https://api.github.com/repos/awslabs/amazon-ebs-autoscale/releases/latest" | jq -r .tag_name)
 161   export EBS_AUTOSCALE_VERSION="v2.4.5"
 162   cd /opt && $SUDO git clone https://github.com/awslabs/amazon-ebs-autoscale.git
 163   cd /opt/amazon-ebs-autoscale && $SUDO git checkout $EBS_AUTOSCALE_VERSION
 164   $SUDO patch -p1 < /tmp/create-ebs-volume-nvme.patch
 165
 166   # This script really requires bash and the shebang line is wrong
 167   $SUDO sed -i 's|^#!/bin/sh|#!/bin/bash|' /opt/amazon-ebs-autoscale/bin/ebs-autoscale
 168
 169   # Set up the cloud-init script that makes use of the AWS EBS autoscaler
 170   $SUDO mv /tmp/usr-local-bin-ensure-encrypted-partitions-aws-ebs-autoscale.sh /usr/local/bin/ensure-encrypted-partitions.sh
 171 fi
 172
 173 $SUDO chmod 755 /usr/local/bin/ensure-encrypted-partitions.sh
 174 $SUDO chown root:root /usr/local/bin/ensure-encrypted-partitions.sh
 175 $SUDO mv /tmp/etc-cloud-cloud.cfg.d-07_compute_arvados_dispatch_cloud.cfg /etc/cloud/cloud.cfg.d/07_compute_arvados_dispatch_cloud.cfg
 176 $SUDO chown root:root /etc/cloud/cloud.cfg.d/07_compute_arvados_dispatch_cloud.cfg
 177
 178 if [ "$NVIDIA_GPU_SUPPORT" == "1" ]; then
 179   # $DIST should not have a dot if there is one in /etc/os-release (e.g. 18.04)
 180   DIST=$(. /etc/os-release; echo $ID$VERSION_ID | tr -d '.')
 181   # We need a kernel and matching headers
 182   if [[ "$DIST" =~ ^debian ]]; then
 183     $SUDO apt-get -y install linux-image-cloud-amd64 linux-headers-cloud-amd64
 184   elif [ "$CLOUD" == "azure" ]; then
 185     $SUDO apt-get -y install linux-image-azure linux-headers-azure
 186   elif [ "$CLOUD" == "aws" ]; then
 187     $SUDO apt-get -y install linux-image-aws linux-headers-aws
 188   fi
 189
 190   # Install CUDA
 191   $SUDO apt-key adv --fetch-keys https://developer.download.nvidia.com/compute/cuda/repos/$DIST/x86_64/7fa2af80.pub
 192   $SUDO apt-get -y install software-properties-common
 193   $SUDO add-apt-repository "deb https://developer.download.nvidia.com/compute/cuda/repos/$DIST/x86_64/ /"
 194   # Ubuntu 18.04's add-apt-repository does not understand 'contrib'
 195   $SUDO add-apt-repository contrib || true
 196   $SUDO apt-get update
 197   $SUDO apt-get -y install cuda
 198
 199   # Install libnvidia-container, the tooling for Docker/Singularity
 200   curl -s -L https://nvidia.github.io/libnvidia-container/gpgkey | \
 201     $SUDO apt-key add -
 202   if [ "$DIST" == "debian11" ]; then
 203     # As of 2021-12-16 libnvidia-container and friends are only available for
 204     # Debian 10, not yet Debian 11. Install experimental rc1 package as per this
 205     # workaround:
 206     # https://github.com/NVIDIA/nvidia-docker/issues/1549#issuecomment-989670662
 207     curl -s -L https://nvidia.github.io/libnvidia-container/debian10/libnvidia-container.list | \
 208       $SUDO tee /etc/apt/sources.list.d/libnvidia-container.list
 209     $SUDO sed -i -e '/experimental/ s/^#//g' /etc/apt/sources.list.d/libnvidia-container.list
 210   else
 211     # here, $DIST should have a dot if there is one in /etc/os-release (e.g. 18.04)...
 212     DIST=$(. /etc/os-release; echo $ID$VERSION_ID)
 213     curl -s -L https://nvidia.github.io/libnvidia-container/$DIST/libnvidia-container.list | \
 214       $SUDO tee /etc/apt/sources.list.d/libnvidia-container.list
 215   fi
 216
 217   if [ "$DIST" == "debian10" ]; then
 218     # Debian 10 comes with Docker 18.xx, we need 19.03 or later
 219     curl -fsSL https://download.docker.com/linux/debian/gpg | $SUDO gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
 220     echo deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian/ buster stable | \
 221       $SUDO tee /etc/apt/sources.list.d/docker.list
 222     $SUDO apt-get update
 223     $SUDO apt-get -yq --no-install-recommends install docker-ce=5:19.03.15~3-0~debian-buster
 224
 225     $SUDO sed "s/ExecStart=\(.*\)/ExecStart=\1 --default-ulimit nofile=10000:10000 ${SET_RESOLVER}/g" \
 226       /lib/systemd/system/docker.service \
 227       > /etc/systemd/system/docker.service
 228
 229     $SUDO systemctl daemon-reload
 230
 231     # docker should not start on boot: we restart it inside /usr/local/bin/ensure-encrypted-partitions.sh,
 232     # and the BootProbeCommand might be "docker ps -q"
 233     $SUDO systemctl disable docker
 234   fi
 235   $SUDO apt-get update
 236   $SUDO apt-get -y install libnvidia-container1 libnvidia-container-tools nvidia-container-toolkit
 237   # This service fails to start when the image is booted without Nvidia GPUs present, which makes
 238   # `systemctl is-system-running` respond with "degraded" and since that command is our default
 239   # BootProbeCommand, compute nodes never finish booting from Arvados' perspective.
 240   # Disable the service to avoid this. This should be fine because crunch-run does its own basic
 241   # CUDA initialization.
 242   $SUDO systemctl disable nvidia-persistenced.service
 243 fi
 244
 245 $SUDO apt-get clean