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!" 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]] [-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_i "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_i "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_i "[NOTE] sudo & virsh priviledges are needed for this script to run" 3)
 102
 103 Example:
 104
 105 $(notify_i "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 variables to customize
 118 #
 119 CI_DEBUG=${CI_DEBUG:-0}; [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
 120 REPO_ROOT_PATH=$(readlink -f "$(dirname "${BASH_SOURCE[0]}")/..")
 121 DEPLOY_DIR=$(cd "${REPO_ROOT_PATH}/mcp/scripts"; pwd)
 122 STORAGE_DIR=$(cd "${REPO_ROOT_PATH}/mcp/deploy/images"; pwd)
 123 BR_NAMES=('admin' 'mgmt' 'private' 'public')
 124 OPNFV_BRIDGES=('pxebr' 'mgmt' 'internal' 'public')
 125 URI_REGEXP='(file|https?|ftp)://.*'
 126 BASE_CONFIG_URI="file://${REPO_ROOT_PATH}/mcp/scripts/pharos"
 127
 128 # Customize deploy workflow
 129 DRY_RUN=${DRY_RUN:-0}
 130 USE_EXISTING_PKGS=${USE_EXISTING_PKGS:-0}
 131 USE_EXISTING_INFRA=${USE_EXISTING_INFRA:-0}
 132 INFRA_CREATION_ONLY=${INFRA_CREATION_ONLY:-0}
 133 NO_DEPLOY_ENVIRONMENT=${NO_DEPLOY_ENVIRONMENT:-0}
 134 ERASE_ENV=${ERASE_ENV:-0}
 135
 136 source "${DEPLOY_DIR}/globals.sh"
 137 source "${DEPLOY_DIR}/lib.sh"
 138
 139 #
 140 # END of variables to customize
 141 ##############################################################################
 142
 143 ##############################################################################
 144 # BEGIN of main
 145 #
 146 set +x
 147 while getopts "b:dDfEFl:L:p:Ps:S:he" OPTION
 148 do
 149     case $OPTION in
 150         b)
 151             BASE_CONFIG_URI=${OPTARG}
 152             if [[ ! $BASE_CONFIG_URI =~ ${URI_REGEXP} ]]; then
 153                 notify "[ERROR] -b $BASE_CONFIG_URI - invalid URI"
 154                 usage
 155                 exit 1
 156             fi
 157             ;;
 158         d)
 159             DRY_RUN=1
 160             ;;
 161         D)
 162             CI_DEBUG=1
 163             ;;
 164         f)
 165             ((USE_EXISTING_INFRA+=1))
 166             ;;
 167         F)
 168             INFRA_CREATION_ONLY=1
 169             ;;
 170         e)
 171             NO_DEPLOY_ENVIRONMENT=1
 172             ;;
 173         E)
 174             ((ERASE_ENV+=1))
 175             ;;
 176         l)
 177             TARGET_LAB=${OPTARG}
 178             ;;
 179         L)
 180             DEPLOY_LOG="${OPTARG}"
 181             ;;
 182         p)
 183             TARGET_POD=${OPTARG}
 184             if [[ "${TARGET_POD}" =~ virtual ]]; then
 185                 # All vPODs will use 'local-virtual1' PDF/IDF for now
 186                 TARGET_LAB='local'
 187                 TARGET_POD='virtual1'
 188             fi
 189             ;;
 190         P)
 191             USE_EXISTING_PKGS=1
 192             ;;
 193         s)
 194             DEPLOY_SCENARIO=${OPTARG}
 195             ;;
 196         S)
 197             if [[ ${OPTARG} ]]; then
 198                 STORAGE_DIR="${OPTARG}"
 199             fi
 200             ;;
 201         h)
 202             usage
 203             exit 0
 204             ;;
 205         *)
 206             notify_e "[ERROR] Unsupported arg, see -h for help"
 207             ;;
 208     esac
 209 done
 210
 211 if [[ "$(sudo whoami)" != 'root' ]]; then
 212     notify_e "[ERROR] This script requires sudo rights"
 213 fi
 214
 215 # Validate mandatory arguments are set
 216 if [ -z "${TARGET_LAB}" ] || [ -z "${TARGET_POD}" ] || \
 217    [ -z "${DEPLOY_SCENARIO}" ]; then
 218     usage
 219     notify_e "[ERROR] At least one of the mandatory args is missing!"
 220 fi
 221
 222 [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
 223
 224 # Enable the automatic exit trap
 225 trap do_exit SIGINT SIGTERM EXIT
 226
 227 # Set no restrictive umask so that Jenkins can remove any residuals
 228 umask 0000
 229
 230 pushd "${DEPLOY_DIR}" > /dev/null
 231 # Prepare the deploy config files based on lab/pod information, deployment
 232 # scenario, etc.
 233
 234 # Install required packages on jump server
 235 if [ ${USE_EXISTING_PKGS} -eq 1 ]; then
 236     notify "[NOTE] Skipping distro pkg installation" 2
 237 else
 238     notify "[NOTE] Installing required distro pkgs" 2
 239     if [ -n "$(command -v apt-get)" ]; then
 240       pkg_type='deb'; pkg_cmd='sudo apt-get install -y'
 241     else
 242       pkg_type='rpm'; pkg_cmd='sudo yum install -y --skip-broken'
 243     fi
 244     eval "$(parse_yaml "./requirements_${pkg_type}.yaml")"
 245     for section in 'common' "$(uname -m)"; do
 246       section_var="requirements_pkg_${section}[*]"
 247       pkg_list+=" ${!section_var}"
 248     done
 249     # shellcheck disable=SC2086
 250     ${pkg_cmd} ${pkg_list}
 251 fi
 252
 253 if ! virsh list >/dev/null 2>&1; then
 254     notify_e "[ERROR] This script requires hypervisor access"
 255 fi
 256
 257 # Collect jump server system information for deploy debugging
 258 ./sysinfo_print.sh
 259
 260 # Clone git submodules and apply our patches
 261 make -C "${REPO_ROOT_PATH}/mcp/patches" deepclean patches-import
 262
 263 # Expand scenario files, pod_config based on PDF
 264 SCENARIO_DIR="$(readlink -f "../config/scenario")"
 265 do_templates "${REPO_ROOT_PATH}" "${STORAGE_DIR}" "${TARGET_LAB}" \
 266              "${TARGET_POD}" "${BASE_CONFIG_URI}" "${SCENARIO_DIR}"
 267
 268 # Check scenario file existence
 269 if [ ! -f  "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml" ]; then
 270     notify_e "[ERROR] Scenario definition file is missing!"
 271 fi
 272
 273 # Check defaults file existence
 274 if [ ! -f  "${SCENARIO_DIR}/defaults-$(uname -i).yaml" ]; then
 275     notify_e "[ERROR] Scenario defaults file is missing!"
 276 fi
 277
 278 # Get scenario data and (jumpserver) arch defaults
 279 eval "$(parse_yaml "${SCENARIO_DIR}/defaults-$(uname -i).yaml")"
 280 eval "$(parse_yaml "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml")"
 281 export CLUSTER_DOMAIN=${cluster_domain}
 282
 283 # Expand jinja2 templates based on PDF data and env vars
 284 do_templates "${REPO_ROOT_PATH}" "${STORAGE_DIR}" "${TARGET_LAB}" \
 285              "${TARGET_POD}" "${BASE_CONFIG_URI}"
 286
 287 # Get required infra deployment data based on PDF/IDF (after template parsing)
 288 set +x
 289 eval "$(parse_yaml "${STORAGE_DIR}/pod_config.yml")"
 290 [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
 291
 292 # Serialize vnode data as '<name0>,<ram0>,<vcpu0>|<name1>,<ram1>,<vcpu1>[...]'
 293 for node in "${virtual_nodes[@]}"; do
 294     virtual_custom_ram="virtual_${node}_ram"
 295     virtual_custom_vcpus="virtual_${node}_vcpus"
 296     virtual_nodes_data+="${node},"
 297     virtual_nodes_data+="${!virtual_custom_ram:-$virtual_default_ram},"
 298     virtual_nodes_data+="${!virtual_custom_vcpus:-$virtual_default_vcpus}|"
 299 done
 300 virtual_nodes_data=${virtual_nodes_data%|}
 301
 302 # Serialize repos, packages to (pre-)install/remove for:
 303 # - foundation node VM base image (virtual: all VMs, baremetal: cfg01|mas01)
 304 # - virtualized control plane VM base image (only when VCP is used)
 305 base_image_flavors=common
 306 if [[ "${cluster_states[*]}" =~ virtual_control ]]; then
 307   base_image_flavors+=" control"
 308 fi
 309 for sc in ${base_image_flavors}; do
 310   for va in apt_keys apt_repos pkg_install pkg_remove; do
 311     key=virtual_${sc}_${va}
 312     eval "${key}=\${${key}[@]// /|}"
 313     eval "${key}=\${${key}// /,}"
 314     virtual_repos_pkgs+="${!key}^"
 315   done
 316 done
 317 virtual_repos_pkgs=${virtual_repos_pkgs%^}
 318
 319 # Determine 'admin', 'mgmt', 'private' and 'public' bridge names based on IDF
 320 for ((i = 0; i < ${#BR_NAMES[@]}; i++)); do
 321     br_jump=$(eval echo "\$parameters__param_opnfv_jump_bridge_${BR_NAMES[i]}")
 322     if [ -n "${br_jump}" ] && [ "${br_jump}" != 'None' ]; then
 323         OPNFV_BRIDGES[${i}]="${br_jump}"
 324     fi
 325 done
 326 notify "[NOTE] Using bridges: ${OPNFV_BRIDGES[*]}" 2
 327
 328 # Jumpserver prerequisites check
 329 jumpserver_check_requirements "${virtual_nodes[*]}" "${OPNFV_BRIDGES[@]}"
 330
 331 # Infra setup
 332 if [ ${DRY_RUN} -eq 1 ]; then
 333     notify "[NOTE] Dry run, skipping all deployment tasks" 2
 334     exit 0
 335 elif [ ${USE_EXISTING_INFRA} -gt 0 ]; then
 336     notify "[NOTE] Use existing infra" 2
 337     check_connection
 338 else
 339     generate_ssh_key
 340     prepare_vms "${base_image}" "${STORAGE_DIR}" "${virtual_repos_pkgs}" \
 341       "${virtual_nodes[@]}"
 342     create_networks "${OPNFV_BRIDGES[@]}"
 343     do_sysctl_cfg
 344     create_vms "${STORAGE_DIR}" "${virtual_nodes_data}" "${OPNFV_BRIDGES[@]}"
 345     update_mcpcontrol_network
 346     start_vms "${virtual_nodes[@]}"
 347     check_connection
 348 fi
 349 if [ ${USE_EXISTING_INFRA} -lt 2 ]; then
 350     wait_for 5 "./salt.sh ${STORAGE_DIR}/pod_config.yml ${virtual_nodes[*]}"
 351 fi
 352
 353 # Openstack cluster setup
 354 set +x
 355 if [ ${INFRA_CREATION_ONLY} -eq 1 ] || [ ${NO_DEPLOY_ENVIRONMENT} -eq 1 ]; then
 356     notify "[NOTE] Skip openstack cluster setup" 2
 357 else
 358     for state in "${cluster_states[@]}"; do
 359         notify "[STATE] Applying state: ${state}" 2
 360         # shellcheck disable=SC2086,2029
 361         wait_for 5 "ssh ${SSH_OPTS} ${SSH_SALT} sudo \
 362             CI_DEBUG=$CI_DEBUG ERASE_ENV=$ERASE_ENV \
 363             /root/fuel/mcp/config/states/${state}"
 364     done
 365 fi
 366
 367 ./log.sh "${DEPLOY_LOG}"
 368
 369 popd > /dev/null
 370
 371 #
 372 # END of main
 373 ##############################################################################