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