Skip to content

Commit

Permalink
PTFE-1418 | PTFE-1320 start sanity check before job execution (#534)
Browse files Browse the repository at this point in the history 
Make use of hooks to be executed on the runner before and after a job
starts.

An extra step will appear in the job logs, displaying the logs of the
hook while being executed.
<img width="1848" alt="Screenshot 2024-02-09 at 4 08 21 PM"
src="https://github.com/scality/runner-manager/assets/8408330/69d1b5e3-1e49-402f-9526-8a351f1467b6">
  • Loading branch information
@tcarmet
tcarmet authored Feb 13, 2024
1 parent d12cfe1 commit 2c7c1c3
Showing 1 changed file with 165 additions and 85 deletions.
250 changes: 165 additions & 85 deletions runner_manager/bin/startup.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,54 @@ DOCKER_SERVICE_START="yes"

SSH_KEYS=${SSH_KEYS:-""}

SCRIPT_FILE=$(readlink -f "$0")

function setup_runner_hook {
mkdir -p /opt/runner
# Ensure this script exists even after cloud-init
cp "${SCRIPT_FILE}" /opt/runner/startup.sh
# setup the content of the function job_started in the file /opt/runner/started.sh
echo "#!/usr/bin/env bash
/opt/runner/startup.sh --job-started" | sudo tee /opt/runner/started.sh
chmod +x /opt/runner/started.sh
# same for job_completed
echo "#!/usr/bin/env bash
/opt/runner/startup.sh --job-completed" | sudo tee /opt/runner/completed.sh
chmod +x /opt/runner/completed.sh
# Ensure the user actions can execute the hooks
sudo chown -R actions:actions /opt/runner
touch /home/actions/actions-runner/.env
echo "ACTIONS_RUNNER_HOOK_JOB_STARTED=/opt/runner/started.sh" >>/home/actions/actions-runner/.env
echo "ACTIONS_RUNNER_HOOK_JOB_COMPLETED=/opt/runner/completed.sh" >>/home/actions/actions-runner/.env
chown actions:actions /home/actions/actions-runner/.env

}

function job_started {
# This function is called before the job starts
echo "Running preliminary checks..."
# Check if apt, dnf, or yum is running
echo "Ensure no package manager is running"
while pgrep -x "apt" >/dev/null || pgrep -x "dnf" >/dev/null || pgrep -x "yum" >/dev/null; do
echo "Waiting for package manager to finish"
sleep 5
done
if [[ ! ${LABELS} =~ "no-docker" ]]; then
echo "Ensure docker is running"
while ! docker info >/dev/null 2>&1; do
echo "Waiting for docker to start"
sleep 5
done
fi
echo "Done"
}

function job_completed {
# This function is called when the job is completed
echo "Job completed"

}

function setup_service {
# When running the runner as a just-in-time runner, the runsvc.sh script
# is not created. Therefore we are manually creating it here.
Expand All @@ -39,24 +87,93 @@ WantedBy=multi-user.target" | sudo tee /etc/systemd/system/actions.runner.servic

}

sudo groupadd -f docker
sudo useradd -m actions
sudo usermod -aG docker,root actions
sudo bash -c "echo 'actions ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers"
sudo -H -u actions bash -c 'mkdir -p /home/actions/.ssh'
sudo -H -u actions bash -c 'echo "${SSH_KEYS}" >> /home/actions/.ssh/authorized_keys'

if [[ ${LINUX_OS} == "ubuntu" ]] || [[ ${LINUX_OS} == "debian" ]]; then
sudo apt-get -y update
sudo DEBIAN_FRONTEND=noninteractive apt-get -y install apt-transport-https \
ca-certificates \
curl \
gnupg \
lsb-release
elif [[ ${LINUX_OS} == "centos" ]] || [[ ${LINUX_OS} == "rocky" ]] || [[ ${LINUX_OS} == "almalinux" ]]; then
sudo yum install -y bind-utils yum-utils
elif [[ ${LINUX_OS} == "rhel" ]]; then
echo "
function setup_runner {
sudo groupadd -f docker
sudo useradd -m actions
sudo usermod -aG docker,root actions
sudo bash -c "echo 'actions ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers"
sudo -H -u actions bash -c 'mkdir -p /home/actions/.ssh'
sudo -H -u actions bash -c 'echo "${SSH_KEYS}" >> /home/actions/.ssh/authorized_keys'

# Login as actions user so that all the following commands are executed as actions user
mkdir -p /home/actions/actions-runner
cd /home/actions/actions-runner || exit
# Download the runner package
curl -L "${DOWNLOAD_URL}" -o "/tmp/${FILE}"
tar xzf /tmp/"${FILE}"
# install dependencies
sudo ./bin/installdependencies.sh

setup_runner_hook
# check if systemctl is available
if [[ -x "$(command -v systemctl)" ]]; then
setup_service
sudo systemctl enable actions.runner.service
sudo systemctl start actions.runner.service
else
sudo -H -u actions bash -c "nohup /home/actions/actions-runner/run.sh --jitconfig \"${JIT_CONFIG}\" 2>/home/actions/actions-runner/logs &"
fi

}

function install_docker {

if [[ ! ${LABELS} =~ "no-docker" ]]; then

if [[ ${LINUX_OS} == "ubuntu" ]] || [[ ${LINUX_OS} == "debian" ]]; then
sudo install -m 0755 -d /etc/apt/keyrings
sudo apt-get -y update
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
echo \
deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
"$(. /etc/os-release && echo "${VERSION_CODENAME}")" stable |
sudo tee /etc/apt/sources.list.d/docker.list >/dev/null
sudo apt-get update --yes
sudo apt-get install --yes docker-ce docker-ce-cli containerd.io
elif [[ ${LINUX_OS} == "centos" ]] || [[ ${LINUX_OS} == "rocky" ]] || [[ ${LINUX_OS} == "almalinux" ]]; then
sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
sudo yum install -y epel-release docker-ce docker-ce-cli containerd.io
elif [[ ${LINUX_OS} == "rhel" ]]; then
if [[ ${LINUX_OS_VERSION} == "7" ]]; then
# Enable repos to install docker
sudo mkdir /etc/docker/
# TODO: make dns config a setting for the runner
sudo bash -c 'cat > /etc/docker/daemon.json << EOF
{
"dns": ["10.100.1.1", "10.100.1.2", "10.100.1.3"]
}
EOF'

sudo subscription-manager repos --enable=rhel-7-server-extras-rpms --enable=rhel-7-server-optional-rpms
sudo yum install -y docker
elif [[ ${LINUX_OS_VERSION} == "8" || ${LINUX_OS_VERSION} == "9" ]]; then
sudo dnf install -y podman-docker podman
DOCKER_SERVICE_START="no"
else
echo "RHEL version not managed by the runner-manager"
exit 1
fi
fi

if [[ ${DOCKER_SERVICE_START} == "yes" ]]; then
sudo systemctl start docker
fi
fi
}

function init {
if [[ ${LINUX_OS} == "ubuntu" ]] || [[ ${LINUX_OS} == "debian" ]]; then
sudo apt-get -y update
sudo DEBIAN_FRONTEND=noninteractive apt-get -y install apt-transport-https \
ca-certificates \
curl \
gnupg \
lsb-release
elif [[ ${LINUX_OS} == "centos" ]] || [[ ${LINUX_OS} == "rocky" ]] || [[ ${LINUX_OS} == "almalinux" ]]; then
sudo yum install -y bind-utils yum-utils
elif [[ ${LINUX_OS} == "rhel" ]]; then
echo "
[Unit]
Description=Redhat registration
After=network-online.target
Expand All @@ -72,72 +189,35 @@ ExecStop=-/sbin/subscription-manager unregister
[Install]
WantedBy=multi-user.target
" | sudo tee /etc/systemd/system/redhat_registration.service
sudo chmod 600 /etc/systemd/system/redhat_registration.service
sudo systemctl daemon-reload
sudo systemctl enable redhat_registration.service
sudo systemctl start redhat_registration.service
else
echo "OS not managed by the runner-manager"
exit 1
fi

if [[ ! ${LABELS} =~ "no-docker" ]]; then

if [[ ${LINUX_OS} == "ubuntu" ]] || [[ ${LINUX_OS} == "debian" ]]; then
sudo install -m 0755 -d /etc/apt/keyrings
sudo apt-get -y update
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
echo \
deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
"$(. /etc/os-release && echo "${VERSION_CODENAME}")" stable |
sudo tee /etc/apt/sources.list.d/docker.list >/dev/null
sudo apt-get update --yes
sudo apt-get install --yes docker-ce docker-ce-cli containerd.io
elif [[ ${LINUX_OS} == "centos" ]] || [[ ${LINUX_OS} == "rocky" ]] || [[ ${LINUX_OS} == "almalinux" ]]; then
sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
sudo yum install -y epel-release docker-ce docker-ce-cli containerd.io
elif [[ ${LINUX_OS} == "rhel" ]]; then
if [[ ${LINUX_OS_VERSION} == "7" ]]; then
# Enable repos to install docker
sudo mkdir /etc/docker/
# TODO: make dns config a setting for the runner
sudo bash -c 'cat > /etc/docker/daemon.json << EOF
{
"dns": ["10.100.1.1", "10.100.1.2", "10.100.1.3"]
}
EOF'

sudo subscription-manager repos --enable=rhel-7-server-extras-rpms --enable=rhel-7-server-optional-rpms
sudo yum install -y docker
elif [[ ${LINUX_OS_VERSION} == "8" || ${LINUX_OS_VERSION} == "9" ]]; then
sudo dnf install -y podman-docker podman
DOCKER_SERVICE_START="no"
else
echo "RHEL version not managed by the runner-manager"
exit 1
fi
sudo chmod 600 /etc/systemd/system/redhat_registration.service
sudo systemctl daemon-reload
sudo systemctl enable redhat_registration.service
sudo systemctl start redhat_registration.service
else
echo "OS not managed by the runner-manager"
exit 1
fi
}

if [[ ${DOCKER_SERVICE_START} == "yes" ]]; then
sudo systemctl start docker
fi
fi

# Login as actions user so that all the following commands are executed as actions user
mkdir -p /home/actions/actions-runner
cd /home/actions/actions-runner || exit
# Download the runner package
curl -L "${DOWNLOAD_URL}" -o "/tmp/${FILE}"
tar xzf /tmp/"${FILE}"
# install dependencies
sudo ./bin/installdependencies.sh

# check if systemctl is available
if [[ -x "$(command -v systemctl)" ]]; then
setup_service
sudo systemctl enable actions.runner.service
sudo systemctl start actions.runner.service
else
sudo -H -u actions bash -c "nohup /home/actions/actions-runner/run.sh --jitconfig \"${JIT_CONFIG}\" 2>/home/actions/actions-runner/logs &"
fi
# Retrieve the args passed to the script
# If script is triggered by a hook, call the corresponding function
while [[ $# -gt 0 ]]; do
case "$1" in
--job-started)
job_started
exit 0
;;
--job-completed)
job_completed
exit 0
;;
*)
echo "Unknown argument: $1"
exit 1
;;
esac
done

init
install_docker
setup_runner

0 comments on commit 2c7c1c3

Please sign in to comment.