install_compatibility_layer.sh

#!/bin/bash
#
# Launch the compatibility layer installation using Ansible inside an Apptainer container.
# This can be run on any machine which has Apptainer installed, no special privileges are required.
#

ARCH=
CONTAINER=docker://ghcr.io/eessi/bootstrap-prefix:debian11
REPOSITORY="software.eessi.io"
RESUME=
RETAIN_TMP=0
STORAGE=
VERSION=2023.06
VERBOSE=

display_help() {
  echo "usage: $0 [OPTIONS]"
  echo "OPTIONS:"
  echo "    -a | --arch ARCHITECTURE"
  echo "        architecture to build a compatibility layer for"
  echo "        [default/required: current host's architecture]"
  echo ""
  echo "    -c | --container IMAGE"
  echo "        image file or URL defining the container to use"
  echo "        [default: ${CONTAINER}]"
  echo ""
  echo "    -g | --storage DIRECTORY"
  echo "        directory space on host machine (used for"
  echo "        temporary data) [default: 1. TMPDIR, 2. /tmp]"
  echo ""
  echo "    -k | --retain-tmp"
  echo "        retain tmp storage (as tarball) for future"
  echo "        inspection [default: not set]"
  echo ""
  echo "    -h | --help"
  echo "        display this usage information"
  echo ""
  echo "    -r | --repository REPO"
  echo "        CVMFS repository name [default: ${REPOSITORY}]"
  echo ""
  echo "    -t | --resume TMPDIR"
  echo "        tmp directory to resume from [default: None]"
  echo ""
  echo "    -v | --version VERSION"
  echo "        override the EESSI stack version set in Ansible's"
  echo "        defaults/main.yml file [default: None]"
  echo ""
  echo "    --verbose"
  echo "        increase verbosity of output [default: not set]"
  echo
}

POSITIONAL_ARGS=()

while [[ $# -gt 0 ]]; do
  case $1 in
    -a|--arch)
      ARCH="$2"
      shift 2
      ;;
    -c|--container)
      CONTAINER="$2"
      shift 2
      ;;
    -g|--storage)
      STORAGE="$2"
      shift 2
      ;;
    -k|--retain-tmp)
      RETAIN_TMP=1
      shift 1
      ;;
    -h|--help)
      display_help
      exit 0
      ;;
    -r|--repository)
      REPOSITORY="$2"
      shift 2
      ;;
    -t|--resume)
      RESUME="$2"
      shift 2
      ;;
    -v|--version)
      VERSION="$2"
      shift 2
      ;;
    --verbose)
      VERBOSE="-vvv"
      shift 1
      ;;
    -*|--*)
      fatal_error "Unknown option: $1" "${CMDLINE_ARG_UNKNOWN_EXITCODE}"
      ;;
    *)  # No more options
      POSITIONAL_ARGS+=("$1") # save positional arg
      shift
      ;;
  esac
done

set -- "${POSITIONAL_ARGS[@]}"

# We assume that this script is located in a directory containing a full checkout of the git repo,
# we verify this by checking for the existance oif the Ansible playbook.
SCRIPT_DIR=$(dirname $(realpath $0))
if [ ! -f "${SCRIPT_DIR}/ansible/playbooks/install.yml" ]; then
    echo "Ansible playbook install.yml cannot be found!"
    echo "Make sure to run this script from a directory containing a the compatibility-layer git repository."
    exit 1
fi

# source utils.sh (for get_container_runtime and check_exit_code)
source ${SCRIPT_DIR}/scripts/utils.sh

# Check if the target architecture is set to the architecture of the current host,
# as that's the only thing that's currently supported by this script
HOST_ARCH=$(uname -m)
if [[ ! -z ${ARCH} ]] && [[ "${ARCH}" != "${HOST_ARCH}" ]]; then
  echo "ERROR: this build host has architecture ${HOST_ARCH}, while a build for ${ARCH} was requested!"
  exit 1
fi
if [[ -z ${ARCH} ]]; then
  ARCH=${HOST_ARCH}
fi
echo "A compatibility layer for architecture ${ARCH} will be built."

# Make a temporary directory on the host for storing the installation and some temporary files
if [[ ! -z ${RESUME} ]] && [[ -d ${RESUME} ]]; then
    EESSI_TMPDIR=${RESUME}
    echo "using previous temporary storage at ${RESUME} to resume work"
else
    TMPDIR=${STORAGE:-${TMPDIR:-/tmp}}
    mkdir -p ${TMPDIR}
    EESSI_TMPDIR=$(mktemp -d --tmpdir=${TMPDIR} eessi.XXXXXXXXXX)
    echo "created new temporary storage at ${EESSI_TMPDIR}"
