ci/deploy.sh

   1 #!/bin/bash -e
   2 # shellcheck disable=SC2034,SC2154,SC1090,SC1091,SC2155
   3 ##############################################################################
   4 # Copyright (c) 2018 Ericsson AB, Mirantis Inc., Enea AB and others.
   5 # jonas.bjurel@ericsson.com
   6 # All rights reserved. This program and the accompanying materials
   7 # are made available under the terms of the Apache License, Version 2.0
   8 # which accompanies this distribution, and is available at
   9 # http://www.apache.org/licenses/LICENSE-2.0
  10 ##############################################################################
  11
  12 ##############################################################################
  13 # BEGIN of Exit handlers
  14 #
  15 do_exit () {
  16     local RC=$?
  17     cleanup_mounts > /dev/null 2>&1
  18     if [ ${RC} -eq 0 ]; then
  19         notify_n "[OK] MCP: Openstack installation finished succesfully!" 2
  20     else
  21         notify_n "[ERROR] MCP: Openstack installation threw a fatal error!"
  22     fi
  23 }
  24 #
  25 # End of Exit handlers
  26 ##############################################################################
  27
  28 ##############################################################################
  29 # BEGIN of usage description
  30 #
  31 usage ()
  32 {
  33 cat << EOF
  34 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  35 $(notify "$(basename "$0"): Deploy the Fuel@OPNFV MCP stack" 3)
  36
  37 $(notify "USAGE:" 2)
  38   $(basename "$0") -l lab-name -p pod-name -s deploy-scenario \\
  39     [-b Lab Config Base URI] \\
  40     [-S storage-dir] [-L /path/to/log/file.tar.gz] \\
  41     [-f] [-F] [-e | -E[E]] [-d] [-D] [-N] [-m]
  42
  43 $(notify "OPTIONS:" 2)
  44   -b  Base-uri for the stack-configuration structure
  45   -d  Dry-run
  46   -D  Debug logging
  47   -e  Do not launch environment deployment
  48   -E  Remove existing VCP VMs (use twice to redeploy baremetal nodes)
  49   -f  Deploy on existing Salt master (use twice or more to skip states)
  50   -F  Same as -e, do not launch environment deployment (legacy option)
  51   -h  Print this message and exit
  52   -l  Lab-name
  53   -p  Pod-name
  54   -P  Skip installation of package dependencies
  55   -s  Deploy-scenario short-name
  56   -S  Storage dir for VM images and other deploy artifacts
  57   -L  Deployment log path and file name
  58   -m  Use single socket CPU compute nodes (only affects virtual computes)
  59   -N  Experimental: Do not virtualize control plane (novcp)
  60
  61 $(notify_i "Description:" 2)
  62 Deploys the Fuel@OPNFV stack on the indicated lab resource.
  63
  64 This script provides the Fuel@OPNFV deployment abstraction.
  65 It depends on the OPNFV official configuration directory/file structure
  66 and provides a fairly simple mechanism to execute a deployment.
  67
  68 $(notify_i "Input parameters to the build script are:" 2)
  69 -b Base URI to the configuration directory (needs to be provided in URI style,
  70    it can be a local resource: file:// or a remote resource http(s)://).
  71    A POD Descriptor File (PDF) and its Installer Descriptor File (IDF)
  72    companion should be available at:
  73    <base-uri>/labs/<lab-name>/<pod-name>.yaml
  74    <base-uri>/labs/<lab-name>/idf-<pod-name>.yaml
  75    The default is using the git submodule tracking 'OPNFV Pharos' in
  76    <./mcp/scripts/pharos>.
  77    An example config is provided inside current repo in
  78    <./mcp/config>, automatically linked as <./mcp/scripts/pharos/labs/local>.
  79 -d Dry-run - Produce deploy config files, but do not execute deploy
  80 -D Debug logging - Enable extra logging in sh deploy scripts (set -x)
  81 -e Do not launch environment deployment
  82 -E Remove existing VCP VMs. It will destroy and undefine all VCP VMs
  83    currently defined on cluster KVM nodes. If specified twice (e.g. -E -E),
  84    baremetal nodes (VCP too, implicitly) will be removed, then reprovisioned.
  85    Only applicable for baremetal deploys.
  86 -f Deploy on existing Salt master. It will skip infrastructure VM creation,
  87    but it will still sync reclass configuration from current repo to Salt
  88    Master node.
  89    Each additional use skips one more state file. For example, -fff would
  90    skip the first 3 state files (e.g. virtual_init, maas, baremetal_init).
  91 -F Same as -e, do not launch environment deployment (legacy option)
  92 -h Print this message and exit
  93 -L Deployment log path and name, eg. -L /home/jenkins/job.log.tar.gz
  94 -l Lab name as defined in the configuration directory, e.g. lf
  95    For the sample configuration in <./mcp/config>, lab name is 'local'.
  96 -p POD name as defined in the configuration directory, e.g. pod2
  97    For the sample configuration in <./mcp/config>, POD name is 'virtual1'
  98    for virtual deployments or 'pod1' for baremetal (based on lf-pod2).
  99 -m Use single socket compute nodes. Instead of using default NUMA-enabled
 100    topology for virtual compute nodes created via libvirt, configure a
 101    single guest CPU socket.
 102 -N Experimental: Instead of virtualizing the control plane (VCP), deploy
 103    control plane directly on baremetal nodes
 104 -P Skip installing dependency distro packages on current host
 105    This flag should only be used if you have kept back older packages that
 106    would be upgraded and that is undesirable on the current system.
 107    Note that without the required packages, deploy will fail.
 108 -s Deployment-scenario, this points to a short deployment scenario name, which
 109    has to be defined in config directory (e.g. os-odl-nofeature-ha).
 110 -S Storage dir for VM images, default is /var/lib/opnfv/tmpdir
 111    It is recommended to store the deploy artifacts on a fast disk, outside of
 112    the current git repository (so clean operations won't erase it).
 113
 114 $(notify_i "[NOTE] sudo & virsh priviledges are needed for this script to run" 3)
 115
 116 Example:
 117
 118 $(notify_i "sudo $(basename "$0") \\
 119   -b file:///home/jenkins/securedlab \\
 120   -l lf -p pod2 \\
 121   -s os-odl-nofeature-ha \\
 122   -S /home/jenkins/tmpdir" 2)
 123 EOF
 124 }
 125
 126 #
 127 # END of usage description
 128 ##############################################################################
 129
 130 ##############################################################################
 131 # BEGIN of variables to customize
 132 #
 133 CI_DEBUG=${CI_DEBUG:-0}; [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
 134 MCP_REPO_ROOT_PATH=$(readlink -f "$(dirname "${BASH_SOURCE[0]}")/..")
 135 DEPLOY_DIR=$(cd "${MCP_REPO_ROOT_PATH}/mcp/scripts"; pwd)
 136 MCP_STORAGE_DIR='/var/lib/opnfv/tmpdir'
 137 URI_REGEXP='(file|https?|ftp)://.*'
 138 BASE_CONFIG_URI="file://${MCP_REPO_ROOT_PATH}/mcp/scripts/pharos"
 139
 140 # Customize deploy workflow
 141 DRY_RUN=${DRY_RUN:-0}
 142 USE_EXISTING_PKGS=${USE_EXISTING_PKGS:-0}
 143 USE_EXISTING_INFRA=${USE_EXISTING_INFRA:-0}
 144 NO_DEPLOY_ENVIRONMENT=${NO_DEPLOY_ENVIRONMENT:-0}
 145 ERASE_ENV=${ERASE_ENV:-0}
 146 MCP_VCP=${MCP_VCP:-1}
 147 MCP_DOCKER_TAG=${MCP_DOCKER_TAG:-latest}
 148 MCP_CMP_SS=${MCP_CMP_SS:-0}
 149
 150 source "${DEPLOY_DIR}/globals.sh"
 151 source "${DEPLOY_DIR}/lib.sh"
 152 source "${DEPLOY_DIR}/lib_template.sh"
 153 source "${DEPLOY_DIR}/lib_jump_common.sh"
 154 source "${DEPLOY_DIR}/lib_jump_deploy.sh"
 155
 156 #
 157 # END of variables to customize
 158 ##############################################################################
 159
 160 ##############################################################################
 161 # BEGIN of main
 162 #
 163 set +x
 164 while getopts "b:dDfEFl:L:Np:Ps:S:he" OPTION
 165 do
 166     case $OPTION in
 167         b)
 168             BASE_CONFIG_URI=${OPTARG}
 169             if [[ ! $BASE_CONFIG_URI =~ ${URI_REGEXP} ]]; then
 170                 notify "[ERROR] -b $BASE_CONFIG_URI - invalid URI"
 171                 usage
 172                 exit 1
 173             fi
 174             ;;
 175         d)
 176             DRY_RUN=1
 177             ;;
 178         D)
 179             CI_DEBUG=1
 180             ;;
 181         f)
 182             ((USE_EXISTING_INFRA+=1))
 183             ;;
 184         F|e)
 185             NO_DEPLOY_ENVIRONMENT=1
 186             ;;
 187         E)
 188             ((ERASE_ENV+=1))
 189             ;;
 190         l)
 191             TARGET_LAB=${OPTARG}
 192             ;;
 193         L)
 194             DEPLOY_LOG="${OPTARG}"
 195             ;;
 196         m)
 197             MCP_CMP_SS=1
 198             ;;
 199         N)
 200             MCP_VCP=0
 201             ;;
 202         p)
 203             TARGET_POD=${OPTARG}
 204             ;;
 205         P)
 206             USE_EXISTING_PKGS=1
 207             ;;
 208         s)
 209             DEPLOY_SCENARIO=${OPTARG}
 210             ;;
 211         S)
 212             if [[ ${OPTARG} ]]; then
 213                 MCP_STORAGE_DIR="${OPTARG}"
 214             fi
 215             ;;
 216         h)
 217             usage
 218             exit 0
 219             ;;
 220         *)
 221             notify_e "[ERROR] Unsupported arg, see -h for help"
 222             ;;
 223     esac
 224 done
 225
 226 if [[ "$(sudo whoami)" != 'root' ]]; then
 227     notify_e "[ERROR] This script requires sudo rights"
 228 fi
 229
 230 # Validate mandatory arguments are set
 231 if [ -z "${TARGET_LAB}" ] || [ -z "${TARGET_POD}" ] || \
 232    [ -z "${DEPLOY_SCENARIO}" ]; then
 233     usage
 234     notify_e "[ERROR] At least one of the mandatory args is missing!"
 235 fi
 236
 237 [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
 238
 239 # Enable the automatic exit trap
 240 trap do_exit SIGINT SIGTERM EXIT
 241
 242 # Set no restrictive umask so that Jenkins can remove any residuals
 243 umask 0000
 244
 245 pushd "${DEPLOY_DIR}" > /dev/null
 246 # Prepare the deploy config files based on lab/pod information, deployment
 247 # scenario, etc.
 248
 249 # Install required packages on jump server
 250 sudo mkdir -p "${MCP_STORAGE_DIR}"
 251 sudo chown -R "${USER}:${USER}" "${MCP_STORAGE_DIR}"
 252 if [ ${USE_EXISTING_PKGS} -eq 1 ]; then
 253     notify "[NOTE] Skipping distro pkg installation" 2
 254 else
 255     notify "[NOTE] Installing required distro pkgs" 2
 256     jumpserver_pkg_install 'deploy'
 257     docker_install "${MCP_STORAGE_DIR}"
 258     virtinst_install "${MCP_STORAGE_DIR}"
 259 fi
 260
 261 if ! ${VIRSH} list >/dev/null 2>&1; then
 262     notify_e "[ERROR] This script requires hypervisor access"
 263 fi
 264
 265 # Collect jump server system information for deploy debugging
 266 ./sysinfo_print.sh
 267
 268 # Clone git submodules and apply our patches
 269 make -C "${MCP_REPO_ROOT_PATH}/mcp/patches" deepclean patches-import
 270
 271 # Check scenario file existence
 272 SCENARIO_DIR="$(readlink -f "../config/scenario")"
 273 if [ ! -f "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml" ] && \
 274    [ ! -f "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml.j2" ]; then
 275     notify_e "[ERROR] Scenario definition file is missing!"
 276 fi
 277
 278 # key might not exist yet ...
 279 generate_ssh_key
 280 export MAAS_SSH_KEY="$(cat "$(basename "${SSH_KEY}").pub")"
 281
 282 # Expand jinja2 templates based on PDF data and env vars
 283 [[ "${DEPLOY_SCENARIO}" =~ -ha$ ]] || MCP_VCP=0
 284 export MCP_REPO_ROOT_PATH MCP_VCP MCP_STORAGE_DIR MCP_DOCKER_TAG MCP_CMP_SS \
 285        MCP_JUMP_ARCH=$(uname -i) MCP_DEPLOY_SCENARIO="${DEPLOY_SCENARIO}"
 286 do_templates_scenario "${MCP_STORAGE_DIR}" "${TARGET_LAB}" "${TARGET_POD}" \
 287                       "${BASE_CONFIG_URI}" "${SCENARIO_DIR}" \
 288                       "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml"
 289 do_templates_cluster  "${MCP_STORAGE_DIR}" "${TARGET_LAB}" "${TARGET_POD}" \
 290                       "${MCP_REPO_ROOT_PATH}" \
 291                       "${SCENARIO_DIR}/defaults.yaml"
 292
 293 # Determine additional data (e.g. jump bridge names) based on XDF
 294 source "${DEPLOY_DIR}/xdf_data.sh"
 295
 296 # Jumpserver prerequisites check
 297 notify "[NOTE] Using bridges: ${OPNFV_BRIDGES[*]}" 2
 298 jumpserver_check_requirements "${virtual_nodes[*]}" "${OPNFV_BRIDGES[@]}"
 299
 300 # Infra setup
 301 if [ ${DRY_RUN} -eq 1 ]; then
 302     notify "[NOTE] Dry run, skipping all deployment tasks" 2
 303     exit 0
 304 elif [ ${USE_EXISTING_INFRA} -gt 0 ]; then
 305     notify "[NOTE] Use existing infra: skip first ${USE_EXISTING_INFRA} states" 2
 306     notify "[STATE] Skipping: ${cluster_states[*]::${USE_EXISTING_INFRA}}" 2
 307 else
 308     prepare_vms "${base_image}" "${MCP_STORAGE_DIR}" "${virtual_repos_pkgs}" \
 309       "${virtual_nodes[@]}"
 310     create_networks "${OPNFV_BRIDGES[@]}"
 311     do_sysctl_cfg
 312     do_udev_cfg
 313     create_vms "${MCP_STORAGE_DIR}" "${virtual_nodes_data}" "${OPNFV_BRIDGES[@]}"
 314     update_mcpcontrol_network
 315     start_vms "${virtual_nodes[@]}"
 316
 317     # https://github.com/docker/libnetwork/issues/1743
 318     # rm -f /var/lib/docker/network/files/local-kv.db
 319     sudo systemctl restart docker
 320     prepare_containers "${MCP_STORAGE_DIR}"
 321 fi
 322
 323 start_containers "${MCP_STORAGE_DIR}"
 324 check_connection
 325
 326 # Openstack cluster setup
 327 set +x
 328 if [ ${NO_DEPLOY_ENVIRONMENT} -eq 1 ]; then
 329     notify "[NOTE] Skip openstack cluster setup" 2
 330 else
 331     for state in "${cluster_states[@]:${USE_EXISTING_INFRA}}"; do
 332         notify "[STATE] Applying state: ${state}" 2
 333         # shellcheck disable=SC2086,2029
 334         wait_for 5 "ssh ${SSH_OPTS} ${SSH_SALT} sudo \
 335             CI_DEBUG=$CI_DEBUG ERASE_ENV=$ERASE_ENV \
 336             /root/fuel/mcp/config/states/${state}"
 337         if [ "${state}" = 'maas' ]; then
 338             # For hybrid PODs (virtual + baremetal nodes), the virtual nodes
 339             # should be reset to force a DHCP request from MaaS DHCP
 340             reset_vms "${virtual_nodes[@]}"
 341         fi
 342     done
 343
 344     ./log.sh "${DEPLOY_LOG}"
 345 fi
 346
 347 popd > /dev/null
 348
 349 #
 350 # END of main
 351 ##############################################################################