2 # shellcheck disable=SC2155,SC1001,SC2015,SC2128
3 ##############################################################################
4 # Copyright (c) 2018 Mirantis Inc., Enea AB and others.
5 # All rights reserved. This program and the accompanying materials
6 # are made available under the terms of the Apache License, Version 2.0
7 # which accompanies this distribution, and is available at
8 # http://www.apache.org/licenses/LICENSE-2.0
9 ##############################################################################
11 # Library of shell functions used by deploy script on jumpserver:
12 # - base cloud image (used by FN VMs and VCP VMs) processing:
14 # * tooling for offline image modification (without libguestfs);
15 # * package pre-installation (requires nbd, loop krn mods);
16 # - virtualized hosts processing:
17 # * virsh-managed VMs boilerplate;
18 # * salt master container tooling;
19 # * virsh & docker network plumbing;
22 ##############################################################################
23 # private helper functions
24 ##############################################################################
26 function __get_base_image {
30 mkdir -p "${image_dir}"
31 wget --progress=dot:giga -P "${image_dir}" -N "${base_image}"
34 function __kernel_modules {
35 # Load mandatory kernel modules: loop, nbd
37 test -e /dev/loop-control || sudo modprobe loop
38 if sudo modprobe nbd max_part=8 || sudo modprobe -f nbd max_part=8; then
41 if [ -e /dev/nbd0 ]; then return 0; fi # nbd might be inbuilt
42 # CentOS (or RHEL family in general) do not provide 'nbd' out of the box
43 echo "[WARN] 'nbd' kernel module cannot be loaded!"
44 if [ ! -e /etc/redhat-release ]; then
45 echo "[ERROR] Non-RHEL system detected, aborting!"
46 echo "[ERROR] Try building 'nbd' manually or install it from a 3rd party."
50 # Best-effort attempt at building a non-maintaned kernel module
51 local __baseurl='http://vault.centos.org/centos'
52 local __subdir='Source/SPackages'
53 local __uname_r=$(uname -r)
54 local __uname_m=$(uname -m)
55 if [ "${__uname_m}" = 'x86_64' ]; then
56 __srpm="kernel-${__uname_r%.${__uname_m}}.src.rpm"
58 # NOTE: fmt varies across releases (e.g. kernel-alt-4.11.0-44.el7a.src.rpm)
59 __srpm="kernel-alt-${__uname_r%.${__uname_m}}.src.rpm"
63 local __versions=$(curl -s "${__baseurl}/" | grep -Po 'href="\K7\.[\d\.]+')
64 for ver in ${__versions}; do
65 for comp in os updates; do
66 local url="${__baseurl}/${ver}/${comp}/${__subdir}/${__srpm}"
67 if wget "${url}" -O "${image_dir}/${__srpm}" > /dev/null 2>&1; then
73 if [ "${__found}" = 'n' ]; then
74 echo "[ERROR] Can't find the linux kernel SRPM for: ${__uname_r}"
75 echo "[ERROR] 'nbd' module cannot be built, aborting!"
76 echo "[ERROR] Try 'yum upgrade' or building 'nbd' krn module manually ..."
80 rpm -ivh "${image_dir}/${__srpm}" 2> /dev/null
81 mkdir -p ~/rpmbuild/{BUILD,BUILDROOT,RPMS,SOURCES,SPECS,SRPMS}
82 # shellcheck disable=SC2016
83 echo '%_topdir %(echo $HOME)/rpmbuild' > ~/.rpmmacros
86 rpmbuild -bp --nodeps --target="${__uname_m}" kernel*.spec
87 cd ~/rpmbuild/BUILD/"${__srpm%.src.rpm}"/linux-*
88 sed -i 's/^.*\(CONFIG_BLK_DEV_NBD\).*$/\1=m/g' .config
89 # http://centosfaq.org/centos/nbd-does-not-compile-for-3100-514262el7x86_64
90 if grep -Rq 'REQ_TYPE_DRV_PRIV' drivers/block; then
91 sed -i 's/REQ_TYPE_SPECIAL/REQ_TYPE_DRV_PRIV/g' drivers/block/nbd.c
93 gunzip -c "/boot/symvers-${__uname_r}.gz" > Module.symvers
94 make prepare modules_prepare
95 make M=drivers/block -j
96 modinfo drivers/block/nbd.ko
97 sudo mkdir -p "/lib/modules/${__uname_r}/extra/"
98 sudo cp drivers/block/nbd.ko "/lib/modules/${__uname_r}/extra/"
101 sudo modprobe nbd max_part=8 || sudo modprobe -f nbd max_part=8
104 function __mount_image {
107 OPNFV_MNT_DIR="${image_dir}/ubuntu"
109 # Find free nbd, loop devices
110 for dev in '/sys/class/block/nbd'*; do
111 if [ "$(cat "${dev}/size")" = '0' ]; then
112 OPNFV_NBD_DEV=/dev/$(basename "${dev}")
116 OPNFV_LOOP_DEV=$(sudo losetup -f)
117 OPNFV_MAP_DEV=/dev/mapper/$(basename "${OPNFV_NBD_DEV}")p1
118 export OPNFV_MNT_DIR OPNFV_LOOP_DEV
119 [ -n "${OPNFV_NBD_DEV}" ] && [ -n "${OPNFV_LOOP_DEV}" ] || exit 1
120 qemu-img resize "${image_dir}/${image}" 3G
121 sudo qemu-nbd --connect="${OPNFV_NBD_DEV}" --aio=native --cache=none \
122 "${image_dir}/${image}"
123 sudo kpartx -av "${OPNFV_NBD_DEV}"
124 # Hardcode partition index to 1, unlikely to change for Ubuntu UCA image
125 sudo partx -uvn 1:1 "${OPNFV_NBD_DEV}"
126 if sudo growpart "${OPNFV_NBD_DEV}" 1; then
127 sudo kpartx -u "${OPNFV_NBD_DEV}"
128 sudo e2fsck -pf "${OPNFV_MAP_DEV}"
129 sudo resize2fs "${OPNFV_MAP_DEV}"
131 sleep 5 # /dev/nbdNp1 takes some time to come up
133 sudo partx -d "${OPNFV_NBD_DEV}"
134 # grub-update does not like /dev/nbd*, so use a loop device to work around it
135 sudo losetup "${OPNFV_LOOP_DEV}" "${OPNFV_MAP_DEV}"
136 mkdir -p "${OPNFV_MNT_DIR}"
137 sudo mount "${OPNFV_LOOP_DEV}" "${OPNFV_MNT_DIR}"
138 sudo mount -t proc proc "${OPNFV_MNT_DIR}/proc"
139 sudo mount -t sysfs sys "${OPNFV_MNT_DIR}/sys"
140 sudo mount -o bind /dev "${OPNFV_MNT_DIR}/dev"
141 sudo mkdir -p "${OPNFV_MNT_DIR}/run/resolvconf"
142 sudo cp /etc/resolv.conf "${OPNFV_MNT_DIR}/run/resolvconf"
143 echo "GRUB_DISABLE_OS_PROBER=true" | \
144 sudo tee -a "${OPNFV_MNT_DIR}/etc/default/grub"
145 sudo sed -i -e 's/^\(GRUB_TIMEOUT\)=.*$/\1=1/g' -e 's/^GRUB_HIDDEN.*$//g' \
146 "${OPNFV_MNT_DIR}/etc/default/grub"
149 function __apt_repos_pkgs_image {
150 local apt_key_urls=(${1//,/ })
151 local all_repos=(${2//,/ })
152 local pkgs_i=(${3//,/ })
153 local pkgs_r=(${4//,/ })
154 [ -n "${OPNFV_MNT_DIR}" ] || exit 1
157 if [ "${#apt_key_urls[@]}" -gt 0 ]; then
158 for apt_key in "${apt_key_urls[@]}"; do
159 sudo chroot "${OPNFV_MNT_DIR}" /bin/bash -c \
160 "wget -qO - '${apt_key}' | apt-key add -"
163 # Additional repositories
164 for repo_line in "${all_repos[@]}"; do
165 # <repo_name>|<repo prio>|deb|[arch=<arch>]|<repo url>|<dist>|<repo comp>
166 local repo=(${repo_line//|/ })
167 [ "${#repo[@]}" -gt 5 ] || continue
168 # NOTE: Names and formatting are compatible with Salt linux.system.repo
169 cat <<-EOF | sudo tee "${OPNFV_MNT_DIR}/etc/apt/preferences.d/${repo[0]}"
172 Pin: release a=${repo[-2]}
173 Pin-Priority: ${repo[1]}
176 echo "${repo[@]:2}" | sudo tee \
177 "${OPNFV_MNT_DIR}/etc/apt/sources.list.d/${repo[0]}.list"
180 if [ "${#pkgs_i[@]}" -gt 0 ]; then
181 sudo DEBIAN_FRONTEND="noninteractive" \
182 chroot "${OPNFV_MNT_DIR}" apt-get update
183 sudo DEBIAN_FRONTEND="noninteractive" FLASH_KERNEL_SKIP="true" \
184 chroot "${OPNFV_MNT_DIR}" apt-get install -y "${pkgs_i[@]}"
187 if [ "${#pkgs_r[@]}" -gt 0 ]; then
188 sudo DEBIAN_FRONTEND="noninteractive" FLASH_KERNEL_SKIP="true" \
189 chroot "${OPNFV_MNT_DIR}" apt-get purge -y "${pkgs_r[@]}"
191 # Disable cloud-init metadata service datasource
192 sudo mkdir -p "${OPNFV_MNT_DIR}/etc/cloud/cloud.cfg.d"
193 echo "datasource_list: [ NoCloud, None ]" | sudo tee \
194 "${OPNFV_MNT_DIR}/etc/cloud/cloud.cfg.d/95_real_datasources.cfg"
197 function __cleanup_vms {
198 # clean up existing nodes
199 for node in $(${VIRSH} list --name | grep -P '\w{3}\d{2}'); do
200 ${VIRSH} destroy "${node}" 2>/dev/null || true
202 for node in $(${VIRSH} list --name --all | grep -P '\w{3}\d{2}'); do
203 ${VIRSH} domblklist "${node}" | awk '/^.da/ {print $2}' | \
204 xargs --no-run-if-empty -I{} sudo rm -f {}
205 ${VIRSH} undefine "${node}" --remove-all-storage --nvram || \
206 ${VIRSH} undefine "${node}" --remove-all-storage
210 ##############################################################################
212 ##############################################################################
214 function prepare_vms {
215 local base_image=$1; shift
216 local image_dir=$1; shift
217 local repos_pkgs_str=$1; shift # ^-sep list of repos, pkgs to install/rm
218 local image=base_image_opnfv_fuel.img
219 local vcp_image=${image%.*}_vcp.img
220 local _o=${base_image/*\/}
221 [ -n "${image_dir}" ] || exit 1
225 __get_base_image "${base_image}" "${image_dir}"
226 IFS='^' read -r -a repos_pkgs <<< "${repos_pkgs_str}"
228 local _h=$(echo "${repos_pkgs_str}.$(md5sum "${image_dir}/${_o}")" | \
230 local _tmp="${image%.*}.${_h}.img"
231 echo "[INFO] Lookup cache / build patched base image for fingerprint: ${_h}"
232 if [ "${image_dir}/${_tmp}" -ef "${image_dir}/${image}" ]; then
233 echo "[INFO] Patched base image found"
235 # shellcheck disable=SC2115
236 rm -rf "${image_dir}/${image%.*}"*
237 if [[ ! "${repos_pkgs_str}" =~ ^\^+$ ]]; then
238 echo "[INFO] Patching base image ..."
239 cp "${image_dir}/${_o}" "${image_dir}/${_tmp}"
240 __kernel_modules "${image_dir}"
241 __mount_image "${_tmp}" "${image_dir}"
242 __apt_repos_pkgs_image "${repos_pkgs[@]:0:4}"
245 echo "[INFO] No patching required, using vanilla base image"
246 ln -sf "${image_dir}/${_o}" "${image_dir}/${_tmp}"
248 ln -sf "${image_dir}/${_tmp}" "${image_dir}/${image}"
251 # VCP VMs base image specific changes
252 if [[ ! "${repos_pkgs_str}" =~ \^{3}$ ]] && [ -n "${repos_pkgs[*]:4}" ]; then
253 echo "[INFO] Lookup cache / build patched VCP image for md5sum: ${_h}"
254 _tmp="${vcp_image%.*}.${_h}.img"
255 if [ "${image_dir}/${_tmp}" -ef "${image_dir}/${vcp_image}" ]; then
256 echo "[INFO] Patched VCP image found"
258 echo "[INFO] Patching VCP image ..."
259 cp "${image_dir}/${image}" "${image_dir}/${_tmp}"
260 __kernel_modules "${image_dir}"
261 __mount_image "${_tmp}" "${image_dir}"
262 __apt_repos_pkgs_image "${repos_pkgs[@]:4:4}"
264 ln -sf "${image_dir}/${_tmp}" "${image_dir}/${vcp_image}"
269 function create_networks {
270 local all_vnode_networks=("$@")
271 # create required networks
272 for net in "mcpcontrol" "${all_vnode_networks[@]}"; do
273 if ${VIRSH} net-info "${net}" >/dev/null 2>&1; then
274 ${VIRSH} net-destroy "${net}" || true
275 ${VIRSH} net-undefine "${net}"
277 # in case of custom network, host should already have the bridge in place
278 if [ -f "virsh_net/net_${net}.xml" ] && \
279 [ ! -d "/sys/class/net/${net}/bridge" ]; then
280 ${VIRSH} net-define "virsh_net/net_${net}.xml"
281 ${VIRSH} net-autostart "${net}"
282 ${VIRSH} net-start "${net}"
286 sudo ip link del veth_mcp0 || true
287 sudo ip link del veth_mcp2 || true
288 # Create systemd service for veth creation after reboot
289 FUEL_VETHC_SERVICE="/etc/systemd/system/opnfv-fuel-vethc.service"
290 FUEL_VETHA_SERVICE="/etc/systemd/system/opnfv-fuel-vetha.service"
291 test -f /usr/sbin/ip && PREFIX=/usr/sbin || PREFIX=/sbin
292 cat <<-EOF | sudo tee "${FUEL_VETHC_SERVICE}"
294 After=libvirtd.service
295 Before=docker.service
297 ExecStart=/bin/sh -ec '\
298 ${PREFIX}/ip link add veth_mcp0 type veth peer name veth_mcp1 && \
299 ${PREFIX}/ip link add veth_mcp2 type veth peer name veth_mcp3 && \
300 ${PREFIX}/ip link set veth_mcp0 up mtu 9000 && \
301 ${PREFIX}/ip link set veth_mcp1 up mtu 9000 && \
302 ${PREFIX}/ip link set veth_mcp2 up mtu 9000 && \
303 ${PREFIX}/ip link set veth_mcp3 up mtu 9000'
305 cat <<-EOF | sudo tee "${FUEL_VETHA_SERVICE}"
307 StartLimitInterval=200
309 After=opnfv-fuel-vethc.service
313 ExecStartPre=/bin/sh -ec '\
314 ${PREFIX}/brctl showstp ${all_vnode_networks[0]} > /dev/null 2>&1 && \
315 ${PREFIX}/brctl showstp ${all_vnode_networks[1]} > /dev/null 2>&1'
316 ExecStart=/bin/sh -ec '\
317 ${PREFIX}/brctl addif ${all_vnode_networks[0]} veth_mcp0 && \
318 ${PREFIX}/brctl addif ${all_vnode_networks[1]} veth_mcp2 && \
319 while ${PREFIX}/ip rule del to ${SALT_MASTER} iif docker0 table 200 2>/dev/null; do true; done && \
320 ${PREFIX}/ip rule add to ${SALT_MASTER} iif docker0 table 200 && \
321 ${PREFIX}/ip route replace ${SALT_MASTER} dev ${all_vnode_networks[0]} table 200'
323 sudo ln -sf "${FUEL_VETHC_SERVICE}" "/etc/systemd/system/multi-user.target.wants/"
324 sudo ln -sf "${FUEL_VETHA_SERVICE}" "/etc/systemd/system/multi-user.target.wants/"
325 sudo systemctl daemon-reload
326 sudo systemctl restart opnfv-fuel-vethc
327 sudo systemctl restart opnfv-fuel-vetha
330 function create_vms {
331 local image_dir=$1; shift
332 local image=base_image_opnfv_fuel.img
333 # vnode data should be serialized with the following format:
334 # <name0>,<disks0>,<ram0>,<vcpu0>[,<sockets0>,<cores0>,<threads0>[,<cell0name0>,<cell0memory0>,
335 # <cell0cpus0>,<cell1name0>,<cell1memory0>,<cell1cpus0>]]|<name1>,...'
336 IFS='|' read -r -a vnodes <<< "$1"; shift
338 # AArch64: prepare arch specific arguments
339 local virt_extra_args=""
340 if [ "$(uname -i)" = "aarch64" ]; then
341 # No Cirrus VGA on AArch64, use virtio instead
342 virt_extra_args="$virt_extra_args --video=virtio"
345 # create vms with specified options
346 for serialized_vnode_data in "${vnodes[@]}"; do
347 if [ -z "${serialized_vnode_data}" ]; then continue; fi
348 IFS=',' read -r -a vnode_data <<< "${serialized_vnode_data}"
349 IFS=';' read -r -a disks_data <<< "${vnode_data[1]}"
351 # Create config ISO and resize OS disk image for each foundation node VM
352 ./create-config-drive.sh -k "$(basename "${SSH_KEY}").pub" \
353 -u 'user-data.sh' -h "${vnode_data[0]}" "${image_dir}/mcp_${vnode_data[0]}.iso"
354 cp "${image_dir}/${image}" "${image_dir}/mcp_${vnode_data[0]}.qcow2"
355 qemu-img resize "${image_dir}/mcp_${vnode_data[0]}.qcow2" "${disks_data[0]}"
356 # Prepare additional drives if present
359 for dsize in "${disks_data[@]:1}"; do
361 qcow_file="${image_dir}/mcp_${vnode_data[0]}_${idx}.qcow2"
362 qemu-img create "${qcow_file}" "${dsize}"
363 virt_extra_storage+=" --disk path=${qcow_file},format=qcow2,bus=virtio,cache=none,io=native"
366 # prepare VM CPU model, count, topology (optional), NUMA cells (optional, requires topo)
367 local virt_cpu_args=' --cpu host-passthrough'
368 local idx=7 # cell0.name index in serialized data
369 while [ -n "${vnode_data[${idx}]}" ]; do
370 virt_cpu_args+=",${vnode_data[${idx}]}.memory=${vnode_data[$((idx + 1))]}"
371 virt_cpu_args+=",${vnode_data[${idx}]}.cpus=${vnode_data[$((idx + 2))]}"
374 virt_cpu_args+=" --vcpus vcpus=${vnode_data[3]}"
375 if [ -n "${vnode_data[6]}" ]; then
376 virt_cpu_args+=",sockets=${vnode_data[4]},cores=${vnode_data[5]},threads=${vnode_data[6]}"
379 # prepare network args
380 local vnode_networks=("$@")
382 for net in "${vnode_networks[@]}"; do
383 net_args="${net_args} --network bridge=${net},model=virtio"
386 [ ! -e "${image_dir}/virt-manager" ] || VIRT_PREFIX="${image_dir}/virt-manager/"
387 # shellcheck disable=SC2086
388 ${VIRT_PREFIX}${VIRSH/virsh/virt-install} --name "${vnode_data[0]}" \
389 ${virt_cpu_args} --accelerate \
391 --ram "${vnode_data[2]}" \
392 --disk path="${image_dir}/mcp_${vnode_data[0]}.qcow2",format=qcow2,bus=virtio,cache=none,io=native \
393 ${virt_extra_storage} \
394 --os-type linux --os-variant none \
395 --boot hd --vnc --console pty --autostart --noreboot \
396 --disk path="${image_dir}/mcp_${vnode_data[0]}.iso",device=cdrom \
404 local cmd_str="ssh ${SSH_OPTS} ${SSH_SALT}"
406 # reset non-infrastructure vms, wait for them to come back online
407 for node in "${vnodes[@]}"; do
408 ${VIRSH} reset "${node}"
410 for node in "${vnodes[@]}"; do
411 wait_for 20.0 "${cmd_str} sudo salt -C '${node}*' saltutil.sync_all"
419 for node in "${vnodes[@]}"; do
420 ${VIRSH} start "${node}"
421 sleep $((RANDOM%5+1))
425 function prepare_containers {
427 [ -n "${image_dir}" ] || exit 1
428 [ -n "${MCP_REPO_ROOT_PATH}" ] || exit 1
429 [ ! -e "${image_dir}/docker-compose" ] || COMPOSE_PREFIX="${image_dir}/"
431 "${COMPOSE_PREFIX}docker-compose" -f docker-compose/docker-compose.yaml down
432 if [[ ! "${MCP_DOCKER_TAG}" =~ 'verify' ]]; then
433 "${COMPOSE_PREFIX}docker-compose" -f docker-compose/docker-compose.yaml pull
435 # overwrite hosts only on first container up, to preserve cluster nodes
436 sudo cp docker-compose/files/hosts "${image_dir}/hosts"
437 sudo rm -rf "${image_dir}/"{salt,pki,mas01/etc} "${image_dir}/nodes/"*
438 find "${image_dir}/mas01/var/lib/" \
439 -mindepth 2 -maxdepth 2 -not -name boot-resources \
440 -exec sudo rm -rf {} \; || true
441 mkdir -p "${image_dir}/"{salt/master.d,salt/minion.d}
443 if grep -q -e 'maas' 'docker-compose/docker-compose.yaml'; then
444 chmod +x docker-compose/files/entrypoint*.sh
445 # Apparmor workaround for bind9 inside Docker containers using AUFS
446 for profile in 'usr.sbin.ntpd' 'usr.sbin.named' \
447 'usr.sbin.dhcpd' 'usr.bin.tcpdump'; do
448 if [ -e "/etc/apparmor.d/${profile}" ] && \
449 [ ! -e "/etc/apparmor.d/disable/${profile}" ]; then
450 sudo ln -sf "/etc/apparmor.d/${profile}" "/etc/apparmor.d/disable/"
451 sudo apparmor_parser -R "/etc/apparmor.d/${profile}" || true
457 function start_containers {
459 [ -n "${image_dir}" ] || exit 1
460 [ ! -e "${image_dir}/docker-compose" ] || COMPOSE_PREFIX="${image_dir}/"
461 "${COMPOSE_PREFIX}docker-compose" -f docker-compose/docker-compose.yaml up -d
464 function check_connection {
465 local total_attempts=60
469 echo '[INFO] Attempting to get into Salt master ...'
471 # wait until ssh on Salt master is available
472 # shellcheck disable=SC2034
473 for attempt in $(seq "${total_attempts}"); do
474 # shellcheck disable=SC2086
475 ssh ${SSH_OPTS} "ubuntu@${SALT_MASTER}" uptime
477 0) echo "${attempt}> Success"; break ;;
478 *) echo "${attempt}/${total_attempts}> ssh server ain't ready yet, waiting for ${sleep_time} seconds ..." ;;
485 function cleanup_mounts {
486 # Remove any mounts, loop and/or nbd devs created while patching base image
487 if [ -n "${OPNFV_MNT_DIR}" ] && [ -d "${OPNFV_MNT_DIR}" ]; then
488 if [ -f "${OPNFV_MNT_DIR}/boot/grub/grub.cfg" ]; then
489 # Grub thinks it's running from a live CD
490 sudo sed -i -e 's/^\s*set root=.*$//g' -e 's/^\s*loopback.*$//g' \
491 "${OPNFV_MNT_DIR}/boot/grub/grub.cfg"
493 sudo rm -f "${OPNFV_MNT_DIR}/run/resolvconf/resolv.conf"
495 if mountpoint -q "${OPNFV_MNT_DIR}"; then
496 sudo umount -l "${OPNFV_MNT_DIR}" || true
499 if [ -n "${OPNFV_LOOP_DEV}" ] && \
500 sudo losetup "${OPNFV_LOOP_DEV}" 1>&2 > /dev/null; then
501 sudo losetup -d "${OPNFV_LOOP_DEV}"
503 if [ -n "${OPNFV_NBD_DEV}" ]; then
504 sudo partx -d "${OPNFV_NBD_DEV}" || true
505 sudo kpartx -d "${OPNFV_NBD_DEV}" || true
506 sudo qemu-nbd -d "${OPNFV_NBD_DEV}" || true