fi
echo "Using $EESSI_TMPDIR as temporary storage..."

# Create temporary directories
mkdir -p ${EESSI_TMPDIR}/cvmfs
mkdir -p ${EESSI_TMPDIR}/home
mkdir -p ${EESSI_TMPDIR}/tmp

RUNTIME=$(get_container_runtime)
exit_code=$?
[[ ${VERBOSE} == '-vvv' ]] && echo "RUNTIME='${RUNTIME}'"
check_exit_code ${exit_code} "using runtime ${RUNTIME}" "oh no, neither apptainer nor singularity available"

# Set up paths and mount points for Apptainer
if [[ -z ${APPTAINER_CACHEDIR} ]]; then
  export APPTAINER_CACHEDIR=${EESSI_TMPDIR}/apptainer_cache
  [[ ${VERBOSE} == '-vvv' ]] && echo "APPTAINER_CACHEDIR='${APPTAINER_CACHEDIR}'"
fi
export APPTAINER_BIND="${EESSI_TMPDIR}/cvmfs:/cvmfs,${SCRIPT_DIR}:/compatibility-layer"
export APPTAINER_BIND="${APPTAINER_BIND},${EESSI_TMPDIR}/tmp:/tmp"
[[ ${VERBOSE} == '-vvv' ]] && echo "APPTAINER_BIND='${APPTAINER_BIND}'"
export APPTAINER_HOME="${EESSI_TMPDIR}/home:/home/${USER}"
[[ ${VERBOSE} == '-vvv' ]] && echo "APPTAINER_HOME='${APPTAINER_HOME}'"

# also define SINGULARITY_* env vars
if [[ -z ${SINGULARITY_CACHEDIR} ]]; then
  export SINGULARITY_CACHEDIR=${EESSI_TMPDIR}/apptainer_cache
  [[ ${VERBOSE} == '-vvv' ]] && echo "SINGULARITY_CACHEDIR='${SINGULARITY_CACHEDIR}'"
fi
export SINGULARITY_BIND="${EESSI_TMPDIR}/cvmfs:/cvmfs,${SCRIPT_DIR}:/compatibility-layer"
export SINGULARITY_BIND="${SINGULARITY_BIND},${EESSI_TMPDIR}/tmp:/tmp"
[[ ${VERBOSE} == '-vvv' ]] && echo "SINGULARITY_BIND='${SINGULARITY_BIND}'"
export SINGULARITY_HOME="${EESSI_TMPDIR}/home:/home/${USER}"
[[ ${VERBOSE} == '-vvv' ]] && echo "SINGULARITY_HOME='${SINGULARITY_HOME}'"

# Construct the Ansible playbook command
ANSIBLE_OPTIONS="-e eessi_host_os=linux -e eessi_host_arch=$(uname -m)"
if [[ ! -z ${VERSION} ]]; then
    ANSIBLE_OPTIONS="${ANSIBLE_OPTIONS} -e eessi_version=${VERSION}"
fi
if [[ ! -z ${REPOSITORY} ]]; then
    ANSIBLE_OPTIONS="${ANSIBLE_OPTIONS} -e cvmfs_repository=${REPOSITORY}"
fi
if [[ ! -z ${VERBOSE} ]]; then
    ANSIBLE_OPTIONS="${ANSIBLE_OPTIONS} ${VERBOSE}"
fi
ANSIBLE_COMMAND="ansible-playbook ${ANSIBLE_OPTIONS} /compatibility-layer/ansible/playbooks/install.yml"
# Finally, run Ansible inside the container to do the actual installation
echo "Executing ${ANSIBLE_COMMAND} in ${CONTAINER}, this will take a while..."
${RUNTIME} shell ${CONTAINER} <<EOF
# The Gentoo Prefix bootstrap script will complain if $LD_LIBRARY_PATH is set
unset LD_LIBRARY_PATH
unset PKG_CONFIG_PATH
${ANSIBLE_COMMAND}
EOF

if [[ ${RETAIN_TMP} -eq 1 ]]; then
  echo "Left container; tar'ing up ${EESSI_TMPDIR} for future inspection"
  ID=${SLURM_JOB_ID:-$$}
  TIMESTAMP=$(date +%s)
  TGZ=${SCRIPT_DIR}/job_${ID}_${TIMESTAMP}.tgz
  tar cvzf ${TGZ} -C ${EESSI_TMPDIR} .
  echo "created tarball '${TGZ}'"
fi

echo "To resume work add '--resume ${EESSI_TMPDIR}'"