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] [-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 or more to skip states)
50 -F Same as -e, do not launch environment deployment (legacy option)
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 and other deploy artifacts
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
88 Each additional use skips one more state file. For example, -fff would
89 skip the first 3 state files (e.g. virtual_init, maas, baremetal_init).
90 -F Same as -e, do not launch environment deployment (legacy option)
91 -h Print this message and exit
92 -L Deployment log path and name, eg. -L /home/jenkins/job.log.tar.gz
93 -l Lab name as defined in the configuration directory, e.g. lf
94 For the sample configuration in <./mcp/config>, lab name is 'local'.
95 -p POD name as defined in the configuration directory, e.g. pod2
96 For the sample configuration in <./mcp/config>, POD name is 'virtual1'
97 for virtual deployments or 'pod1' for baremetal (based on lf-pod2).
98 -N Experimental: Instead of virtualizing the control plane (VCP), deploy
99 control plane directly on baremetal nodes
100 -P Skip installing dependency distro packages on current host
101 This flag should only be used if you have kept back older packages that
102 would be upgraded and that is undesirable on the current system.
103 Note that without the required packages, deploy will fail.
104 -s Deployment-scenario, this points to a short deployment scenario name, which
105 has to be defined in config directory (e.g. os-odl-nofeature-ha).
106 -S Storage dir for VM images, default is mcp/deploy/images
108 $(notify_i "[NOTE] sudo & virsh priviledges are needed for this script to run" 3)
112 $(notify_i "sudo $(basename "$0") \\
113 -b file:///home/jenkins/securedlab \\
115 -s os-odl-nofeature-ha" 2)
120 # END of usage description
121 ##############################################################################
123 ##############################################################################
124 # BEGIN of variables to customize
126 CI_DEBUG=${CI_DEBUG:-0}; [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
127 MCP_REPO_ROOT_PATH=$(readlink -f "$(dirname "${BASH_SOURCE[0]}")/..")
128 DEPLOY_DIR=$(cd "${MCP_REPO_ROOT_PATH}/mcp/scripts"; pwd)
129 MCP_STORAGE_DIR=$(cd "${MCP_REPO_ROOT_PATH}/mcp/deploy/images"; pwd)
130 URI_REGEXP='(file|https?|ftp)://.*'
131 BASE_CONFIG_URI="file://${MCP_REPO_ROOT_PATH}/mcp/scripts/pharos"
133 # Customize deploy workflow
134 DRY_RUN=${DRY_RUN:-0}
135 USE_EXISTING_PKGS=${USE_EXISTING_PKGS:-0}
136 USE_EXISTING_INFRA=${USE_EXISTING_INFRA:-0}
137 NO_DEPLOY_ENVIRONMENT=${NO_DEPLOY_ENVIRONMENT:-0}
138 ERASE_ENV=${ERASE_ENV:-0}
139 MCP_VCP=${MCP_VCP:-1}
141 source "${DEPLOY_DIR}/globals.sh"
142 source "${DEPLOY_DIR}/lib.sh"
143 source "${DEPLOY_DIR}/lib_template.sh"
146 # END of variables to customize
147 ##############################################################################
149 ##############################################################################
153 while getopts "b:dDfEFl:L:Np:Ps:S:he" OPTION
157 BASE_CONFIG_URI=${OPTARG}
158 if [[ ! $BASE_CONFIG_URI =~ ${URI_REGEXP} ]]; then
159 notify "[ERROR] -b $BASE_CONFIG_URI - invalid URI"
171 ((USE_EXISTING_INFRA+=1))
174 NO_DEPLOY_ENVIRONMENT=1
183 DEPLOY_LOG="${OPTARG}"
195 DEPLOY_SCENARIO=${OPTARG}
198 if [[ ${OPTARG} ]]; then
199 MCP_STORAGE_DIR="${OPTARG}"
207 notify_e "[ERROR] Unsupported arg, see -h for help"
212 if [[ "$(sudo whoami)" != 'root' ]]; then
213 notify_e "[ERROR] This script requires sudo rights"
216 # Validate mandatory arguments are set
217 if [ -z "${TARGET_LAB}" ] || [ -z "${TARGET_POD}" ] || \
218 [ -z "${DEPLOY_SCENARIO}" ]; then
220 notify_e "[ERROR] At least one of the mandatory args is missing!"
223 [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
225 # Enable the automatic exit trap
226 trap do_exit SIGINT SIGTERM EXIT
228 # Set no restrictive umask so that Jenkins can remove any residuals
231 pushd "${DEPLOY_DIR}" > /dev/null
232 # Prepare the deploy config files based on lab/pod information, deployment
235 # Install required packages on jump server
236 if [ ${USE_EXISTING_PKGS} -eq 1 ]; then
237 notify "[NOTE] Skipping distro pkg installation" 2
239 notify "[NOTE] Installing required distro pkgs" 2
240 jumpserver_pkg_install 'deploy'
241 docker_install "${MCP_STORAGE_DIR}"
244 if ! virsh list >/dev/null 2>&1; then
245 notify_e "[ERROR] This script requires hypervisor access"
248 # Collect jump server system information for deploy debugging
251 # Clone git submodules and apply our patches
252 make -C "${MCP_REPO_ROOT_PATH}/mcp/patches" deepclean patches-import
254 # Check scenario file existence
255 SCENARIO_DIR="$(readlink -f "../config/scenario")"
256 if [ ! -f "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml" ] && \
257 [ ! -f "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml.j2" ]; then
258 notify_e "[ERROR] Scenario definition file is missing!"
261 # key might not exist yet ...
263 export MAAS_SSH_KEY="$(cat "$(basename "${SSH_KEY}").pub")"
265 MCP_DPDK_MODE=$([[ "$DEPLOY_SCENARIO" =~ ovs ]] && echo 1 || echo 0)
266 # Expand jinja2 templates based on PDF data and env vars
267 export MCP_REPO_ROOT_PATH MCP_VCP MCP_DPDK_MODE MCP_STORAGE_DIR \
268 MCP_JUMP_ARCH=$(uname -i)
269 do_templates_scenario "${MCP_STORAGE_DIR}" "${TARGET_LAB}" "${TARGET_POD}" \
270 "${BASE_CONFIG_URI}" "${SCENARIO_DIR}"
271 do_templates_cluster "${MCP_STORAGE_DIR}" "${TARGET_LAB}" "${TARGET_POD}" \
272 "${MCP_REPO_ROOT_PATH}" \
273 "${SCENARIO_DIR}/defaults.yaml" \
274 "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml"
276 # Determine additional data (e.g. jump bridge names) based on XDF
277 source "${DEPLOY_DIR}/xdf_data.sh"
279 # Jumpserver prerequisites check
280 notify "[NOTE] Using bridges: ${OPNFV_BRIDGES[*]}" 2
281 jumpserver_check_requirements "${virtual_nodes[*]}" "${OPNFV_BRIDGES[@]}"
284 if [ ${DRY_RUN} -eq 1 ]; then
285 notify "[NOTE] Dry run, skipping all deployment tasks" 2
287 elif [ ${USE_EXISTING_INFRA} -gt 0 ]; then
288 notify "[NOTE] Use existing infra: skip first ${USE_EXISTING_INFRA} states" 2
289 notify "[STATE] Skipping: ${cluster_states[*]::${USE_EXISTING_INFRA}}" 2
291 prepare_vms "${base_image}" "${MCP_STORAGE_DIR}" "${virtual_repos_pkgs}" \
292 "${virtual_nodes[@]}"
293 prepare_containers "${MCP_STORAGE_DIR}"
294 create_networks "${OPNFV_BRIDGES[@]}"
297 create_vms "${MCP_STORAGE_DIR}" "${virtual_nodes_data}" "${OPNFV_BRIDGES[@]}"
298 update_mcpcontrol_network
299 start_vms "${virtual_nodes[@]}"
302 start_containers "${MCP_STORAGE_DIR}"
305 # Openstack cluster setup
307 if [ ${NO_DEPLOY_ENVIRONMENT} -eq 1 ]; then
308 notify "[NOTE] Skip openstack cluster setup" 2
310 for state in "${cluster_states[@]:${USE_EXISTING_INFRA}}"; do
311 notify "[STATE] Applying state: ${state}" 2
312 # shellcheck disable=SC2086,2029
313 wait_for 5 "ssh ${SSH_OPTS} ${SSH_SALT} sudo \
314 CI_DEBUG=$CI_DEBUG ERASE_ENV=$ERASE_ENV \
315 /root/fuel/mcp/config/states/${state}"
316 if [ "${state}" = 'maas' ]; then
317 # For hybrid PODs (virtual + baremetal nodes), the virtual nodes
318 # should be reset to force a DHCP request from MaaS DHCP
319 reset_vms "${virtual_nodes[@]}"
324 ./log.sh "${DEPLOY_LOG}"
330 ##############################################################################