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     if [ -n "$(command -v apt-get)" ]; then
 238       pkg_type='deb'; pkg_cmd='sudo apt-get install -y'
 239     else
 240       pkg_type='rpm'; pkg_cmd='sudo yum install -y --skip-broken'
 241     fi
 242     eval "$(parse_yaml "./requirements_${pkg_type}.yaml")"
 243     for section in 'common' "$(uname -m)"; do
 244       section_var="requirements_pkg_${section}[*]"
 245       pkg_list+=" ${!section_var}"
 246     done
 247     # shellcheck disable=SC2086
 248     ${pkg_cmd} ${pkg_list}
 249 fi
 250
 251 if ! virsh list >/dev/null 2>&1; then
 252     notify_e "[ERROR] This script requires hypervisor access"
 253 fi
 254
 255 # Collect jump server system information for deploy debugging
 256 ./sysinfo_print.sh
 257
 258 # Clone git submodules and apply our patches
 259 make -C "${REPO_ROOT_PATH}/mcp/patches" deepclean patches-import
 260
 261 # Expand scenario files, pod_config based on PDF
 262 SCENARIO_DIR="$(readlink -f "../config/scenario")"
 263 do_templates "${REPO_ROOT_PATH}" "${STORAGE_DIR}" "${TARGET_LAB}" \
 264              "${TARGET_POD}" "${BASE_CONFIG_URI}" "${SCENARIO_DIR}"
 265
 266 # Check scenario file existence
 267 if [ ! -f  "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml" ]; then
 268     notify_e "[ERROR] Scenario definition file is missing!"
 269 fi
 270
 271 # Check defaults file existence
 272 if [ ! -f  "${SCENARIO_DIR}/defaults-$(uname -i).yaml" ]; then
 273     notify_e "[ERROR] Scenario defaults file is missing!"
 274 fi
 275
 276 # Get scenario data and (jumpserver) arch defaults
 277 eval "$(parse_yaml "${SCENARIO_DIR}/defaults-$(uname -i).yaml")"
 278 eval "$(parse_yaml "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml")"
 279 export CLUSTER_DOMAIN=${cluster_domain}
 280
 281 # key might not exist yet ...
 282 generate_ssh_key
 283 export MAAS_SSH_KEY="$(cat "$(basename "${SSH_KEY}").pub")"
 284
 285 # Expand jinja2 templates based on PDF data and env vars
 286 do_templates "${REPO_ROOT_PATH}" "${STORAGE_DIR}" "${TARGET_LAB}" \
 287              "${TARGET_POD}" "${BASE_CONFIG_URI}"
 288
 289 # Serialize vnode data as '<name0>,<ram0>,<vcpu0>|<name1>,<ram1>,<vcpu1>[...]'
 290 for node in "${virtual_nodes[@]}"; do
 291     virtual_custom_ram="virtual_${node}_ram"
 292     virtual_custom_vcpus="virtual_${node}_vcpus"
 293     virtual_nodes_data+="${node},"
 294     virtual_nodes_data+="${!virtual_custom_ram:-$virtual_default_ram},"
 295     virtual_nodes_data+="${!virtual_custom_vcpus:-$virtual_default_vcpus}|"
 296 done
 297 virtual_nodes_data=${virtual_nodes_data%|}
 298
 299 # Serialize repos, packages to (pre-)install/remove for:
 300 # - foundation node VM base image (virtual: all VMs, baremetal: cfg01|mas01)
 301 # - virtualized control plane VM base image (only when VCP is used)
 302 base_image_flavors=common
 303 if [[ "${cluster_states[*]}" =~ virtual_control ]]; then
 304   base_image_flavors+=" control"
 305 fi
 306 for sc in ${base_image_flavors}; do
 307   for va in apt_keys apt_repos pkg_install pkg_remove; do
 308     key=virtual_${sc}_${va}
 309     eval "${key}=\${${key}[@]// /|}"
 310     eval "${key}=\${${key}// /,}"
 311     virtual_repos_pkgs+="${!key}^"
 312   done
 313 done
 314 virtual_repos_pkgs=${virtual_repos_pkgs%^}
 315
 316 # Determine additional data (e.g. jump bridge names) based on XDF
 317 source "${DEPLOY_DIR}/xdf_data.sh"
 318 notify "[NOTE] Using bridges: ${OPNFV_BRIDGES[*]}" 2
 319
 320 # Jumpserver prerequisites check
 321 jumpserver_check_requirements "${virtual_nodes[*]}" "${OPNFV_BRIDGES[@]}"
 322
 323 # Infra setup
 324 if [ ${DRY_RUN} -eq 1 ]; then
 325     notify "[NOTE] Dry run, skipping all deployment tasks" 2
 326     exit 0
 327 elif [ ${USE_EXISTING_INFRA} -gt 0 ]; then
 328     notify "[NOTE] Use existing infra" 2
 329     check_connection
 330 else
 331     prepare_vms "${base_image}" "${STORAGE_DIR}" "${virtual_repos_pkgs}" \
 332       "${virtual_nodes[@]}"
 333     create_networks "${OPNFV_BRIDGES[@]}"
 334     do_sysctl_cfg
 335     create_vms "${STORAGE_DIR}" "${virtual_nodes_data}" "${OPNFV_BRIDGES[@]}"
 336     update_mcpcontrol_network
 337     start_vms "${virtual_nodes[@]}"
 338     check_connection
 339 fi
 340 if [ ${USE_EXISTING_INFRA} -lt 2 ]; then
 341     wait_for 5 "./salt.sh ${STORAGE_DIR}/pod_config.yml ${virtual_nodes[*]}"
 342 fi
 343
 344 # Openstack cluster setup
 345 set +x
 346 if [ ${INFRA_CREATION_ONLY} -eq 1 ] || [ ${NO_DEPLOY_ENVIRONMENT} -eq 1 ]; then
 347     notify "[NOTE] Skip openstack cluster setup" 2
 348 else
 349     for state in "${cluster_states[@]}"; do
 350         notify "[STATE] Applying state: ${state}" 2
 351         # shellcheck disable=SC2086,2029
 352         wait_for 5 "ssh ${SSH_OPTS} ${SSH_SALT} sudo \
 353             CI_DEBUG=$CI_DEBUG ERASE_ENV=$ERASE_ENV \
 354             /root/fuel/mcp/config/states/${state}"
 355     done
 356 fi
 357
 358 ./log.sh "${DEPLOY_LOG}"
 359
 360 popd > /dev/null
 361
 362 #
 363 # END of main
 364 ##############################################################################