2 # shellcheck disable=SC2034,SC2154,SC1090,SC1091,SC2155
3 ##############################################################################
4 # Copyright (c) 2018 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!" 2
21 notify_n "[ERROR] MCP: Openstack installation threw a fatal error!"
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] [-N]
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
58 -N Experimental: Do not virtualize control plane (novcp)
60 $(notify_i "Description:" 2)
61 Deploys the Fuel@OPNFV stack on the indicated lab resource.
63 This script provides the Fuel@OPNFV deployment abstraction.
64 It depends on the OPNFV official configuration directory/file structure
65 and provides a fairly simple mechanism to execute a deployment.
67 $(notify_i "Input parameters to the build script are:" 2)
68 -b Base URI to the configuration directory (needs to be provided in URI style,
69 it can be a local resource: file:// or a remote resource http(s)://).
70 A POD Descriptor File (PDF) and its Installer Descriptor File (IDF)
71 companion should be available at:
72 <base-uri>/labs/<lab-name>/<pod-name>.yaml
73 <base-uri>/labs/<lab-name>/idf-<pod-name>.yaml
74 The default is using the git submodule tracking 'OPNFV Pharos' in
75 <./mcp/scripts/pharos>.
76 An example config is provided inside current repo in
77 <./mcp/config>, automatically linked as <./mcp/scripts/pharos/labs/local>.
78 -d Dry-run - Produce deploy config files, but do not execute deploy
79 -D Debug logging - Enable extra logging in sh deploy scripts (set -x)
80 -e Do not launch environment deployment
81 -E Remove existing VCP VMs. It will destroy and undefine all VCP VMs
82 currently defined on cluster KVM nodes. If specified twice (e.g. -E -E),
83 baremetal nodes (VCP too, implicitly) will be removed, then reprovisioned.
84 Only applicable for baremetal deploys.
85 -f Deploy on existing Salt master. It will skip infrastructure VM creation,
86 but it will still sync reclass configuration from current repo to Salt
87 Master node. If specified twice (e.g. -f -f), config sync will also be
89 -F Do only create a Salt master
90 -h Print this message and exit
91 -L Deployment log path and name, eg. -L /home/jenkins/job.log.tar.gz
92 -l Lab name as defined in the configuration directory, e.g. lf
93 -p POD name as defined in the configuration directory, e.g. pod2
94 -N Experimental: Instead of virtualizing the control plane (VCP), deploy
95 control plane directly on baremetal nodes
96 -P Skip installing dependency distro packages on current host
97 This flag should only be used if you have kept back older packages that
98 would be upgraded and that is undesirable on the current system.
99 Note that without the required packages, deploy will fail.
100 -s Deployment-scenario, this points to a short deployment scenario name, which
101 has to be defined in config directory (e.g. os-odl-nofeature-ha).
102 -S Storage dir for VM images, default is mcp/deploy/images
104 $(notify_i "[NOTE] sudo & virsh priviledges are needed for this script to run" 3)
108 $(notify_i "sudo $(basename "$0") \\
109 -b file:///home/jenkins/securedlab \\
111 -s os-odl-nofeature-ha" 2)
116 # END of usage description
117 ##############################################################################
119 ##############################################################################
120 # BEGIN of variables to customize
122 CI_DEBUG=${CI_DEBUG:-0}; [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
123 REPO_ROOT_PATH=$(readlink -f "$(dirname "${BASH_SOURCE[0]}")/..")
124 DEPLOY_DIR=$(cd "${REPO_ROOT_PATH}/mcp/scripts"; pwd)
125 STORAGE_DIR=$(cd "${REPO_ROOT_PATH}/mcp/deploy/images"; pwd)
126 URI_REGEXP='(file|https?|ftp)://.*'
127 BASE_CONFIG_URI="file://${REPO_ROOT_PATH}/mcp/scripts/pharos"
129 # Customize deploy workflow
130 DRY_RUN=${DRY_RUN:-0}
131 USE_EXISTING_PKGS=${USE_EXISTING_PKGS:-0}
132 USE_EXISTING_INFRA=${USE_EXISTING_INFRA:-0}
133 INFRA_CREATION_ONLY=${INFRA_CREATION_ONLY:-0}
134 NO_DEPLOY_ENVIRONMENT=${NO_DEPLOY_ENVIRONMENT:-0}
135 ERASE_ENV=${ERASE_ENV:-0}
136 MCP_VCP=${MCP_VCP:-1}
138 source "${DEPLOY_DIR}/globals.sh"
139 source "${DEPLOY_DIR}/lib.sh"
140 source "${DEPLOY_DIR}/lib_template.sh"
143 # END of variables to customize
144 ##############################################################################
146 ##############################################################################
150 while getopts "b:dDfEFl:L:Np:Ps:S:he" OPTION
154 BASE_CONFIG_URI=${OPTARG}
155 if [[ ! $BASE_CONFIG_URI =~ ${URI_REGEXP} ]]; then
156 notify "[ERROR] -b $BASE_CONFIG_URI - invalid URI"
168 ((USE_EXISTING_INFRA+=1))
171 INFRA_CREATION_ONLY=1
174 NO_DEPLOY_ENVIRONMENT=1
183 DEPLOY_LOG="${OPTARG}"
190 if [[ "${TARGET_POD}" =~ virtual ]]; then
191 # All vPODs will use 'local-virtual1' PDF/IDF for now
193 TARGET_POD='virtual1'
200 DEPLOY_SCENARIO=${OPTARG}
203 if [[ ${OPTARG} ]]; then
204 STORAGE_DIR="${OPTARG}"
212 notify_e "[ERROR] Unsupported arg, see -h for help"
217 if [[ "$(sudo whoami)" != 'root' ]]; then
218 notify_e "[ERROR] This script requires sudo rights"
221 # Validate mandatory arguments are set
222 if [ -z "${TARGET_LAB}" ] || [ -z "${TARGET_POD}" ] || \
223 [ -z "${DEPLOY_SCENARIO}" ]; then
225 notify_e "[ERROR] At least one of the mandatory args is missing!"
228 [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
230 # Enable the automatic exit trap
231 trap do_exit SIGINT SIGTERM EXIT
233 # Set no restrictive umask so that Jenkins can remove any residuals
236 pushd "${DEPLOY_DIR}" > /dev/null
237 # Prepare the deploy config files based on lab/pod information, deployment
240 # Install required packages on jump server
241 if [ ${USE_EXISTING_PKGS} -eq 1 ]; then
242 notify "[NOTE] Skipping distro pkg installation" 2
244 notify "[NOTE] Installing required distro pkgs" 2
245 jumpserver_pkg_install
248 if ! virsh list >/dev/null 2>&1; then
249 notify_e "[ERROR] This script requires hypervisor access"
252 # Collect jump server system information for deploy debugging
255 # Clone git submodules and apply our patches
256 make -C "${REPO_ROOT_PATH}/mcp/patches" deepclean patches-import
258 # Check scenario file existence
259 SCENARIO_DIR="$(readlink -f "../config/scenario")"
260 if [ ! -f "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml" ] && \
261 [ ! -f "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml.j2" ]; then
262 notify_e "[ERROR] Scenario definition file is missing!"
265 # key might not exist yet ...
267 export MAAS_SSH_KEY="$(cat "$(basename "${SSH_KEY}").pub")"
269 # Expand jinja2 templates based on PDF data and env vars
270 export MCP_VCP MCP_JUMP_ARCH=$(uname -i)
271 do_templates_scenario "${STORAGE_DIR}" "${TARGET_LAB}" "${TARGET_POD}" \
272 "${BASE_CONFIG_URI}" "${SCENARIO_DIR}"
273 do_templates_cluster "${STORAGE_DIR}" "${TARGET_LAB}" "${TARGET_POD}" \
274 "${REPO_ROOT_PATH}" \
275 "${SCENARIO_DIR}/defaults.yaml" \
276 "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml"
278 # Determine additional data (e.g. jump bridge names) based on XDF
279 source "${DEPLOY_DIR}/xdf_data.sh"
281 # Jumpserver prerequisites check
282 notify "[NOTE] Using bridges: ${OPNFV_BRIDGES[*]}" 2
283 jumpserver_check_requirements "${virtual_nodes[*]}" "${OPNFV_BRIDGES[@]}"
286 if [ ${DRY_RUN} -eq 1 ]; then
287 notify "[NOTE] Dry run, skipping all deployment tasks" 2
289 elif [ ${USE_EXISTING_INFRA} -gt 0 ]; then
290 notify "[NOTE] Use existing infra" 2
293 prepare_vms "${base_image}" "${STORAGE_DIR}" "${virtual_repos_pkgs}" \
294 "${virtual_nodes[@]}"
295 create_networks "${OPNFV_BRIDGES[@]}"
297 create_vms "${STORAGE_DIR}" "${virtual_nodes_data}" "${OPNFV_BRIDGES[@]}"
298 update_mcpcontrol_network
299 start_vms "${virtual_nodes[@]}"
302 if [ ${USE_EXISTING_INFRA} -lt 2 ]; then
303 wait_for 5 "./salt.sh ${STORAGE_DIR}/pod_config.yml ${virtual_nodes[*]}"
306 # Openstack cluster setup
308 if [ ${INFRA_CREATION_ONLY} -eq 1 ] || [ ${NO_DEPLOY_ENVIRONMENT} -eq 1 ]; then
309 notify "[NOTE] Skip openstack cluster setup" 2
311 for state in "${cluster_states[@]}"; do
312 notify "[STATE] Applying state: ${state}" 2
313 # shellcheck disable=SC2086,2029
314 wait_for 5 "ssh ${SSH_OPTS} ${SSH_SALT} sudo \
315 CI_DEBUG=$CI_DEBUG ERASE_ENV=$ERASE_ENV \
316 /root/fuel/mcp/config/states/${state}"
320 ./log.sh "${DEPLOY_LOG}"
326 ##############################################################################