[fdio] Increase VIF plug-in timeout
[fuel.git] / ci / deploy.sh
1 #!/bin/bash -e
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 ##############################################################################
11
12 ##############################################################################
13 # BEGIN of Exit handlers
14 #
15 do_exit () {
16     local RC=$?
17     cleanup_mounts > /dev/null 2>&1
18     if [ ${RC} -eq 0 ]; then
19         notify_n "[OK] MCP: Openstack installation finished succesfully!" 2
20     else
21         notify_n "[ERROR] MCP: Openstack installation threw a fatal error!"
22     fi
23 }
24 #
25 # End of Exit handlers
26 ##############################################################################
27
28 ##############################################################################
29 # BEGIN of usage description
30 #
31 usage ()
32 {
33 cat << EOF
34 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
35 $(notify "$(basename "$0"): Deploy the OPNFV Fuel MCP stack" 3)
36
37 $(notify "USAGE:" 2)
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]
42
43 $(notify "OPTIONS:" 2)
44   -b  Base-uri for the stack-configuration structure
45   -d  Dry-run
46   -D  Debug logging
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
52   -l  Lab-name
53   -p  Pod-name
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)
60
61 $(notify_i "Description:" 2)
62 Deploys the OPNFV Fuel stack on the indicated lab resource.
63
64 This script provides the OPNFV Fuel deployment abstraction.
65 It depends on the OPNFV official configuration directory/file structure
66 and provides a fairly simple mechanism to execute a deployment.
67
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 -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.
87    Each additional use skips one more state file. For example, -fff would
88    skip the first 3 state files (e.g. virtual_init, maas, baremetal_init).
89 -F Same as -e, do not launch environment deployment (legacy option)
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 -m Use single socket compute nodes. Instead of using default NUMA-enabled
95    topology for virtual compute nodes created via libvirt, configure a
96    single guest CPU socket.
97 -N Experimental: Instead of virtualizing the control plane (VCP), deploy
98    control plane directly on baremetal nodes
99 -P Skip installing dependency distro packages on current host
100    This flag should only be used if you have kept back older packages that
101    would be upgraded and that is undesirable on the current system.
102    Note that without the required packages, deploy will fail.
103 -s Deployment-scenario, this points to a short deployment scenario name, which
104    has to be defined in config directory (e.g. os-odl-nofeature-ha).
105 -S Storage dir for VM images, default is /var/lib/opnfv/tmpdir
106    It is recommended to store the deploy artifacts on a fast disk, outside of
107    the current git repository (so clean operations won't erase it).
108
109 $(notify_i "[NOTE] sudo & virsh priviledges are needed for this script to run" 3)
110
111 Example:
112
113 $(notify_i "sudo $(basename "$0") \\
114   -b file:///home/jenkins/securedlab \\
115   -l lf -p pod2 \\
116   -s os-odl-nofeature-ha \\
117   -S /home/jenkins/tmpdir" 2)
118 EOF
119 }
120
121 #
122 # END of usage description
123 ##############################################################################
124
125 ##############################################################################
126 # BEGIN of variables to customize
127 #
128 CI_DEBUG=${CI_DEBUG:-0}; [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
129 MCP_REPO_ROOT_PATH=$(readlink -f "$(dirname "${BASH_SOURCE[0]}")/..")
130 DEPLOY_DIR=$(cd "${MCP_REPO_ROOT_PATH}/mcp/scripts"; pwd)
131 MCP_STORAGE_DIR='/var/lib/opnfv/tmpdir'
132 URI_REGEXP='(file|https?|ftp)://.*'
133 BASE_CONFIG_URI="file://${MCP_REPO_ROOT_PATH}/mcp/scripts/pharos"
134 OPNFV_BRANCH=$(sed -ne 's/defaultbranch=//p' "${MCP_REPO_ROOT_PATH}/.gitreview")
135 DEF_DOCKER_TAG=$(basename "${OPNFV_BRANCH/master/latest}")
136
137 # Customize deploy workflow
138 DRY_RUN=${DRY_RUN:-0}
139 USE_EXISTING_PKGS=${USE_EXISTING_PKGS:-0}
140 USE_EXISTING_INFRA=${USE_EXISTING_INFRA:-0}
141 NO_DEPLOY_ENVIRONMENT=${NO_DEPLOY_ENVIRONMENT:-0}
142 ERASE_ENV=${ERASE_ENV:-0}
143 MCP_VCP=${MCP_VCP:-1}
144 MCP_DOCKER_TAG=${MCP_DOCKER_TAG:-${DEF_DOCKER_TAG}}
145 MCP_CMP_SS=${MCP_CMP_SS:-0}
146
147 source "${DEPLOY_DIR}/globals.sh"
148 source "${DEPLOY_DIR}/lib.sh"
149 source "${DEPLOY_DIR}/lib_template.sh"
150 source "${DEPLOY_DIR}/lib_jump_common.sh"
151 source "${DEPLOY_DIR}/lib_jump_deploy.sh"
152
153 #
154 # END of variables to customize
155 ##############################################################################
156
157 ##############################################################################
158 # BEGIN of main
159 #
160 set +x
161 while getopts "b:dDfEFl:L:Np:Ps:S:he" OPTION
162 do
163     case $OPTION in
164         b)
165             BASE_CONFIG_URI=${OPTARG}
166             if [[ ! $BASE_CONFIG_URI =~ ${URI_REGEXP} ]]; then
167                 notify "[ERROR] -b $BASE_CONFIG_URI - invalid URI"
168                 usage
169                 exit 1
170             fi
171             ;;
172         d)
173             DRY_RUN=1
174             ;;
175         D)
176             CI_DEBUG=1
177             ;;
178         f)
179             ((USE_EXISTING_INFRA+=1))
180             ;;
181         F|e)
182             NO_DEPLOY_ENVIRONMENT=1
183             ;;
184         E)
185             ((ERASE_ENV+=1))
186             ;;
187         l)
188             TARGET_LAB=${OPTARG}
189             ;;
190         L)
191             DEPLOY_LOG="${OPTARG}"
192             ;;
193         m)
194             MCP_CMP_SS=1
195             ;;
196         N)
197             MCP_VCP=0
198             ;;
199         p)
200             TARGET_POD=${OPTARG}
201             ;;
202         P)
203             USE_EXISTING_PKGS=1
204             ;;
205         s)
206             DEPLOY_SCENARIO=${OPTARG}
207             ;;
208         S)
209             if [[ ${OPTARG} ]]; then
210                 MCP_STORAGE_DIR="${OPTARG}"
211             fi
212             ;;
213         h)
214             usage
215             exit 0
216             ;;
217         *)
218             notify_e "[ERROR] Unsupported arg, see -h for help"
219             ;;
220     esac
221 done
222
223 if [[ "$(sudo whoami)" != 'root' ]]; then
224     notify_e "[ERROR] This script requires sudo rights"
225 fi
226
227 # Validate mandatory arguments are set
228 if [ -z "${TARGET_LAB}" ] || [ -z "${TARGET_POD}" ] || \
229    [ -z "${DEPLOY_SCENARIO}" ]; then
230     usage
231     notify_e "[ERROR] At least one of the mandatory args is missing!"
232 fi
233
234 [[ "${CI_DEBUG}" =~ (false|0) ]] || set -x
235
236 # Enable the automatic exit trap
237 trap do_exit SIGINT SIGTERM EXIT
238
239 # Set no restrictive umask so that Jenkins can remove any residuals
240 umask 0000
241
242 pushd "${DEPLOY_DIR}" > /dev/null
243 # Prepare the deploy config files based on lab/pod information, deployment
244 # scenario, etc.
245
246 # Install required packages on jump server
247 sudo mkdir -p "${MCP_STORAGE_DIR}"
248 sudo chown -R "${USER}:${USER}" "${MCP_STORAGE_DIR}"
249 if [ ${USE_EXISTING_PKGS} -eq 1 ]; then
250     notify "[NOTE] Skipping distro pkg installation" 2
251 else
252     notify "[NOTE] Installing required distro pkgs" 2
253     jumpserver_pkg_install 'deploy'
254     docker_install "${MCP_STORAGE_DIR}"
255     virtinst_install "${MCP_STORAGE_DIR}"
256 fi
257
258 if ! ${VIRSH} list >/dev/null 2>&1; then
259     notify_e "[ERROR] This script requires hypervisor access"
260 fi
261
262 # Collect jump server system information for deploy debugging
263 ./sysinfo_print.sh
264
265 # Clone git submodules and apply our patches
266 make -C "${MCP_REPO_ROOT_PATH}/mcp/patches" deepclean patches-import
267
268 # Check scenario file existence
269 SCENARIO_DIR="$(readlink -f "../config/scenario")"
270 if [ ! -f "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml" ] && \
271    [ ! -f "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml.j2" ]; then
272     notify_e "[ERROR] Scenario definition file is missing!"
273 fi
274
275 # key might not exist yet ...
276 generate_ssh_key
277 export MAAS_SSH_KEY="$(cat "$(basename "${SSH_KEY}").pub")"
278
279 # Expand jinja2 templates based on PDF data and env vars
280 [[ "${DEPLOY_SCENARIO}" =~ -ha$ ]] || MCP_VCP=0
281 export MCP_REPO_ROOT_PATH MCP_VCP MCP_STORAGE_DIR MCP_DOCKER_TAG MCP_CMP_SS \
282        MCP_JUMP_ARCH=$(uname -i) MCP_DEPLOY_SCENARIO="${DEPLOY_SCENARIO}"
283 do_templates_scenario "${MCP_STORAGE_DIR}" "${TARGET_LAB}" "${TARGET_POD}" \
284                       "${BASE_CONFIG_URI}" "${SCENARIO_DIR}" \
285                       "${SCENARIO_DIR}/${DEPLOY_SCENARIO}.yaml"
286 do_templates_cluster  "${MCP_STORAGE_DIR}" "${TARGET_LAB}" "${TARGET_POD}" \
287                       "${MCP_REPO_ROOT_PATH}" \
288                       "${SCENARIO_DIR}/defaults.yaml"
289
290 # Determine additional data (e.g. jump bridge names) based on XDF
291 source "${DEPLOY_DIR}/xdf_data.sh"
292
293 # Jumpserver prerequisites check
294 notify "[NOTE] Using bridges: ${OPNFV_BRIDGES[*]}" 2
295 jumpserver_check_requirements "${virtual_nodes[*]}" "${OPNFV_BRIDGES[@]}"
296
297 # Infra setup
298 if [ ${DRY_RUN} -eq 1 ]; then
299     notify "[NOTE] Dry run, skipping all deployment tasks" 2
300     exit 0
301 elif [ ${USE_EXISTING_INFRA} -gt 0 ]; then
302     notify "[NOTE] Use existing infra: skip first ${USE_EXISTING_INFRA} states" 2
303     notify "[STATE] Skipping: ${cluster_states[*]::${USE_EXISTING_INFRA}}" 2
304 else
305     prepare_vms "${base_image}" "${MCP_STORAGE_DIR}" "${virtual_repos_pkgs}" \
306       "${virtual_nodes[@]}"
307     create_networks "${OPNFV_BRIDGES[@]}"
308     do_sysctl_cfg
309     do_udev_cfg
310     create_vms "${MCP_STORAGE_DIR}" "${virtual_nodes_data}" "${OPNFV_BRIDGES[@]}"
311     update_mcpcontrol_network
312     start_vms "${virtual_nodes[@]}"
313
314     # https://github.com/docker/libnetwork/issues/1743
315     # rm -f /var/lib/docker/network/files/local-kv.db
316     sudo systemctl restart docker
317     prepare_containers "${MCP_STORAGE_DIR}"
318 fi
319
320 start_containers "${MCP_STORAGE_DIR}"
321 check_connection
322
323 # Openstack cluster setup
324 set +x
325 if [ ${NO_DEPLOY_ENVIRONMENT} -eq 1 ]; then
326     notify "[NOTE] Skip openstack cluster setup" 2
327 else
328     for state in "${cluster_states[@]:${USE_EXISTING_INFRA}}"; do
329         notify "[STATE] Applying state: ${state}" 2
330         # shellcheck disable=SC2086,2029
331         wait_for 5 "ssh ${SSH_OPTS} ${SSH_SALT} sudo \
332             CI_DEBUG=$CI_DEBUG ERASE_ENV=$ERASE_ENV \
333             /root/fuel/mcp/config/states/${state}"
334         if [ "${state}" = 'maas' ]; then
335             # For hybrid PODs (virtual + baremetal nodes), the virtual nodes
336             # should be reset to force a DHCP request from MaaS DHCP
337             reset_vms "${virtual_nodes[@]}"
338         fi
339     done
340
341     ./log.sh "${DEPLOY_LOG}"
342 fi
343
344 popd > /dev/null
345
346 #
347 # END of main
348 ##############################################################################