functions.sh

   1 #!/bin/bash
   2
   3 # SPDX-FileCopyrightText: 2021 Ericsson AB and others
   4 #
   5 # SPDX-License-Identifier: Apache-2.0
   6
   7 info() {
   8     _print_msg "INFO" "$1"
   9 }
  10
  11 error() {
  12     _print_msg "ERROR" "$1"
  13     exit 1
  14 }
  15
  16 _print_msg() {
  17     echo "$(date +%H:%M:%S) - $1: $2"
  18 }
  19
  20 assert_non_empty() {
  21     if [ -z "$1" ]; then
  22         error "$2"
  23     fi
  24 }
  25 if [ "${DEBUG:-false}" == "true" ]; then
  26     set -o xtrace
  27 fi
  28
  29 check_prerequisites() {
  30     info "Check prerequisites"
  31
  32     #-------------------------------------------------------------------------------
  33     # Check for DEPLOYMENT type
  34     #-------------------------------------------------------------------------------
  35     if ! [[ "$DEPLOYMENT" =~ ^(full|k8s)$ ]]; then
  36         error "Unsupported value for DEPLOYMENT ($DEPLOYMENT)"
  37     fi
  38
  39     #-------------------------------------------------------------------------------
  40     # We shouldn't be running as root
  41     #-------------------------------------------------------------------------------
  42     if [[ "$(whoami)" == "root" ]] && [[ "$DEPLOYMENT" != "k8s" ]]; then
  43         error "This script must not be run as root! Please switch to a regular user before running the script."
  44     fi
  45
  46     #-------------------------------------------------------------------------------
  47     # Check for passwordless sudo
  48     #-------------------------------------------------------------------------------
  49     if ! sudo -n "true"; then
  50         error "passwordless sudo is needed for '$(id -nu)' user."
  51     fi
  52
  53     #-------------------------------------------------------------------------------
  54     # Check if SSH key exists
  55     #-------------------------------------------------------------------------------
  56     if [[ ! -f "$HOME/.ssh/id_rsa" ]]; then
  57         error "You must have SSH keypair in order to run this script!"
  58     fi
  59
  60     #-------------------------------------------------------------------------------
  61     # We are using sudo so we need to make sure that env_reset is not present
  62     #-------------------------------------------------------------------------------
  63     sudo sed -i "s/^Defaults.*env_reset/#&/" /etc/sudoers
  64
  65     #-------------------------------------------------------------------------------
  66     # Check if necessary tools are installed
  67     #-------------------------------------------------------------------------------
  68     for tool in ansible yq virsh jq docker virtualenv pip; do
  69         if ! command -v "$tool" &> /dev/null; then
  70             error "$tool not found. Please install."
  71         fi
  72     done
  73
  74     #-------------------------------------------------------------------------------
  75     # Check if user belongs to libvirt's group
  76     #-------------------------------------------------------------------------------
  77     libvirt_group="libvirt"
  78     # shellcheck disable=SC1091
  79     source /etc/os-release || source /usr/lib/os-release
  80     if [ "${ID,,}" == "ubuntu" ] && [ "$VERSION_ID" == "16.04" ]; then
  81         libvirt_group+="d"
  82     fi
  83     if ! groups | grep "$libvirt_group"; then
  84         error "$(id -nu) user doesn't belong to $libvirt_group group."
  85     fi
  86 }
  87
  88 # Get jumphost VM PXE IP
  89 get_host_pxe_ip() {
  90     local PXE_NETWORK
  91     local PXE_IF_INDEX
  92     local PXE_IF_IP
  93
  94     host=$1
  95     assert_non_empty "$host" "get_ip - host parameter not provided"
  96
  97     PXE_NETWORK=$(yq r "$CURRENTPATH"/hw_config/"$VENDOR"/idf.yaml engine.pxe_network)
  98     assert_non_empty "$PXE_NETWORK" "PXE network for jump VM not defined in IDF."
  99
 100     PXE_IF_INDEX=$(yq r "$CURRENTPATH"/hw_config/"${VENDOR}"/idf.yaml idf.net_config."$PXE_NETWORK".interface)
 101     assert_non_empty "$PXE_IF_INDEX" "Index of PXE interface not found in IDF."
 102
 103     PXE_IF_IP=$(yq r "$CURRENTPATH"/hw_config/"${VENDOR}"/pdf.yaml "$host".interfaces["$PXE_IF_INDEX"].address)
 104     assert_non_empty "$PXE_IF_IP" "IP of PXE interface not found in PDF."
 105
 106     echo "$PXE_IF_IP"
 107 }
 108
 109 # Get public MAC for VM
 110 get_host_pub_mac() {
 111     local PUB_NETWORK
 112     local PUB_IF_INDEX
 113     local PUB_IF_MAC
 114
 115     host=$1
 116     assert_non_empty "$host" "get_mac - host parameter not provided"
 117
 118     PUB_NETWORK=$(yq r "$CURRENTPATH"/hw_config/"$VENDOR"/idf.yaml  engine.public_network)
 119     assert_non_empty "$PUB_NETWORK" "Public network for jump VM not defined in IDF."
 120
 121     PUB_IF_INDEX=$(yq r "$CURRENTPATH"/hw_config/"${VENDOR}"/idf.yaml idf.net_config."$PUB_NETWORK".interface)
 122     assert_non_empty "$PUB_IF_INDEX" "Index of public interface not found in IDF."
 123
 124     PUB_IF_MAC=$(yq r "$CURRENTPATH"/hw_config/"${VENDOR}"/pdf.yaml "$host".interfaces["$PUB_IF_INDEX"].mac_address)
 125     assert_non_empty "$PUB_IF_MAC" "MAC of public interface not found in PDF."
 126     echo "$PUB_IF_MAC"
 127 }
 128
 129 # Get jumphost VM IP
 130 get_vm_ip() {
 131     if [[ "$DEPLOYMENT" == "full" ]]; then
 132         ip=$(get_host_pxe_ip "jumphost")
 133     else
 134         mac=$(get_host_pub_mac "jumphost")
 135         JUMPHOST_NAME=$(yq r "$CURRENTPATH"/hw_config/"$VENDOR"/pdf.yaml jumphost.name)
 136         ipblock=$(virsh domifaddr "$JUMPHOST_NAME" --full | grep "$mac" | awk '{print $4}' | tail -n 1)
 137         assert_non_empty "$ipblock" "IP subnet for VM not available."
 138         ip="${ipblock%/*}"
 139     fi
 140     echo "$ip"
 141 }
 142
 143 # Copy files needed by Infra engine & BMRA in the jumphost VM
 144 copy_files_jump() {
 145     vm_ip="$(get_vm_ip)"
 146     docker_config="/opt/kuberef/docker_config"
 147     scp -r -o StrictHostKeyChecking=no \
 148     "$CURRENTPATH"/{hw_config/"$VENDOR"/,sw_config/"$INSTALLER"/} \
 149     "$USERNAME@${vm_ip}:$PROJECT_ROOT"
 150     if [[ "$DEPLOYMENT" != "full" ]]; then
 151         scp -r -o StrictHostKeyChecking=no \
 152         ~/.ssh/id_rsa \
 153         "$USERNAME@${vm_ip}:.ssh/id_rsa"
 154     fi
 155     if [ -f "$docker_config" ]; then
 156         scp -r -o StrictHostKeyChecking=no \
 157         "$docker_config" "$USERNAME@${vm_ip}:$PROJECT_ROOT"
 158     fi
 159 }
 160
 161 # Host Provisioning
 162 provision_hosts_baremetal() {
 163     # shellcheck disable=SC2087
 164     ssh -o StrictHostKeyChecking=no -tT "$USERNAME"@"$(get_vm_ip)" << EOF
 165 # Install and run cloud-infra
 166 if [ ! -d "${PROJECT_ROOT}/engine" ]; then
 167     ssh-keygen -t rsa -N "" -f "${PROJECT_ROOT}"/.ssh/id_rsa
 168     git clone https://gerrit.nordix.org/infra/engine.git
 169 fi
 170 cp "${PROJECT_ROOT}"/"${VENDOR}"/{pdf.yaml,idf.yaml} \
 171 "${PROJECT_ROOT}"/engine/engine
 172 cd "${PROJECT_ROOT}"/engine/engine || return
 173 ./deploy.sh -s ironic -d "${DISTRO}" \
 174 -p file:///"${PROJECT_ROOT}"/engine/engine/pdf.yaml \
 175 -i file:///"${PROJECT_ROOT}"/engine/engine/idf.yaml
 176 EOF
 177 }
 178
 179 provision_hosts_vms() {
 180     # shellcheck disable=SC2087
 181 # Install and run cloud-infra
 182 if [ ! -d "$CURRENTPATH/engine" ]; then
 183     git clone https://gerrit.nordix.org/infra/engine.git "${CURRENTPATH}"/engine
 184 fi
 185 cp "$CURRENTPATH"/hw_config/"$VENDOR"/{pdf.yaml,idf.yaml} \
 186 "${CURRENTPATH}"/engine/engine
 187 cd "$CURRENTPATH"/engine/engine || return
 188 ./deploy.sh -s ironic \
 189 -p file:///"${CURRENTPATH}"/engine/engine/pdf.yaml \
 190 -i file:///"${CURRENTPATH}"/engine/engine/idf.yaml
 191 }
 192
 193 # Setup networking on provisioned hosts (Adapt setup_network.sh according to your network setup)
 194 setup_network() {
 195     # Set Upper limit of number nodes in RI2 cluster (starting from 0)
 196     NODE_MAX_ID=$(($(yq r "$CURRENTPATH"/hw_config/"$VENDOR"/idf.yaml --length idf.kubespray.hostnames)-1))
 197
 198     for idx in $(seq 0 "$NODE_MAX_ID"); do
 199         NODE_IP=$(get_host_pxe_ip "nodes[${idx}]")
 200         # SSH to jumphost
 201         # shellcheck disable=SC2087
 202         ssh -o StrictHostKeyChecking=no -tT "$USERNAME"@"$(get_vm_ip)" << EOF
 203 ssh -o StrictHostKeyChecking=no root@"${NODE_IP}" \
 204     'bash -s' <  "${PROJECT_ROOT}"/"${VENDOR}"/setup_network.sh
 205 EOF
 206     done
 207 }
 208
 209 # k8s Provisioning (currently BMRA)
 210 provision_k8s_baremetal() {
 211     ansible_cmd="/bin/bash -c '"
 212     if [[ "$DEPLOYMENT" == "k8s" ]]; then
 213         ansible-playbook -i "$CURRENTPATH"/sw_config/bmra/inventory.ini "$CURRENTPATH"/playbooks/pre-install.yaml
 214         ansible_cmd+="yum -y remove python-netaddr; ansible-playbook -i /bmra/inventory.ini /bmra/playbooks/k8s/patch_kubespray.yml;"
 215     fi
 216     ansible_cmd+="ansible-playbook -i /bmra/inventory.ini /bmra/playbooks/${BMRA_PROFILE}.yml'"
 217
 218     # shellcheck disable=SC2087
 219     ssh -o StrictHostKeyChecking=no -tT "$USERNAME"@"$(get_vm_ip)" << EOF
 220 # Install BMRA
 221 if ! command -v docker; then
 222     curl -fsSL https://get.docker.com/ | sh
 223     printf "Waiting for docker service..."
 224     until sudo docker info; do
 225         printf "."
 226         sleep 2
 227     done
 228 fi
 229 if [ ! -d "${PROJECT_ROOT}/container-experience-kits" ]; then
 230     git clone --recurse-submodules --depth 1 https://github.com/intel/container-experience-kits.git -b v21.08 "${PROJECT_ROOT}"/container-experience-kits/
 231     cp -r "${PROJECT_ROOT}"/container-experience-kits/examples/"${BMRA_PROFILE}"/group_vars "${PROJECT_ROOT}"/container-experience-kits/
 232 fi
 233 if [ -f "${PROJECT_ROOT}/docker_config" ]; then
 234     cp "${PROJECT_ROOT}"/docker_config \
 235         "${PROJECT_ROOT}"/"${INSTALLER}"/dockerhub_credentials/vars/main.yml
 236     cp -r "${PROJECT_ROOT}"/"${INSTALLER}"/dockerhub_credentials \
 237         "${PROJECT_ROOT}"/container-experience-kits/roles/
 238     cp "${PROJECT_ROOT}"/"${INSTALLER}"/patched_k8s.yml \
 239         "${PROJECT_ROOT}"/container-experience-kits/playbooks/k8s/k8s.yml
 240 fi
 241 cp "${PROJECT_ROOT}"/"${INSTALLER}"/{inventory.ini,ansible.cfg} \
 242     "${PROJECT_ROOT}"/container-experience-kits/
 243 cp "${PROJECT_ROOT}"/"${INSTALLER}"/{all.yml,kube-node.yml} \
 244     "${PROJECT_ROOT}"/container-experience-kits/group_vars/
 245 cp "${PROJECT_ROOT}"/"${INSTALLER}"/patched_cmk_build.yml \
 246     "${PROJECT_ROOT}"/container-experience-kits/roles/cmk_install/tasks/main.yml
 247 cp "${PROJECT_ROOT}"/"${INSTALLER}"/patched_vfio.yml \
 248     "${PROJECT_ROOT}"/container-experience-kits/roles/sriov_nic_init/tasks/bind_vf_driver.yml
 249 cp "${PROJECT_ROOT}"/"${INSTALLER}"/patched_rhel_packages.yml \
 250     "${PROJECT_ROOT}"/container-experience-kits/roles/bootstrap/install_packages/tasks/rhel.yml
 251 cp "${PROJECT_ROOT}"/"${INSTALLER}"/patched_packages.yml \
 252     "${PROJECT_ROOT}"/container-experience-kits/roles/bootstrap/install_packages/tasks/main.yml
 253 cp "${PROJECT_ROOT}"/"${INSTALLER}"/patched_kubespray_requirements.txt \
 254     "${PROJECT_ROOT}"/container-experience-kits/playbooks/k8s/kubespray/requirements.txt
 255 cp "${PROJECT_ROOT}"/"${INSTALLER}"/patched_preflight.yml \
 256     "${PROJECT_ROOT}"/container-experience-kits/playbooks/preflight.yml
 257 cp "${PROJECT_ROOT}"/"${INSTALLER}"/patched_sriov_cni_install.yml \
 258     "${PROJECT_ROOT}"/container-experience-kits/roles/sriov_cni_install/tasks/main.yml
 259
 260 sudo docker run --rm \
 261 -e ANSIBLE_CONFIG=/bmra/ansible.cfg \
 262 -e PROFILE="${BMRA_PROFILE}" \
 263 -v "${PROJECT_ROOT}"/container-experience-kits:/bmra \
 264 -v ~/.ssh/:/root/.ssh/ rihabbanday/bmra21.08-install:centos \
 265 ${ansible_cmd}
 266 EOF
 267 }
 268
 269 provision_k8s_vms() {
 270     # shellcheck disable=SC2087
 271 # Install BMRA
 272 if [ ! -d "${CURRENTPATH}/container-experience-kits" ]; then
 273     git clone --recurse-submodules --depth 1 https://github.com/intel/container-experience-kits.git -b v21.08 "${CURRENTPATH}"/container-experience-kits/
 274     cp -r "${CURRENTPATH}"/container-experience-kits/examples/"${BMRA_PROFILE}"/group_vars "${CURRENTPATH}"/container-experience-kits/
 275 fi
 276 cp "${CURRENTPATH}"/sw_config/bmra/{inventory.ini,ansible.cfg} \
 277     "${CURRENTPATH}"/container-experience-kits/
 278 cp "${CURRENTPATH}"/sw_config/bmra/{all.yml,kube-node.yml} \
 279     "${CURRENTPATH}"/container-experience-kits/group_vars/
 280 cp "${CURRENTPATH}"/sw_config/bmra/patched_cmk_build.yml \
 281     "${CURRENTPATH}"/container-experience-kits/roles/cmk_install/tasks/main.yml
 282 cp "${CURRENTPATH}"/sw_config/bmra/patched_vfio.yml \
 283    "${CURRENTPATH}"/container-experience-kits/roles/sriov_nic_init/tasks/bind_vf_driver.yml
 284 cp "${CURRENTPATH}"/sw_config/bmra/patched_rhel_packages.yml \
 285     "${CURRENTPATH}"/container-experience-kits/roles/bootstrap/install_packages/tasks/rhel.yml
 286 cp "${CURRENTPATH}"/sw_config/bmra/patched_packages.yml \
 287     "${CURRENTPATH}"/container-experience-kits/roles/bootstrap/install_packages/tasks/main.yml
 288 cp "${CURRENTPATH}"/sw_config/"${INSTALLER}"/patched_kubespray_requirements.txt \
 289     "${CURRENTPATH}"/container-experience-kits/playbooks/k8s/kubespray/requirements.txt
 290 cp "${CURRENTPATH}"/sw_config/"${INSTALLER}"/patched_preflight.yml \
 291     "${CURRENTPATH}"/container-experience-kits/playbooks/preflight.yml
 292 cp "${CURRENTPATH}"/sw_config/"${INSTALLER}"/patched_sriov_cni_install.yml \
 293     "${CURRENTPATH}"/container-experience-kits/roles/sriov_cni_install/tasks/main.yml
 294
 295 ansible-playbook -i "$CURRENTPATH"/sw_config/bmra/inventory.ini "$CURRENTPATH"/playbooks/pre-install.yaml
 296
 297 # Ansible upgrade below can be removed once image is updated
 298 sudo docker run --rm \
 299 -e ANSIBLE_CONFIG=/bmra/ansible.cfg \
 300 -e PROFILE="${BMRA_PROFILE}" \
 301 -v "${CURRENTPATH}"/container-experience-kits:/bmra \
 302 -v ~/.ssh/:/root/.ssh/ rihabbanday/bmra21.08-install:centos \
 303 ansible-playbook -i /bmra/inventory.ini /bmra/playbooks/"${BMRA_PROFILE}".yml
 304 }
 305
 306 # Copy kubeconfig to the appropriate location needed by functest containers
 307 copy_k8s_config() {
 308 # TODO Use Kubespray variables in BMRA to simplify this
 309     MASTER_IP=$(get_host_pxe_ip "nodes[0]")
 310     # shellcheck disable=SC2087
 311     ssh -o StrictHostKeyChecking=no -tT "$USERNAME"@"$(get_vm_ip)" << EOF
 312 scp -o StrictHostKeyChecking=no -q root@"$MASTER_IP":/root/.kube/config "${PROJECT_ROOT}"/kubeconfig
 313 EOF
 314
 315 # Copy kubeconfig from Jump VM to appropriate location in Jump Host
 316 # Direct scp to the specified location doesn't work due to permission/ssh-keys
 317     scp  -o StrictHostKeyChecking=no "$USERNAME"@"$(get_vm_ip)":"${PROJECT_ROOT}"/kubeconfig kubeconfig
 318     if [ -d "/home/opnfv/functest-kubernetes" ]; then
 319         sudo cp kubeconfig /home/opnfv/functest-kubernetes/config
 320     fi
 321 }
 322
 323 # Creates a python virtual environment
 324 creates_virtualenv() {
 325     if [  ! -d "$CURRENTPATH/.venv" ]; then
 326         virtualenv .venv
 327     fi
 328     # shellcheck disable=SC1090
 329     source "$CURRENTPATH/.venv/bin/activate"
 330     pip install -r "$CURRENTPATH/requirements.txt"
 331 }
 332
 333 # Executes a specific Ansible playbook
 334 run_playbook() {
 335     ansible_cmd="$(command -v ansible-playbook) -i $CURRENTPATH/inventory/localhost.ini -e ansible_python_interpreter=$(command -v python)"
 336     if [ "${DEBUG:-false}" == "true" ]; then
 337         ansible_cmd+=" -vvv"
 338     fi
 339     eval "$ansible_cmd $CURRENTPATH/playbooks/${1}.yaml"
 340 }