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 ##############################################################################
12 ##############################################################################
13 # BEGIN of Exit handlers
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
21 notify "\n[ERROR] MCP: Openstack installation threw a fatal error!\n\n"
25 # End of Exit handlers
26 ##############################################################################
28 ##############################################################################
29 # BEGIN of usage description
34 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
35 $(notify "$(basename "$0"): Deploy the Fuel@OPNFV MCP stack" 3)
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]
43 $(notify "OPTIONS:" 2)
44 -b Base-uri for the stack-configuration structure
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
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
59 $(notify "Description:" 2)
60 Deploys the Fuel@OPNFV stack on the indicated lab resource.
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.
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 An example config is provided inside current repo in
75 The default is using the git submodule tracking 'OPNFV Pharos' in
76 <./mcp/scripts/pharos>.
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
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
101 $(notify "[NOTE] sudo & virsh priviledges are needed for this script to run" 3)
105 $(notify "sudo $(basename "$0") \\
106 -b file:///home/jenkins/securedlab \\
108 -s os-odl-nofeature-ha" 2)
113 # END of usage description
114 ##############################################################################
116 ##############################################################################
117 # BEGIN of colored notification wrapper
120 tput setaf "${2:-1}" || true
121 echo -en "${1:-"[WARN] Unsupported opt arg: $3\\n"}"
125 # END of colored notification wrapper
126 ##############################################################################
128 ##############################################################################
129 # BEGIN of variables to customize
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"
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}
150 source "${DEPLOY_DIR}/globals.sh"
151 source "${DEPLOY_DIR}/lib.sh"
154 # END of variables to customize
155 ##############################################################################
157 ##############################################################################
161 while getopts "b:dDfEFl:L:p:Ps:S:he" OPTION
165 BASE_CONFIG_URI=${OPTARG}
166 if [[ ! $BASE_CONFIG_URI =~ ${URI_REGEXP} ]]; then
167 notify "[ERROR] -b $BASE_CONFIG_URI - invalid URI\n"
179 ((USE_EXISTING_INFRA+=1))
182 INFRA_CREATION_ONLY=1
185 NO_DEPLOY_ENVIRONMENT=1
194 DEPLOY_LOG="${OPTARG}"
198 if [[ "${TARGET_POD}" =~ "virtual" ]]; then
199 DEPLOY_TYPE='virtual'
206 DEPLOY_SCENARIO=${OPTARG}
209 if [[ ${OPTARG} ]]; then
210 STORAGE_DIR="${OPTARG}"
218 notify "[ERROR] Arguments not according to new argument style\n"
224 if [[ "$(sudo whoami)" != 'root' ]]; then
225 notify "[ERROR] This script requires sudo rights\n" 1>&2
229 # Validate mandatory arguments are set
230 if [ -z "${TARGET_LAB}" ] || [ -z "${TARGET_POD}" ] || \
231 [ -z "${DEPLOY_SCENARIO}" ]; then
232 notify "[ERROR] At least one of the mandatory args is missing!\n" 1>&2
237 [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
239 # Enable the automatic exit trap
240 trap do_exit SIGINT SIGTERM EXIT
242 # Set no restrictive umask so that Jenkins can remove any residuals
245 pushd "${DEPLOY_DIR}" > /dev/null
246 # Prepare the deploy config files based on lab/pod information, deployment
249 # Install required packages on jump server
250 if [ ${USE_EXISTING_PKGS} -eq 1 ]; then
251 notify "[NOTE] Skipping distro pkg installation\n" 2 1>&2
253 notify "[NOTE] Installing required distro pkgs\n" 2 1>&2
254 if [ -n "$(command -v apt-get)" ]; then
255 pkg_type='deb'; pkg_cmd='sudo apt-get install -y'
257 pkg_type='rpm'; pkg_cmd='sudo yum install -y --skip-broken'
259 eval "$(parse_yaml "./requirements_${pkg_type}.yaml")"
260 for section in 'common' "${DEPLOY_TYPE}" "$(uname -m)"; do
261 section_var="requirements_pkg_${section}[*]"
262 pkg_list+=" ${!section_var}"
264 # shellcheck disable=SC2086
265 ${pkg_cmd} ${pkg_list}
268 if ! virsh list >/dev/null 2>&1; then
269 notify "[ERROR] This script requires hypervisor access\n" 1>&2
273 # Collect jump server system information for deploy debugging
276 # Clone git submodules and apply our patches
277 make -C "${REPO_ROOT_PATH}/mcp/patches" deepclean patches-import
279 # Convert Pharos-compatible POD Descriptor File (PDF) to reclass model input
280 PHAROS_GEN_CONFIG_SCRIPT="./pharos/config/utils/generate_config.py"
281 PHAROS_INSTALLER_ADAPTER="./pharos/config/installers/fuel/pod_config.yml.j2"
282 BASE_CONFIG_PDF="${BASE_CONFIG_URI}/labs/${TARGET_LAB}/${TARGET_POD}.yaml"
283 BASE_CONFIG_IDF="${BASE_CONFIG_URI}/labs/${TARGET_LAB}/idf-${TARGET_POD}.yaml"
284 LOCAL_PDF="${STORAGE_DIR}/$(basename "${BASE_CONFIG_PDF}")"
285 LOCAL_IDF="${STORAGE_DIR}/$(basename "${BASE_CONFIG_IDF}")"
286 LOCAL_PDF_RECLASS="${STORAGE_DIR}/pod_config.yml"
287 rm -f "${LOCAL_PDF_RECLASS}"
288 if ! curl --create-dirs -o "${LOCAL_PDF}" "${BASE_CONFIG_PDF}"; then
289 if [ "${DEPLOY_TYPE}" = 'baremetal' ]; then
290 notify "[ERROR] Could not retrieve PDF (Pod Descriptor File)!\n" 1>&2
293 notify "[WARN] Could not retrieve PDF (Pod Descriptor File)!\n" 3
295 elif ! curl -o "${LOCAL_IDF}" "${BASE_CONFIG_IDF}"; then
296 notify "[WARN] POD has no IDF (Installer Descriptor File)!\n" 3
297 elif ! "${PHAROS_GEN_CONFIG_SCRIPT}" -y "${LOCAL_PDF}" \
298 -j "${PHAROS_INSTALLER_ADAPTER}" > "${LOCAL_PDF_RECLASS}"; then
299 notify "[ERROR] Could not convert PDF to reclass model input!\n" 1>&2
303 # Check scenario file existence
304 SCENARIO_DIR="../config/scenario"
305 if [ ! -f "${SCENARIO_DIR}/${DEPLOY_TYPE}/${DEPLOY_SCENARIO}.yaml" ]; then
306 notify "[ERROR] Scenario definition file is missing!\n" 1>&2
310 # Check defaults file existence
311 if [ ! -f "${SCENARIO_DIR}/defaults-$(uname -i).yaml" ]; then
312 notify "[ERROR] Scenario defaults file is missing!\n" 1>&2
316 # Get required infra deployment data
318 eval "$(parse_yaml "${SCENARIO_DIR}/defaults-$(uname -i).yaml")"
319 eval "$(parse_yaml "${SCENARIO_DIR}/${DEPLOY_TYPE}/${DEPLOY_SCENARIO}.yaml")"
320 eval "$(parse_yaml "${LOCAL_PDF_RECLASS}")"
321 [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
323 export CLUSTER_DOMAIN=${cluster_domain}
325 # Serialize vnode data as '<name0>,<ram0>,<vcpu0>|<name1>,<ram1>,<vcpu1>[...]'
326 for node in "${virtual_nodes[@]}"; do
327 virtual_custom_ram="virtual_${node}_ram"
328 virtual_custom_vcpus="virtual_${node}_vcpus"
329 virtual_nodes_data+="${node},"
330 virtual_nodes_data+="${!virtual_custom_ram:-$virtual_default_ram},"
331 virtual_nodes_data+="${!virtual_custom_vcpus:-$virtual_default_vcpus}|"
333 virtual_nodes_data=${virtual_nodes_data%|}
335 # Serialize repos, packages to (pre-)install/remove for:
336 # - foundation node VM base image (virtual: all VMs, baremetal: cfg01|mas01)
337 # - virtualized control plane VM base image (only when VCP is used)
338 base_image_flavors=common
339 if [[ "${cluster_states[*]}" =~ virtual_control ]]; then
340 base_image_flavors+=" control"
342 for sc in ${base_image_flavors}; do
343 for va in apt_keys apt_repos pkg_install pkg_remove; do
344 key=virtual_${sc}_${va}
345 eval "${key}=\${${key}[@]// /|}"
346 eval "${key}=\${${key}// /,}"
347 virtual_repos_pkgs+="${!key}^"
350 virtual_repos_pkgs=${virtual_repos_pkgs%^}
352 # Expand reclass and virsh network templates
353 for tp in "${RECLASS_CLUSTER_DIR}/all-mcp-arch-common/opnfv/"*.template \
357 EOF" 2> /dev/null > "${tp%.template}"
360 # Convert Pharos-compatible PDF to reclass network definitions
361 if [ "${DEPLOY_TYPE}" = 'baremetal' ]; then
362 find "${RECLASS_CLUSTER_DIR}" -name '*.j2' | while read -r tp
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"
372 # Determine 'admin', 'mgmt', 'private' and 'public' bridge names based on IDF
373 for ((i = 0; i < ${#BR_NAMES[@]}; i++)); do
374 br_jump=$(eval echo "\$parameters__param_opnfv_jump_bridge_${BR_NAMES[i]}")
375 if [ -n "${br_jump}" ] && [ "${br_jump}" != 'None' ]; then
376 OPNFV_BRIDGES[${i}]="${br_jump}"
379 notify "[NOTE] Using bridges: ${OPNFV_BRIDGES[*]}\n" 2
382 if [ ${DRY_RUN} -eq 1 ]; then
383 notify "[NOTE] Dry run, skipping all deployment tasks\n" 2 1>&2
385 elif [ ${USE_EXISTING_INFRA} -gt 0 ]; then
386 notify "[NOTE] Use existing infra\n" 2 1>&2
390 prepare_vms "${base_image}" "${STORAGE_DIR}" "${virtual_repos_pkgs}" \
391 "${virtual_nodes[@]}"
392 create_networks "${OPNFV_BRIDGES[@]}"
394 create_vms "${STORAGE_DIR}" "${virtual_nodes_data}" "${OPNFV_BRIDGES[@]}"
395 update_mcpcontrol_network
396 start_vms "${virtual_nodes[@]}"
399 if [ ${USE_EXISTING_INFRA} -lt 2 ]; then
400 wait_for 5 "./salt.sh ${LOCAL_PDF_RECLASS}"
403 # Openstack cluster setup
405 if [ ${INFRA_CREATION_ONLY} -eq 1 ] || [ ${NO_DEPLOY_ENVIRONMENT} -eq 1 ]; then
406 notify "[NOTE] Skip openstack cluster setup\n" 2
408 for state in "${cluster_states[@]}"; do
409 notify "[STATE] Applying state: ${state}\n" 2
410 # shellcheck disable=SC2086,2029
411 wait_for 5 "ssh ${SSH_OPTS} ${SSH_SALT} sudo \
412 CI_DEBUG=$CI_DEBUG ERASE_ENV=$ERASE_ENV \
413 /root/fuel/mcp/config/states/${state}"
417 ./log.sh "${DEPLOY_LOG}"
423 ##############################################################################