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