ci/deploy.sh

   1 #!/bin/bash -e
   2 # shellcheck disable=SC2034,SC2154,SC1090,SC1091
   3 ##############################################################################
   4 # Copyright (c) 2017 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!\n\n" 2
  20     else
  21         notify "\n[ERROR] MCP: Openstack installation threw a fatal error!\n\n"
  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]] [-F] [-e | -E[E]] [-d] [-D]
  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 to also skip config sync)
  50   -F  Do only create a Salt master
  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
  57   -L  Deployment log path and file name
  58
  59 $(notify "Description:" 2)
  60 Deploys the Fuel@OPNFV stack on the indicated lab resource.
  61
  62 This script provides the Fuel@OPNFV deployment abstraction.
  63 It depends on the OPNFV official configuration directory/file structure
  64 and provides a fairly simple mechanism to execute a deployment.
  65
  66 $(notify "Input parameters to the build script are:" 2)
  67 -b Base URI to the configuration directory (needs to be provided in URI style,
  68    it can be a local resource: file:// or a remote resource http(s)://).
  69    A POD Descriptor File (PDF) and its Installer Descriptor File (IDF)
  70    companion should be available at:
  71    <base-uri>/labs/<lab-name>/<pod-name>.yaml
  72    <base-uri>/labs/<lab-name>/idf-<pod-name>.yaml
  73    The default is using the git submodule tracking 'OPNFV Pharos' in
  74    <./mcp/scripts/pharos>.
  75    An example config is provided inside current repo in
  76    <./mcp/config>, automatically linked as <./mcp/scripts/pharos/labs/local>.
  77 -d Dry-run - Produce deploy config files, but do not execute deploy
  78 -D Debug logging - Enable extra logging in sh deploy scripts (set -x)
  79 -e Do not launch environment deployment
  80 -E Remove existing VCP VMs. It will destroy and undefine all VCP VMs
  81    currently defined on cluster KVM nodes. If specified twice (e.g. -E -E),
  82    baremetal nodes (VCP too, implicitly) will be removed, then reprovisioned.
  83    Only applicable for baremetal deploys.
  84 -f Deploy on existing Salt master. It will skip infrastructure VM creation,
  85    but it will still sync reclass configuration from current repo to Salt
  86    Master node. If specified twice (e.g. -f -f), config sync will also be
  87    skipped.
  88 -F Do only create a Salt master
  89 -h Print this message and exit
  90 -L Deployment log path and name, eg. -L /home/jenkins/job.log.tar.gz
  91 -l Lab name as defined in the configuration directory, e.g. lf
  92 -p POD name as defined in the configuration directory, e.g. pod2
  93 -P Skip installing dependency distro packages on current host
  94    This flag should only be used if you have kept back older packages that
  95    would be upgraded and that is undesirable on the current system.
  96    Note that without the required packages, deploy will fail.
  97 -s Deployment-scenario, this points to a short deployment scenario name, which
  98    has to be defined in config directory (e.g. os-odl-nofeature-ha).
  99 -S Storage dir for VM images, default is mcp/deploy/images
 100
 101 $(notify "[NOTE] sudo & virsh priviledges are needed for this script to run" 3)
 102
 103 Example:
 104
 105 $(notify "sudo $(basename "$0") \\
 106   -b file:///home/jenkins/securedlab \\
 107   -l lf -p pod2 \\
 108   -s os-odl-nofeature-ha" 2)
 109 EOF
 110 }
 111
 112 #
 113 # END of usage description
 114 ##############################################################################
 115
 116 ##############################################################################
 117 # BEGIN of colored notification wrapper
 118 #
 119 notify() {
 120     tput setaf "${2:-1}" || true
 121     echo -en "${1:-"[WARN] Unsupported opt arg: $3\\n"}"
 122     tput sgr0
 123 }
 124 #
 125 # END of colored notification wrapper
 126 ##############################################################################
 127
 128 ##############################################################################
 129 # BEGIN of variables to customize
 130 #
 131 CI_DEBUG=${CI_DEBUG:-0}; [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
 132 REPO_ROOT_PATH=$(readlink -f "$(dirname "${BASH_SOURCE[0]}")/..")
 133 DEPLOY_DIR=$(cd "${REPO_ROOT_PATH}/mcp/scripts"; pwd)
 134 STORAGE_DIR=$(cd "${REPO_ROOT_PATH}/mcp/deploy/images"; pwd)
 135 RECLASS_CLUSTER_DIR=$(cd "${REPO_ROOT_PATH}/mcp/reclass/classes/cluster"; pwd)
 136 DEPLOY_TYPE='baremetal'
 137 BR_NAMES=('admin' 'mgmt' 'private' 'public')
 138 OPNFV_BRIDGES=('pxebr' 'mgmt' 'internal' 'public')
 139 URI_REGEXP='(file|https?|ftp)://.*'
 140 BASE_CONFIG_URI="file://${REPO_ROOT_PATH}/mcp/scripts/pharos"
 141
 142 # Customize deploy workflow
 143 DRY_RUN=${DRY_RUN:-0}
 144 USE_EXISTING_PKGS=${USE_EXISTING_PKGS:-0}
 145 USE_EXISTING_INFRA=${USE_EXISTING_INFRA:-0}
 146 INFRA_CREATION_ONLY=${INFRA_CREATION_ONLY:-0}
 147 NO_DEPLOY_ENVIRONMENT=${NO_DEPLOY_ENVIRONMENT:-0}
 148 ERASE_ENV=${ERASE_ENV:-0}
 149
 150 source "${DEPLOY_DIR}/globals.sh"
 151 source "${DEPLOY_DIR}/lib.sh"
 152
 153 #
 154 # END of variables to customize
 155 ##############################################################################
 156
 157 ##############################################################################
 158 # BEGIN of main
 159 #
 160 set +x
 161 while getopts "b:dDfEFl:L:p:Ps:S:he" OPTION
 162 do
 163     case $OPTION in
 164         b)
 165             BASE_CONFIG_URI=${OPTARG}
 166             if [[ ! $BASE_CONFIG_URI =~ ${URI_REGEXP} ]]; then
 167                 notify "[ERROR] -b $BASE_CONFIG_URI - invalid URI\n"
 168                 usage
 169                 exit 1
 170             fi
 171             ;;
 172         d)
 173             DRY_RUN=1
 174             ;;
 175         D)
 176             CI_DEBUG=1
 177             ;;
 178         f)
 179             ((USE_EXISTING_INFRA+=1))
 180             ;;
 181         F)
 182             INFRA_CREATION_ONLY=1
 183             ;;
 184         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         p)
 197             TARGET_POD=${OPTARG}
 198             if [[ "${TARGET_POD}" =~ virtual ]]; then
 199                 DEPLOY_TYPE='virtual'
 200                 # All vPODs will use 'local-virtual1' PDF/IDF for now
 201                 TARGET_LAB='local'
 202                 TARGET_POD='virtual1'
 203             fi
 204             ;;
 205         P)
 206             USE_EXISTING_PKGS=1
 207             ;;
 208         s)
 209             DEPLOY_SCENARIO=${OPTARG}
 210             ;;
 211         S)
 212             if [[ ${OPTARG} ]]; then
 213                 STORAGE_DIR="${OPTARG}"
 214             fi
 215             ;;
 216         h)
 217             usage
 218             exit 0
 219             ;;
 220         *)
 221             notify "[ERROR] Arguments not according to new argument style\n"
 222             exit 1
 223             ;;
 224     esac
 225 done
 226
 227 if [[ "$(sudo whoami)" != 'root' ]]; then
 228     notify "[ERROR] This script requires sudo rights\n" 1>&2
 229     exit 1
 230 fi
 231
 232 # Validate mandatory arguments are set
 233 if [ -z "${TARGET_LAB}" ] || [ -z "${TARGET_POD}" ] || \
 234    [ -z "${DEPLOY_SCENARIO}" ]; then
 235     notify "[ERROR] At least one of the mandatory args is missing!\n" 1>&2
 236     usage
 237     exit 1
 238 fi
 239
 240 [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
 241
 242 # Enable the automatic exit trap
 243 trap do_exit SIGINT SIGTERM EXIT
 244
 245 # Set no restrictive umask so that Jenkins can remove any residuals
 246 umask 0000
 247
 248 pushd "${DEPLOY_DIR}" > /dev/null
 249 # Prepare the deploy config files based on lab/pod information, deployment
 250 # scenario, etc.
 251
 252 # Install required packages on jump server
 253 if [ ${USE_EXISTING_PKGS} -eq 1 ]; then
 254     notify "[NOTE] Skipping distro pkg installation\n" 2 1>&2
 255 else
 256     notify "[NOTE] Installing required distro pkgs\n" 2 1>&2
 257     if [ -n "$(command -v apt-get)" ]; then
 258       pkg_type='deb'; pkg_cmd='sudo apt-get install -y'
 259     else
 260       pkg_type='rpm'; pkg_cmd='sudo yum install -y --skip-broken'
 261     fi
 262     eval "$(parse_yaml "./requirements_${pkg_type}.yaml")"
 263     for section in 'common' "${DEPLOY_TYPE}" "$(uname -m)"; do
 264       section_var="requirements_pkg_${section}[*]"
 265       pkg_list+=" ${!section_var}"
 266     done
 267     # shellcheck disable=SC2086
 268     ${pkg_cmd} ${pkg_list}
 269 fi
 270
 271 if ! virsh list >/dev/null 2>&1; then
 272     notify "[ERROR] This script requires hypervisor access\n" 1>&2
 273     exit 1
 274 fi
 275
 276 # Collect jump server system information for deploy debugging
 277 ./sysinfo_print.sh
 278
 279 # Clone git submodules and apply our patches
 280 make -C "${REPO_ROOT_PATH}/mcp/patches" deepclean patches-import
 281
 282 # Convert Pharos-compatible POD Descriptor File (PDF) to reclass model input
 283 PHAROS_GEN_CONFIG_SCRIPT="./pharos/config/utils/generate_config.py"
 284 PHAROS_INSTALLER_ADAPTER="./pharos/config/installers/fuel/pod_config.yml.j2"
 285 BASE_CONFIG_PDF="${BASE_CONFIG_URI}/labs/${TARGET_LAB}/${TARGET_POD}.yaml"
 286 BASE_CONFIG_IDF="${BASE_CONFIG_URI}/labs/${TARGET_LAB}/idf-${TARGET_POD}.yaml"
 287 LOCAL_PDF="${STORAGE_DIR}/$(basename "${BASE_CONFIG_PDF}")"
 288 LOCAL_IDF="${STORAGE_DIR}/$(basename "${BASE_CONFIG_IDF}")"
 289 LOCAL_PDF_RECLASS="${STORAGE_DIR}/pod_config.yml"
 290 rm -f "${LOCAL_PDF_RECLASS}"
 291 ln -sf "$(readlink -f "../config/labs/local")" "./pharos/labs/"
 292 if ! curl --create-dirs -o "${LOCAL_PDF}" "${BASE_CONFIG_PDF}"; then
 293     notify "[ERROR] Could not retrieve PDF (Pod Descriptor File)!\n" 1>&2
 294     exit 1
 295 elif ! curl -o "${LOCAL_IDF}" "${BASE_CONFIG_IDF}"; then
 296     notify "[ERROR] Could not retrieve IDF (Installer Descriptor File)!\n" 1>&2
 297     exit 1
 298 elif ! "${PHAROS_GEN_CONFIG_SCRIPT}" -y "${LOCAL_PDF}" \
 299     -j "${PHAROS_INSTALLER_ADAPTER}" > "${LOCAL_PDF_RECLASS}"; then
 300     notify "[ERROR] Could not convert PDF+IDF to reclass model input!\n" 1>&2
 301     exit 1
 302 fi
 303
 304 # Check scenario file existence
 305 SCENARIO_DIR="../config/scenario"
 306 if [ ! -f  "${SCENARIO_DIR}/${DEPLOY_TYPE}/${DEPLOY_SCENARIO}.yaml" ]; then
 307     notify "[ERROR] Scenario definition file is missing!\n" 1>&2
 308     exit 1
 309 fi
 310
 311 # Check defaults file existence
 312 if [ ! -f  "${SCENARIO_DIR}/defaults-$(uname -i).yaml" ]; then
 313     notify "[ERROR] Scenario defaults file is missing!\n" 1>&2
 314     exit 1
 315 fi
 316
 317 # Get required infra deployment data
 318 set +x
 319 eval "$(parse_yaml "${SCENARIO_DIR}/defaults-$(uname -i).yaml")"
 320 eval "$(parse_yaml "${SCENARIO_DIR}/${DEPLOY_TYPE}/${DEPLOY_SCENARIO}.yaml")"
 321 eval "$(parse_yaml "${LOCAL_PDF_RECLASS}")"
 322 [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
 323
 324 export CLUSTER_DOMAIN=${cluster_domain}
 325
 326 # Serialize vnode data as '<name0>,<ram0>,<vcpu0>|<name1>,<ram1>,<vcpu1>[...]'
 327 for node in "${virtual_nodes[@]}"; do
 328     virtual_custom_ram="virtual_${node}_ram"
 329     virtual_custom_vcpus="virtual_${node}_vcpus"
 330     virtual_nodes_data+="${node},"
 331     virtual_nodes_data+="${!virtual_custom_ram:-$virtual_default_ram},"
 332     virtual_nodes_data+="${!virtual_custom_vcpus:-$virtual_default_vcpus}|"
 333 done
 334 virtual_nodes_data=${virtual_nodes_data%|}
 335
 336 # Serialize repos, packages to (pre-)install/remove for:
 337 # - foundation node VM base image (virtual: all VMs, baremetal: cfg01|mas01)
 338 # - virtualized control plane VM base image (only when VCP is used)
 339 base_image_flavors=common
 340 if [[ "${cluster_states[*]}" =~ virtual_control ]]; then
 341   base_image_flavors+=" control"
 342 fi
 343 for sc in ${base_image_flavors}; do
 344   for va in apt_keys apt_repos pkg_install pkg_remove; do
 345     key=virtual_${sc}_${va}
 346     eval "${key}=\${${key}[@]// /|}"
 347     eval "${key}=\${${key}// /,}"
 348     virtual_repos_pkgs+="${!key}^"
 349   done
 350 done
 351 virtual_repos_pkgs=${virtual_repos_pkgs%^}
 352
 353 # Expand reclass and virsh network templates
 354 for tp in "${RECLASS_CLUSTER_DIR}/all-mcp-arch-common/opnfv/"*.template \
 355     net_*.template; do
 356         eval "cat <<-EOF
 357                 $(<"${tp}")
 358                 EOF" 2> /dev/null > "${tp%.template}"
 359 done
 360
 361 # Convert Pharos-compatible PDF to reclass network definitions
 362 find "${RECLASS_CLUSTER_DIR}" -name '*.j2' | while read -r tp
 363 do
 364     if ! "${PHAROS_GEN_CONFIG_SCRIPT}" -y "${LOCAL_PDF}" \
 365       -j "${tp}" > "${tp%.j2}"; then
 366          notify "[ERROR] Could not convert PDF to reclass network defs!\n"
 367          exit 1
 368     fi
 369 done
 370
 371 # Determine 'admin', 'mgmt', 'private' and 'public' bridge names based on IDF
 372 for ((i = 0; i < ${#BR_NAMES[@]}; i++)); do
 373     br_jump=$(eval echo "\$parameters__param_opnfv_jump_bridge_${BR_NAMES[i]}")
 374     if [ -n "${br_jump}" ] && [ "${br_jump}" != 'None' ]; then
 375         OPNFV_BRIDGES[${i}]="${br_jump}"
 376     fi
 377 done
 378 notify "[NOTE] Using bridges: ${OPNFV_BRIDGES[*]}\n" 2
 379
 380 # Infra setup
 381 if [ ${DRY_RUN} -eq 1 ]; then
 382     notify "[NOTE] Dry run, skipping all deployment tasks\n" 2 1>&2
 383     exit 0
 384 elif [ ${USE_EXISTING_INFRA} -gt 0 ]; then
 385     notify "[NOTE] Use existing infra\n" 2 1>&2
 386     check_connection
 387 else
 388     generate_ssh_key
 389     prepare_vms "${base_image}" "${STORAGE_DIR}" "${virtual_repos_pkgs}" \
 390       "${virtual_nodes[@]}"
 391     create_networks "${OPNFV_BRIDGES[@]}"
 392     do_sysctl_cfg
 393     create_vms "${STORAGE_DIR}" "${virtual_nodes_data}" "${OPNFV_BRIDGES[@]}"
 394     update_mcpcontrol_network
 395     start_vms "${virtual_nodes[@]}"
 396     check_connection
 397 fi
 398 if [ ${USE_EXISTING_INFRA} -lt 2 ]; then
 399     wait_for 5 "./salt.sh ${LOCAL_PDF_RECLASS}"
 400 fi
 401
 402 # Openstack cluster setup
 403 set +x
 404 if [ ${INFRA_CREATION_ONLY} -eq 1 ] || [ ${NO_DEPLOY_ENVIRONMENT} -eq 1 ]; then
 405     notify "[NOTE] Skip openstack cluster setup\n" 2
 406 else
 407     for state in "${cluster_states[@]}"; do
 408         notify "[STATE] Applying state: ${state}\n" 2
 409         # shellcheck disable=SC2086,2029
 410         wait_for 5 "ssh ${SSH_OPTS} ${SSH_SALT} sudo \
 411             CI_DEBUG=$CI_DEBUG ERASE_ENV=$ERASE_ENV \
 412             /root/fuel/mcp/config/states/${state}"
 413     done
 414 fi
 415
 416 ./log.sh "${DEPLOY_LOG}"
 417
 418 popd > /dev/null
 419
 420 #
 421 # END of main
 422 ##############################################################################