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] [-m]
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 -m Use single socket CPU compute nodes (only affects virtual computes)
59 -N Experimental: Do not virtualize control plane (novcp)
61 $(notify_i "Description:" 2)
62 Deploys the Fuel@OPNFV stack on the indicated lab resource.
64 This script provides the Fuel@OPNFV deployment abstraction.
65 It depends on the OPNFV official configuration directory/file structure
66 and provides a fairly simple mechanism to execute a deployment.
68 $(notify_i "Input parameters to the build script are:" 2)
69 -b Base URI to the configuration directory (needs to be provided in URI style,
70 it can be a local resource: file:// or a remote resource http(s)://).
71 A POD Descriptor File (PDF) and its Installer Descriptor File (IDF)
72 companion should be available at:
73 <base-uri>/labs/<lab-name>/<pod-name>.yaml
74 <base-uri>/labs/<lab-name>/idf-<pod-name>.yaml
75 The default is using the git submodule tracking 'OPNFV Pharos' in
76 <./mcp/scripts/pharos>.
77 An example config is provided inside current repo in
78 <./mcp/config>, automatically linked as <./mcp/scripts/pharos/labs/local>.
79 -d Dry-run - Produce deploy config files, but do not execute deploy
80 -D Debug logging - Enable extra logging in sh deploy scripts (set -x)
81 -e Do not launch environment deployment
82 -E Remove existing VCP VMs. It will destroy and undefine all VCP VMs
83 currently defined on cluster KVM nodes. If specified twice (e.g. -E -E),
84 baremetal nodes (VCP too, implicitly) will be removed, then reprovisioned.
85 Only applicable for baremetal deploys.
86 -f Deploy on existing Salt master. It will skip infrastructure VM creation,
87 but it will still sync reclass configuration from current repo to Salt
89 Each additional use skips one more state file. For example, -fff would
90 skip the first 3 state files (e.g. virtual_init, maas, baremetal_init).
91 -F Same as -e, do not launch environment deployment (legacy option)
92 -h Print this message and exit
93 -L Deployment log path and name, eg. -L /home/jenkins/job.log.tar.gz
94 -l Lab name as defined in the configuration directory, e.g. lf
95 For the sample configuration in <./mcp/config>, lab name is 'local'.
96 -p POD name as defined in the configuration directory, e.g. pod2
97 For the sample configuration in <./mcp/config>, POD name is 'virtual1'
98 for virtual deployments or 'pod1' for baremetal (based on lf-pod2).
99 -m Use single socket compute nodes. Instead of using default NUMA-enabled
100 topology for virtual compute nodes created via libvirt, configure a
101 single guest CPU socket.
102 -N Experimental: Instead of virtualizing the control plane (VCP), deploy
103 control plane directly on baremetal nodes
104 -P Skip installing dependency distro packages on current host
105 This flag should only be used if you have kept back older packages that
106 would be upgraded and that is undesirable on the current system.
107 Note that without the required packages, deploy will fail.
108 -s Deployment-scenario, this points to a short deployment scenario name, which
109 has to be defined in config directory (e.g. os-odl-nofeature-ha).
110 -S Storage dir for VM images, default is /var/lib/opnfv/tmpdir
111 It is recommended to store the deploy artifacts on a fast disk, outside of
112 the current git repository (so clean operations won't erase it).
114 $(notify_i "[NOTE] sudo & virsh priviledges are needed for this script to run" 3)
118 $(notify_i "sudo $(basename "$0") \\
119 -b file:///home/jenkins/securedlab \\
121 -s os-odl-nofeature-ha \\
122 -S /home/jenkins/tmpdir" 2)
127 # END of usage description
128 ##############################################################################
130 ##############################################################################
131 # BEGIN of variables to customize
133 CI_DEBUG=${CI_DEBUG:-0}; [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
134 MCP_REPO_ROOT_PATH=$(readlink -f "$(dirname "${BASH_SOURCE[0]}")/..")
135 DEPLOY_DIR=$(cd "${MCP_REPO_ROOT_PATH}/mcp/scripts"; pwd)
136 MCP_STORAGE_DIR='/var/lib/opnfv/tmpdir'
137 URI_REGEXP='(file|https?|ftp)://.*'
138 BASE_CONFIG_URI="file://${MCP_REPO_ROOT_PATH}/mcp/scripts/pharos"
140 # Customize deploy workflow
141 DRY_RUN=${DRY_RUN:-0}
142 USE_EXISTING_PKGS=${USE_EXISTING_PKGS:-0}
143 USE_EXISTING_INFRA=${USE_EXISTING_INFRA:-0}
144 NO_DEPLOY_ENVIRONMENT=${NO_DEPLOY_ENVIRONMENT:-0}
145 ERASE_ENV=${ERASE_ENV:-0}
146 MCP_VCP=${MCP_VCP:-1}
147 MCP_DOCKER_TAG=${MCP_DOCKER_TAG:-latest}
148 MCP_CMP_SS=${MCP_CMP_SS:-0}
150 source "${DEPLOY_DIR}/globals.sh"
151 source "${DEPLOY_DIR}/lib.sh"
152 source "${DEPLOY_DIR}/lib_template.sh"
155 # END of variables to customize
156 ##############################################################################
158 ##############################################################################
162 while getopts "b:dDfEFl:L:Np:Ps:S:he" OPTION
166 BASE_CONFIG_URI=${OPTARG}
167 if [[ ! $BASE_CONFIG_URI =~ ${URI_REGEXP} ]]; then
168 notify "[ERROR] -b $BASE_CONFIG_URI - invalid URI"
180 ((USE_EXISTING_INFRA+=1))
183 NO_DEPLOY_ENVIRONMENT=1
192 DEPLOY_LOG="${OPTARG}"
207 DEPLOY_SCENARIO=${OPTARG}
210 if [[ ${OPTARG} ]]; then
211 MCP_STORAGE_DIR="${OPTARG}"
219 notify_e "[ERROR] Unsupported arg, see -h for help"
224 if [[ "$(sudo whoami)" != 'root' ]]; then
225 notify_e "[ERROR] This script requires sudo rights"
228 # Validate mandatory arguments are set
229 if [ -z "${TARGET_LAB}" ] || [ -z "${TARGET_POD}" ] || \
230 [ -z "${DEPLOY_SCENARIO}" ]; then
232 notify_e "[ERROR] At least one of the mandatory args is missing!"
235 [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
237 # Enable the automatic exit trap
238 trap do_exit SIGINT SIGTERM EXIT
240 # Set no restrictive umask so that Jenkins can remove any residuals
243 pushd "${DEPLOY_DIR}" > /dev/null
244 # Prepare the deploy config files based on lab/pod information, deployment
247 # Install required packages on jump server
248 sudo mkdir -p "${MCP_STORAGE_DIR}"
249 sudo chown "${USER}:${USER}" "${MCP_STORAGE_DIR}"
250 if [ ${USE_EXISTING_PKGS} -eq 1 ]; then
251 notify "[NOTE] Skipping distro pkg installation" 2
253 notify "[NOTE] Installing required distro pkgs" 2
254 jumpserver_pkg_install 'deploy'
255 docker_install "${MCP_STORAGE_DIR}"
256 virtinst_install "${MCP_STORAGE_DIR}"
259 if ! virsh list >/dev/null 2>&1; then
260 notify_e "[ERROR] This script requires hypervisor access"
263 # Collect jump server system information for deploy debugging
266 # Clone git submodules and apply our patches
267 make -C "${MCP_REPO_ROOT_PATH}/mcp/patches" deepclean patches-import
269 # Check scenario file existence
270 SCENARIO_DIR="$(readlink -f "../config/scenario")"
271 if [ ! -f "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml" ] && \
272 [ ! -f "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml.j2" ]; then
273 notify_e "[ERROR] Scenario definition file is missing!"
276 # key might not exist yet ...
278 export MAAS_SSH_KEY="$(cat "$(basename "${SSH_KEY}").pub")"
280 MCP_DPDK_MODE=$([[ "$DEPLOY_SCENARIO" =~ ovs ]] && echo 1 || echo 0)
281 # Expand jinja2 templates based on PDF data and env vars
282 export MCP_REPO_ROOT_PATH MCP_VCP MCP_DPDK_MODE MCP_STORAGE_DIR MCP_DOCKER_TAG \
283 MCP_CMP_SS MCP_JUMP_ARCH=$(uname -i)
284 do_templates_scenario "${MCP_STORAGE_DIR}" "${TARGET_LAB}" "${TARGET_POD}" \
285 "${BASE_CONFIG_URI}" "${SCENARIO_DIR}" \
286 "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml"
287 do_templates_cluster "${MCP_STORAGE_DIR}" "${TARGET_LAB}" "${TARGET_POD}" \
288 "${MCP_REPO_ROOT_PATH}" \
289 "${SCENARIO_DIR}/defaults.yaml"
291 # Determine additional data (e.g. jump bridge names) based on XDF
292 source "${DEPLOY_DIR}/xdf_data.sh"
294 # Jumpserver prerequisites check
295 notify "[NOTE] Using bridges: ${OPNFV_BRIDGES[*]}" 2
296 jumpserver_check_requirements "${virtual_nodes[*]}" "${OPNFV_BRIDGES[@]}"
299 if [ ${DRY_RUN} -eq 1 ]; then
300 notify "[NOTE] Dry run, skipping all deployment tasks" 2
302 elif [ ${USE_EXISTING_INFRA} -gt 0 ]; then
303 notify "[NOTE] Use existing infra: skip first ${USE_EXISTING_INFRA} states" 2
304 notify "[STATE] Skipping: ${cluster_states[*]::${USE_EXISTING_INFRA}}" 2
306 prepare_vms "${base_image}" "${MCP_STORAGE_DIR}" "${virtual_repos_pkgs}" \
307 "${virtual_nodes[@]}"
308 prepare_containers "${MCP_STORAGE_DIR}"
309 create_networks "${OPNFV_BRIDGES[@]}"
312 create_vms "${MCP_STORAGE_DIR}" "${virtual_nodes_data}" "${OPNFV_BRIDGES[@]}"
313 start_vms "${virtual_nodes[@]}"
316 start_containers "${MCP_STORAGE_DIR}"
319 # Openstack cluster setup
321 if [ ${NO_DEPLOY_ENVIRONMENT} -eq 1 ]; then
322 notify "[NOTE] Skip openstack cluster setup" 2
324 for state in "${cluster_states[@]:${USE_EXISTING_INFRA}}"; do
325 notify "[STATE] Applying state: ${state}" 2
326 # shellcheck disable=SC2086,2029
327 wait_for 5 "ssh ${SSH_OPTS} ${SSH_SALT} sudo \
328 CI_DEBUG=$CI_DEBUG ERASE_ENV=$ERASE_ENV \
329 /root/fuel/mcp/config/states/${state}"
330 if [ "${state}" = 'maas' ]; then
331 # For hybrid PODs (virtual + baremetal nodes), the virtual nodes
332 # should be reset to force a DHCP request from MaaS DHCP
333 reset_vms "${virtual_nodes[@]}"
338 ./log.sh "${DEPLOY_LOG}"
344 ##############################################################################