-#!/bin/bash
-set -ex
+#!/bin/bash -e
+# shellcheck disable=SC2034,SC2154,SC1090,SC1091,SC2155
##############################################################################
-# Copyright (c) 2017 Ericsson AB, Mirantis Inc. and others.
+# Copyright (c) 2018 Ericsson AB, Mirantis Inc., Enea AB and others.
# jonas.bjurel@ericsson.com
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
-############################################################################
+##############################################################################
# BEGIN of Exit handlers
#
do_exit () {
- clean
- echo "Exiting ..."
+ local RC=$?
+ cleanup_mounts > /dev/null 2>&1
+ if [ ${RC} -eq 0 ]; then
+ notify_n "[OK] MCP: Openstack installation finished succesfully!" 2
+ else
+ notify_n "[ERROR] MCP: Openstack installation threw a fatal error!"
+ fi
}
#
# End of Exit handlers
-############################################################################
+##############################################################################
-############################################################################
+##############################################################################
# BEGIN of usage description
#
usage ()
{
cat << EOF
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-`basename $0`: Deploys the Fuel@OPNFV stack
+$(notify "$(basename "$0"): Deploy the Fuel@OPNFV MCP stack" 3)
-usage: `basename $0` -b base-uri [-B PXE Bridge] [-f] [-F] [-H] -l lab-name -p pod-name -s deploy-scenario [-S image-dir] [-T timeout] -i iso
- -s deployment-scenario [-S optional Deploy-scenario path URI]
- [-R optional local relen repo (containing deployment Scenarios]
+$(notify "USAGE:" 2)
+ $(basename "$0") -l lab-name -p pod-name -s deploy-scenario \\
+ [-b Lab Config Base URI] \\
+ [-S storage-dir] [-L /path/to/log/file.tar.gz] \\
+ [-f[f]] [-F] [-e | -E[E]] [-d] [-D] [-N]
-OPTIONS:
+$(notify "OPTIONS:" 2)
-b Base-uri for the stack-configuration structure
- -B PXE Bridge for booting of Fuel master
-d Dry-run
- -f Deploy on existing Fuel master
+ -D Debug logging
-e Do not launch environment deployment
- -F Do only create a Fuel master
+ -E Remove existing VCP VMs (use twice to redeploy baremetal nodes)
+ -f Deploy on existing Salt master (use twice to also skip config sync)
+ -F Do only create a Salt master
-h Print this message and exit
- -H No health check
-l Lab-name
- -L Deployment log path and file name
-p Pod-name
- -s Deploy-scenario short-name/base-file-name
+ -P Skip installation of package dependencies
+ -s Deploy-scenario short-name
-S Storage dir for VM images
- -T Timeout, in minutes, for the deploy.
- -i iso url
+ -L Deployment log path and file name
+ -N Experimental: Do not virtualize control plane (novcp)
-Description:
-Deploys the Fuel@OPNFV stack on the indicated lab resource
+$(notify_i "Description:" 2)
+Deploys the Fuel@OPNFV stack on the indicated lab resource.
-This script provides the Fuel@OPNFV deployment abstraction
+This script provides the Fuel@OPNFV deployment abstraction.
It depends on the OPNFV official configuration directory/file structure
and provides a fairly simple mechanism to execute a deployment.
-Input parameters to the build script is:
--b Base URI to the configuration directory (needs to be provided in a URI
- style, it can be a local resource: file:// or a remote resource http(s)://)
--B PXE Bridge for booting of Fuel master. It can be specified several times,
- or as a comma separated list of bridges, or both: -B br1 -B br2,br3
- One NIC connected to each specified bridge will be created in the Fuel VM,
- in the same order as provided in the command line. The default is pxebr.
--d Dry-run - Produces deploy config files (config/dea.yaml and
- config/dha.yaml), but does not execute deploy
--f Deploy on existing Fuel master
+
+$(notify_i "Input parameters to the build script are:" 2)
+-b Base URI to the configuration directory (needs to be provided in URI style,
+ it can be a local resource: file:// or a remote resource http(s)://).
+ A POD Descriptor File (PDF) and its Installer Descriptor File (IDF)
+ companion should be available at:
+ <base-uri>/labs/<lab-name>/<pod-name>.yaml
+ <base-uri>/labs/<lab-name>/idf-<pod-name>.yaml
+ The default is using the git submodule tracking 'OPNFV Pharos' in
+ <./mcp/scripts/pharos>.
+ An example config is provided inside current repo in
+ <./mcp/config>, automatically linked as <./mcp/scripts/pharos/labs/local>.
+-d Dry-run - Produce deploy config files, but do not execute deploy
+-D Debug logging - Enable extra logging in sh deploy scripts (set -x)
-e Do not launch environment deployment
--F Do only create a Fuel master
+-E Remove existing VCP VMs. It will destroy and undefine all VCP VMs
+ currently defined on cluster KVM nodes. If specified twice (e.g. -E -E),
+ baremetal nodes (VCP too, implicitly) will be removed, then reprovisioned.
+ Only applicable for baremetal deploys.
+-f Deploy on existing Salt master. It will skip infrastructure VM creation,
+ but it will still sync reclass configuration from current repo to Salt
+ Master node. If specified twice (e.g. -f -f), config sync will also be
+ skipped.
+-F Do only create a Salt master
-h Print this message and exit
--H Do not run fuel built in health-check after successfull deployment
+-L Deployment log path and name, eg. -L /home/jenkins/job.log.tar.gz
-l Lab name as defined in the configuration directory, e.g. lf
--L Deployment log path and name, eg. -L /home/jenkins/logs/job888.log.tar.gz
--p POD name as defined in the configuration directory, e.g. pod-1
--s Deployment-scenario, this points to a deployment/test scenario file as
- defined in the configuration directory:
- e.g fuel-ocl-heat-ceilometer_scenario_0.0.1.yaml
- or a deployment short-name as defined by scenario.yaml in the deployment
- scenario path.
--S Storage dir for VM images, default is fuel/deploy/images
--T Timeout, in minutes, for the deploy. It defaults to using the DEPLOY_TIMEOUT
- environment variable when defined, or to the default in deploy.py otherwise
--i .iso image to be deployed (needs to be provided in a URI
- style, it can be a local resource: file:// or a remote resource http(s)://)
-
-NOTE: Root priviledges are needed for this script to run
-
-
-Examples:
-sudo `basename $0` -b file:///home/jenkins/lab-config -l lf -p pod1 -s ha_odl-l3_heat_ceilometer -i file:///home/jenkins/myiso.iso
+ For the sample configuration in <./mcp/config>, lab name is 'local'.
+-p POD name as defined in the configuration directory, e.g. pod2
+ For the sample configuration in <./mcp/config>, POD name is 'virtual1'
+ for virtual deployments or 'pod1' for baremetal (based on lf-pod2).
+-N Experimental: Instead of virtualizing the control plane (VCP), deploy
+ control plane directly on baremetal nodes
+-P Skip installing dependency distro packages on current host
+ This flag should only be used if you have kept back older packages that
+ would be upgraded and that is undesirable on the current system.
+ Note that without the required packages, deploy will fail.
+-s Deployment-scenario, this points to a short deployment scenario name, which
+ has to be defined in config directory (e.g. os-odl-nofeature-ha).
+-S Storage dir for VM images, default is mcp/deploy/images
+
+$(notify_i "[NOTE] sudo & virsh priviledges are needed for this script to run" 3)
+
+Example:
+
+$(notify_i "sudo $(basename "$0") \\
+ -b file:///home/jenkins/securedlab \\
+ -l lf -p pod2 \\
+ -s os-odl-nofeature-ha" 2)
EOF
}
#
# END of usage description
-############################################################################
+##############################################################################
-############################################################################
-# BEGIN of deployment clean-up
-#
-clean() {
- echo "Cleaning up deploy tmp directories"
- rm -rf ${SCRIPT_PATH}/ISO
-}
+##############################################################################
+# BEGIN of variables to customize
#
-# END of deployment clean-up
-############################################################################
+CI_DEBUG=${CI_DEBUG:-0}; [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
+MCP_REPO_ROOT_PATH=$(readlink -f "$(dirname "${BASH_SOURCE[0]}")/..")
+DEPLOY_DIR=$(cd "${MCP_REPO_ROOT_PATH}/mcp/scripts"; pwd)
+MCP_STORAGE_DIR=$(cd "${MCP_REPO_ROOT_PATH}/mcp/deploy/images"; pwd)
+URI_REGEXP='(file|https?|ftp)://.*'
+BASE_CONFIG_URI="file://${MCP_REPO_ROOT_PATH}/mcp/scripts/pharos"
+
+# Customize deploy workflow
+DRY_RUN=${DRY_RUN:-0}
+USE_EXISTING_PKGS=${USE_EXISTING_PKGS:-0}
+USE_EXISTING_INFRA=${USE_EXISTING_INFRA:-0}
+INFRA_CREATION_ONLY=${INFRA_CREATION_ONLY:-0}
+NO_DEPLOY_ENVIRONMENT=${NO_DEPLOY_ENVIRONMENT:-0}
+ERASE_ENV=${ERASE_ENV:-0}
+MCP_VCP=${MCP_VCP:-1}
+
+source "${DEPLOY_DIR}/globals.sh"
+source "${DEPLOY_DIR}/lib.sh"
+source "${DEPLOY_DIR}/lib_template.sh"
-############################################################################
-# BEGIN of shorthand variables for internal use
-#
-SCRIPT_PATH=$(readlink -f $(dirname ${BASH_SOURCE[0]}))
-DEPLOY_DIR=$(cd ${SCRIPT_PATH}/../mcp/scripts; pwd)
-PXE_BRIDGE=''
-NO_HEALTH_CHECK=''
-USE_EXISTING_FUEL=''
-FUEL_CREATION_ONLY=''
-NO_DEPLOY_ENVIRONMENT=''
-STORAGE_DIR=''
-DRY_RUN=0
-if ! [ -z $DEPLOY_TIMEOUT ]; then
- DEPLOY_TIMEOUT="-dt $DEPLOY_TIMEOUT"
-else
- DEPLOY_TIMEOUT=""
-fi
#
# END of variables to customize
-############################################################################
+##############################################################################
-############################################################################
+##############################################################################
# BEGIN of main
#
-while getopts "b:B:dfFHl:L:p:s:S:T:i:he" OPTION
+set +x
+while getopts "b:dDfEFl:L:Np:Ps:S:he" OPTION
do
case $OPTION in
b)
BASE_CONFIG_URI=${OPTARG}
- if [[ ! $BASE_CONFIG_URI == file://* ]] && \
- [[ ! $BASE_CONFIG_URI == http://* ]] && \
- [[ ! $BASE_CONFIG_URI == https://* ]] && \
- [[ ! $BASE_CONFIG_URI == ftp://* ]]; then
- echo "-b $BASE_CONFIG_URI - Not given in URI style"
+ if [[ ! $BASE_CONFIG_URI =~ ${URI_REGEXP} ]]; then
+ notify "[ERROR] -b $BASE_CONFIG_URI - invalid URI"
usage
exit 1
fi
;;
- B)
- for bridge in ${OPTARG//,/ }; do
- PXE_BRIDGE+=" -b $bridge"
- done
- ;;
d)
DRY_RUN=1
;;
+ D)
+ CI_DEBUG=1
+ ;;
f)
- USE_EXISTING_FUEL='-nf'
+ ((USE_EXISTING_INFRA+=1))
;;
F)
- FUEL_CREATION_ONLY='-fo'
+ INFRA_CREATION_ONLY=1
;;
e)
- NO_DEPLOY_ENVIRONMENT='-nde'
+ NO_DEPLOY_ENVIRONMENT=1
;;
- H)
- NO_HEALTH_CHECK='-nh'
+ E)
+ ((ERASE_ENV+=1))
;;
l)
TARGET_LAB=${OPTARG}
;;
L)
- DEPLOY_LOG="-log ${OPTARG}"
+ DEPLOY_LOG="${OPTARG}"
+ ;;
+ N)
+ MCP_VCP=0
;;
p)
TARGET_POD=${OPTARG}
;;
+ P)
+ USE_EXISTING_PKGS=1
+ ;;
s)
DEPLOY_SCENARIO=${OPTARG}
;;
S)
if [[ ${OPTARG} ]]; then
- STORAGE_DIR="-s ${OPTARG}"
- fi
- ;;
- T)
- DEPLOY_TIMEOUT="-dt ${OPTARG}"
- ;;
- i)
- ISO=${OPTARG}
- if [[ ! $ISO == file://* ]] && \
- [[ ! $ISO == http://* ]] && \
- [[ ! $ISO == https://* ]] && \
- [[ ! $ISO == ftp://* ]]; then
- echo "-i $ISO - Not given in URI style"
- usage
- exit 1
+ MCP_STORAGE_DIR="${OPTARG}"
fi
;;
h)
exit 0
;;
*)
- echo "${OPTION} is not a valid argument"
- echo "Arguments not according to new argument style"
- echo "Trying old-style compatibility mode"
- pushd ${DEPLOY_DIR} > /dev/null
- python deploy.py "$@"
- popd > /dev/null
- exit 0
+ notify_e "[ERROR] Unsupported arg, see -h for help"
;;
esac
done
-if [[ $EUID -ne 0 ]]; then
- echo "This script must be run as root" 1>&2
- exit 1
+if [[ "$(sudo whoami)" != 'root' ]]; then
+ notify_e "[ERROR] This script requires sudo rights"
+fi
+
+# Validate mandatory arguments are set
+if [ -z "${TARGET_LAB}" ] || [ -z "${TARGET_POD}" ] || \
+ [ -z "${DEPLOY_SCENARIO}" ]; then
+ usage
+ notify_e "[ERROR] At least one of the mandatory args is missing!"
fi
+[[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
+
# Enable the automatic exit trap
trap do_exit SIGINT SIGTERM EXIT
-# Set no restrictive umask so that Jenkins can removeeee any residuals
+# Set no restrictive umask so that Jenkins can remove any residuals
umask 0000
-clean
-
-pushd ${DEPLOY_DIR} > /dev/null
+pushd "${DEPLOY_DIR}" > /dev/null
# Prepare the deploy config files based on lab/pod information, deployment
# scenario, etc.
-# Install required packages
-[ -n "$(command -v apt-get)" ] && apt-get install -y mkisofs curl virtinst cpu-checker qemu-kvm
-[ -n "$(command -v yum)" ] && yum install -y genisoimage curl virt-install qemu-kvm
+# Install required packages on jump server
+if [ ${USE_EXISTING_PKGS} -eq 1 ]; then
+ notify "[NOTE] Skipping distro pkg installation" 2
+else
+ notify "[NOTE] Installing required distro pkgs" 2
+ jumpserver_pkg_install
+fi
-# Check scenario file existence
-if [[ ! -f ../config/${DEPLOY_SCENARIO}.yaml ]]; then
- echo "[WARN] ${DEPLOY_SCENARIO}.yaml not found, setting simplest scenario"
- DEPLOY_SCENARIO='os-nosdn-nofeature-noha'
+if ! virsh list >/dev/null 2>&1; then
+ notify_e "[ERROR] This script requires hypervisor access"
fi
-# Get required infra deployment data
-source lib.sh
-eval $(parse_yaml ../config/defaults.yaml)
-eval $(parse_yaml ../config/${DEPLOY_SCENARIO}.yaml)
+# Collect jump server system information for deploy debugging
+./sysinfo_print.sh
-declare -A virtual_nodes_ram
-for node in "${virtual_nodes[@]}"; do
- virtual_custom_ram="virtual_${node}_ram"
- virtual_nodes_ram[$node]=${!virtual_custom_ram:-$virtual_default_ram}
-done
+# Clone git submodules and apply our patches
+make -C "${MCP_REPO_ROOT_PATH}/mcp/patches" deepclean patches-import
-export CLUSTER_DOMAIN=$cluster_domain
-export SSH_KEY=${SSH_KEY:-mcp.rsa}
-export SALT_MASTER=${SALT_MASTER_IP:-192.168.10.100}
-export SSH_OPTS="-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -i ${SSH_KEY}"
+# Check scenario file existence
+SCENARIO_DIR="$(readlink -f "../config/scenario")"
+if [ ! -f "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml" ] && \
+ [ ! -f "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml.j2" ]; then
+ notify_e "[ERROR] Scenario definition file is missing!"
+fi
-# Infra setup
+# key might not exist yet ...
generate_ssh_key
-prepare_vms virtual_nodes $base_image
-create_networks
-create_vms virtual_nodes virtual_nodes_ram
-update_pxe_network
-start_vms virtual_nodes
-check_connection
+export MAAS_SSH_KEY="$(cat "$(basename "${SSH_KEY}").pub")"
+
+MCP_DPDK_MODE=$([[ "$DEPLOY_SCENARIO" =~ ovs ]] && echo 1 || echo 0)
+# Expand jinja2 templates based on PDF data and env vars
+export MCP_REPO_ROOT_PATH MCP_VCP MCP_DPDK_MODE MCP_STORAGE_DIR \
+ MCP_JUMP_ARCH=$(uname -i)
+do_templates_scenario "${MCP_STORAGE_DIR}" "${TARGET_LAB}" "${TARGET_POD}" \
+ "${BASE_CONFIG_URI}" "${SCENARIO_DIR}"
+do_templates_cluster "${MCP_STORAGE_DIR}" "${TARGET_LAB}" "${TARGET_POD}" \
+ "${MCP_REPO_ROOT_PATH}" \
+ "${SCENARIO_DIR}/defaults.yaml" \
+ "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml"
-./salt.sh
+# Determine additional data (e.g. jump bridge names) based on XDF
+source "${DEPLOY_DIR}/xdf_data.sh"
+
+# Jumpserver prerequisites check
+notify "[NOTE] Using bridges: ${OPNFV_BRIDGES[*]}" 2
+jumpserver_check_requirements "${virtual_nodes[*]}" "${OPNFV_BRIDGES[@]}"
+
+# Infra setup
+if [ ${DRY_RUN} -eq 1 ]; then
+ notify "[NOTE] Dry run, skipping all deployment tasks" 2
+ exit 0
+elif [ ${USE_EXISTING_INFRA} -gt 0 ]; then
+ notify "[NOTE] Use existing infra" 2
+ check_connection
+else
+ prepare_vms "${base_image}" "${MCP_STORAGE_DIR}" "${virtual_repos_pkgs}" \
+ "${virtual_nodes[@]}"
+ create_networks "${OPNFV_BRIDGES[@]}"
+ do_sysctl_cfg
+ do_udev_cfg
+ create_vms "${MCP_STORAGE_DIR}" "${virtual_nodes_data}" "${OPNFV_BRIDGES[@]}"
+ update_mcpcontrol_network
+ start_vms "${virtual_nodes[@]}"
+ check_connection
+fi
+if [ ${USE_EXISTING_INFRA} -lt 2 ]; then
+ wait_for 5 "./salt.sh ${MCP_STORAGE_DIR}/pod_config.yml ${virtual_nodes[*]}"
+fi
# Openstack cluster setup
-for state in "${cluster_states[@]}"; do
- echo "STATE: $state"
- ssh ${SSH_OPTS} ubuntu@${SALT_MASTER} sudo /root/fuel/mcp/config/states/$state
-done
+set +x
+if [ ${INFRA_CREATION_ONLY} -eq 1 ] || [ ${NO_DEPLOY_ENVIRONMENT} -eq 1 ]; then
+ notify "[NOTE] Skip openstack cluster setup" 2
+else
+ for state in "${cluster_states[@]}"; do
+ notify "[STATE] Applying state: ${state}" 2
+ # shellcheck disable=SC2086,2029
+ wait_for 5 "ssh ${SSH_OPTS} ${SSH_SALT} sudo \
+ CI_DEBUG=$CI_DEBUG ERASE_ENV=$ERASE_ENV \
+ /root/fuel/mcp/config/states/${state}"
+ if [ "${state}" = 'maas' ]; then
+ # For hybrid PODs (virtual + baremetal nodes), the virtual nodes
+ # should be reset to force a DHCP request from MaaS DHCP
+ reset_vms "${virtual_nodes[@]}"
+ fi
+ done
+fi
+
+./log.sh "${DEPLOY_LOG}"
-## Disable Fuel deployment engine
-#
-# echo "python deploy-config.py -dha ${BASE_CONFIG_URI}/labs/${TARGET_LAB}/${TARGET_POD}/fuel/config/dha.yaml -deab file://${DEPLOY_DIR}/config/dea_base.yaml -deao ${BASE_CONFIG_URI}/labs/${TARGET_LAB}/${TARGET_POD}/fuel/config/dea-pod-override.yaml -scenario-base-uri file://${DEPLOY_DIR}/scenario -scenario ${DEPLOY_SCENARIO} -plugins file://${DEPLOY_DIR}/config/plugins -output ${SCRIPT_PATH}/config"
-#
-# python deploy-config.py -dha ${BASE_CONFIG_URI}/labs/${TARGET_LAB}/${TARGET_POD}/fuel/config/dha.yaml -deab file://${DEPLOY_DIR}/config/dea_base.yaml -deao ${BASE_CONFIG_URI}/labs/${TARGET_LAB}/${TARGET_POD}/fuel/config/dea-pod-override.yaml -scenario-base-uri file://${DEPLOY_DIR}/scenario -scenario ${DEPLOY_SCENARIO} -plugins file://${DEPLOY_DIR}/config/plugins -output ${SCRIPT_PATH}/config
-#
-# if [ $DRY_RUN -eq 0 ]; then
-# # Download iso if it doesn't already exists locally
-# if [[ $ISO == file://* ]]; then
-# ISO=${ISO#file://}
-# else
-# mkdir -p ${SCRIPT_PATH}/ISO
-# curl -o ${SCRIPT_PATH}/ISO/image.iso $ISO
-# ISO=${SCRIPT_PATH}/ISO/image.iso
-# fi
-# # Start deployment
-# echo "python deploy.py $DEPLOY_LOG $STORAGE_DIR $PXE_BRIDGE $USE_EXISTING_FUEL $FUEL_CREATION_ONLY $NO_HEALTH_CHECK $NO_DEPLOY_ENVIRONMENT -dea ${SCRIPT_PATH}/config/dea.yaml -dha ${SCRIPT_PATH}/config/dha.yaml -iso $ISO $DEPLOY_TIMEOUT"
-# python deploy.py $DEPLOY_LOG $STORAGE_DIR $PXE_BRIDGE $USE_EXISTING_FUEL $FUEL_CREATION_ONLY $NO_HEALTH_CHECK $NO_DEPLOY_ENVIRONMENT -dea ${SCRIPT_PATH}/config/dea.yaml -dha ${SCRIPT_PATH}/config/dha.yaml -iso $ISO $DEPLOY_TIMEOUT
-# fi
popd > /dev/null
#
# END of main
-############################################################################
+##############################################################################