blob: 2736dc042aaf1d3cea8667dbc11f30c10f95e429 [file] [log] [blame]
Sean Daguee263c822014-12-05 14:25:28 -05001#!/bin/bash
2#
Dean Troyerdff49a22014-01-30 15:37:40 -06003# functions - DevStack-specific functions
Dean Troyer13dc5cc2012-03-27 14:50:45 -05004#
Dean Troyer4a43b7b2012-08-28 17:43:40 -05005# The following variables are assumed to be defined by certain functions:
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01006#
Dean Troyerd8864fe2014-02-17 11:00:42 -06007# - ``DATABASE_BACKENDS``
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01008# - ``ENABLED_SERVICES``
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01009# - ``FILES``
10# - ``GLANCE_HOSTPORT``
Dean Troyerd8864fe2014-02-17 11:00:42 -060011#
Dean Troyer13dc5cc2012-03-27 14:50:45 -050012
Ian Wienand4ffb4542015-06-30 11:00:32 +100013# ensure we don't re-source this in the same environment
14[[ -z "$_DEVSTACK_FUNCTIONS" ]] || return 0
15declare -r _DEVSTACK_FUNCTIONS=1
16
Dean Troyerdff49a22014-01-30 15:37:40 -060017# Include the common functions
18FUNC_DIR=$(cd $(dirname "${BASH_SOURCE:-$0}") && pwd)
19source ${FUNC_DIR}/functions-common
Dean Troyerbf2ad702015-03-09 15:16:10 -050020source ${FUNC_DIR}/inc/ini-config
Dean Troyer490430d2015-01-30 14:38:35 -060021source ${FUNC_DIR}/inc/python
Dean Troyer32d6bc62015-03-29 14:16:44 -050022source ${FUNC_DIR}/inc/rootwrap
Dean Troyer7f9aa712012-01-31 12:11:56 -060023
Dean Troyer27e32692012-03-16 16:16:56 -050024# Save trace setting
Ian Wienand523f4882015-10-13 11:03:03 +110025_XTRACE_FUNCTIONS=$(set +o | grep xtrace)
Dean Troyer27e32692012-03-16 16:16:56 -050026set +o xtrace
27
Ian Wienand54e39102014-06-03 16:05:12 +100028# Check if a function already exists
29function function_exists {
30 declare -f -F $1 > /dev/null
31}
Dean Troyer7f9aa712012-01-31 12:11:56 -060032
Sean Dague646085d2016-03-21 17:00:51 -040033# short_source prints out the current location of the caller in a way
34# that strips redundant directories. This is useful for PS4 usage.
35function short_source {
36 saveIFS=$IFS
37 IFS=" "
38 called=($(caller 0))
39 IFS=$saveIFS
40 file=${called[2]}
41 file=${file#$RC_DIR/}
42 printf "%-40s " "$file:${called[1]}:${called[0]}"
43}
John L. Villalovosdaa7a412016-05-05 12:50:52 -070044# PS4 is exported to child shells and uses the 'short_source' function, so
45# export it so child shells have access to the 'short_source' function also.
46export -f short_source
Sean Dague646085d2016-03-21 17:00:51 -040047
48
Adam Spierscb961592013-10-05 12:11:07 +010049# Retrieve an image from a URL and upload into Glance.
Dean Troyerca0e3d02012-04-13 15:58:37 -050050# Uses the following variables:
Adam Spierscb961592013-10-05 12:11:07 +010051#
52# - ``FILES`` must be set to the cache dir
53# - ``GLANCE_HOSTPORT``
54#
Peter Stachowski5aeea6a2015-09-22 19:38:02 +000055# upload_image image-url
Ian Wienandaee18c72014-02-21 15:35:08 +110056function upload_image {
Dean Troyerca0e3d02012-04-13 15:58:37 -050057 local image_url=$1
Dean Troyerca0e3d02012-04-13 15:58:37 -050058
Dean Troyere9f76672014-07-25 11:09:36 -050059 local image image_fname image_name
60
Dean Troyerca0e3d02012-04-13 15:58:37 -050061 # Create a directory for the downloaded image tarballs.
62 mkdir -p $FILES/images
Dean Troyere9f76672014-07-25 11:09:36 -050063 image_fname=`basename "$image_url"`
Arnaud Legendre3e439442013-11-15 16:06:03 -080064 if [[ $image_url != file* ]]; then
Sreeram Yerrapragada314af0a2014-03-03 21:34:45 -080065 # Downloads the image (uec ami+akistyle), then extracts it.
Dean Troyere9f76672014-07-25 11:09:36 -050066 if [[ ! -f $FILES/$image_fname || "$(stat -c "%s" $FILES/$image_fname)" = "0" ]]; then
Attila Fazekas057d6ae2015-01-13 14:01:26 +010067 wget --progress=dot:giga -c $image_url -O $FILES/$image_fname
Isaku Yamahata6681a4f2014-01-10 15:28:29 +090068 if [[ $? -ne 0 ]]; then
69 echo "Not found: $image_url"
70 return
71 fi
Arnaud Legendre3e439442013-11-15 16:06:03 -080072 fi
Dean Troyere9f76672014-07-25 11:09:36 -050073 image="$FILES/${image_fname}"
Arnaud Legendre3e439442013-11-15 16:06:03 -080074 else
Dean Troyer3324f192014-09-18 09:26:39 -050075 # File based URL (RFC 1738): ``file://host/path``
Arnaud Legendre3e439442013-11-15 16:06:03 -080076 # Remote files are not considered here.
Dean Troyer3324f192014-09-18 09:26:39 -050077 # unix: ``file:///home/user/path/file``
78 # windows: ``file:///C:/Documents%20and%20Settings/user/path/file``
Dean Troyere9f76672014-07-25 11:09:36 -050079 image=$(echo $image_url | sed "s/^file:\/\///g")
80 if [[ ! -f $image || "$(stat -c "%s" $image)" == "0" ]]; then
Dean Troyerca0e3d02012-04-13 15:58:37 -050081 echo "Not found: $image_url"
82 return
83 fi
84 fi
85
86 # OpenVZ-format images are provided as .tar.gz, but not decompressed prior to loading
87 if [[ "$image_url" =~ 'openvz' ]]; then
Dean Troyere9f76672014-07-25 11:09:36 -050088 image_name="${image_fname%.tar.gz}"
Victor Ryzhenkin878d7d82016-04-27 15:15:52 +030089 openstack --os-cloud=devstack-admin --os-region-name="$REGION_NAME" image create "$image_name" --public --container-format ami --disk-format ami < "${image}"
Dean Troyerca0e3d02012-04-13 15:58:37 -050090 return
91 fi
92
Sreeram Yerrapragadacbaff862013-07-24 19:49:23 -070093 # vmdk format images
94 if [[ "$image_url" =~ '.vmdk' ]]; then
Dean Troyere9f76672014-07-25 11:09:36 -050095 image_name="${image_fname%.vmdk}"
Ryan Hsua6273b92013-09-04 23:51:29 -070096
97 # Before we can upload vmdk type images to glance, we need to know it's
98 # disk type, storage adapter, and networking adapter. These values are
Ryan Hsubfb3e5e2013-11-11 21:20:14 -080099 # passed to glance as custom properties.
Arnaud Legendre5ea53ee2013-11-01 16:42:54 -0700100 # We take these values from the vmdk file if populated. Otherwise, we use
Ryan Hsua6273b92013-09-04 23:51:29 -0700101 # vmdk filename, which is expected in the following format:
102 #
Ryan Hsubfb3e5e2013-11-11 21:20:14 -0800103 # <name>-<disk type>;<storage adapter>;<network adapter>
Ryan Hsua6273b92013-09-04 23:51:29 -0700104 #
105 # If the filename does not follow the above format then the vsphere
106 # driver will supply default values.
Arnaud Legendre5ea53ee2013-11-01 16:42:54 -0700107
Dean Troyere9f76672014-07-25 11:09:36 -0500108 local vmdk_disktype=""
Sabari Kumar Murugesan88cde0b2014-12-04 17:48:26 -0800109 local vmdk_net_adapter="e1000"
Dean Troyere9f76672014-07-25 11:09:36 -0500110 local path_len
Ryan Hsubfb3e5e2013-11-11 21:20:14 -0800111
Arnaud Legendre5ea53ee2013-11-01 16:42:54 -0700112 # vmdk adapter type
Ian Wienand7ae97292016-02-16 14:50:53 +1100113 local vmdk_adapter_type
114 vmdk_adapter_type="$(head -25 $image | { grep -a -F -m 1 'ddb.adapterType =' $image || true; })"
Arnaud Legendre5ea53ee2013-11-01 16:42:54 -0700115 vmdk_adapter_type="${vmdk_adapter_type#*\"}"
116 vmdk_adapter_type="${vmdk_adapter_type%?}"
117
118 # vmdk disk type
Ian Wienand7ae97292016-02-16 14:50:53 +1100119 local vmdk_create_type
120 vmdk_create_type="$(head -25 $image | { grep -a -F -m 1 'createType=' $image || true; })"
Arnaud Legendre5ea53ee2013-11-01 16:42:54 -0700121 vmdk_create_type="${vmdk_create_type#*\"}"
Arnaud Legendre8dad4bd2014-02-03 17:57:39 -0800122 vmdk_create_type="${vmdk_create_type%\"*}"
Arnaud Legendre90bcd2f2013-11-22 16:05:39 -0800123
124 descriptor_data_pair_msg="Monolithic flat and VMFS disks "`
Isaku Yamahata6681a4f2014-01-10 15:28:29 +0900125 `"should use a descriptor-data pair."
Arnaud Legendre5ea53ee2013-11-01 16:42:54 -0700126 if [[ "$vmdk_create_type" = "monolithicSparse" ]]; then
127 vmdk_disktype="sparse"
Dean Troyere9f76672014-07-25 11:09:36 -0500128 elif [[ "$vmdk_create_type" = "monolithicFlat" || "$vmdk_create_type" = "vmfs" ]]; then
Dean Troyer3324f192014-09-18 09:26:39 -0500129 # Attempt to retrieve the ``*-flat.vmdk``
Ian Wienand7ae97292016-02-16 14:50:53 +1100130 local flat_fname
131 flat_fname="$(head -25 $image | { grep -G 'RW\|RDONLY [0-9]+ FLAT\|VMFS' $image || true; })"
Arnaud Legendre90bcd2f2013-11-22 16:05:39 -0800132 flat_fname="${flat_fname#*\"}"
133 flat_fname="${flat_fname%?}"
Sreeram Yerrapragada9c6d2842014-03-10 14:12:58 -0700134 if [[ -z "$flat_fname" ]]; then
Dean Troyere9f76672014-07-25 11:09:36 -0500135 flat_fname="$image_name-flat.vmdk"
Arnaud Legendre90bcd2f2013-11-22 16:05:39 -0800136 fi
Dean Troyere9f76672014-07-25 11:09:36 -0500137 path_len=`expr ${#image_url} - ${#image_fname}`
138 local flat_url="${image_url:0:$path_len}$flat_fname"
Arnaud Legendre90bcd2f2013-11-22 16:05:39 -0800139 warn $LINENO "$descriptor_data_pair_msg"`
Isaku Yamahata6681a4f2014-01-10 15:28:29 +0900140 `" Attempt to retrieve the *-flat.vmdk: $flat_url"
Arnaud Legendre90bcd2f2013-11-22 16:05:39 -0800141 if [[ $flat_url != file* ]]; then
142 if [[ ! -f $FILES/$flat_fname || \
143 "$(stat -c "%s" $FILES/$flat_fname)" = "0" ]]; then
Attila Fazekas057d6ae2015-01-13 14:01:26 +0100144 wget --progress=dot:giga -c $flat_url -O $FILES/$flat_fname
Arnaud Legendre90bcd2f2013-11-22 16:05:39 -0800145 fi
Dean Troyere9f76672014-07-25 11:09:36 -0500146 image="$FILES/${flat_fname}"
Arnaud Legendre90bcd2f2013-11-22 16:05:39 -0800147 else
Dean Troyere9f76672014-07-25 11:09:36 -0500148 image=$(echo $flat_url | sed "s/^file:\/\///g")
149 if [[ ! -f $image || "$(stat -c "%s" $image)" == "0" ]]; then
Arnaud Legendre90bcd2f2013-11-22 16:05:39 -0800150 echo "Flat disk not found: $flat_url"
Sreeram Yerrapragada9c6d2842014-03-10 14:12:58 -0700151 return 1
Arnaud Legendre90bcd2f2013-11-22 16:05:39 -0800152 fi
153 fi
Dean Troyere9f76672014-07-25 11:09:36 -0500154 image_name="${flat_fname}"
Arnaud Legendre90bcd2f2013-11-22 16:05:39 -0800155 vmdk_disktype="preallocated"
Arnaud Legendre8dad4bd2014-02-03 17:57:39 -0800156 elif [[ "$vmdk_create_type" = "streamOptimized" ]]; then
157 vmdk_disktype="streamOptimized"
Arnaud Legendre90bcd2f2013-11-22 16:05:39 -0800158 elif [[ -z "$vmdk_create_type" ]]; then
159 # *-flat.vmdk provided: attempt to retrieve the descriptor (*.vmdk)
160 # to retrieve appropriate metadata
Dean Troyere9f76672014-07-25 11:09:36 -0500161 if [[ ${image_name: -5} != "-flat" ]]; then
Arnaud Legendre90bcd2f2013-11-22 16:05:39 -0800162 warn $LINENO "Expected filename suffix: '-flat'."`
Dean Troyere9f76672014-07-25 11:09:36 -0500163 `" Filename provided: ${image_name}"
Sreeram Yerrapragada9c6d2842014-03-10 14:12:58 -0700164 else
Dean Troyere9f76672014-07-25 11:09:36 -0500165 descriptor_fname="${image_name:0:${#image_name} - 5}.vmdk"
166 path_len=`expr ${#image_url} - ${#image_fname}`
167 local flat_path="${image_url:0:$path_len}"
168 local descriptor_url=$flat_path$descriptor_fname
Sreeram Yerrapragada9c6d2842014-03-10 14:12:58 -0700169 warn $LINENO "$descriptor_data_pair_msg"`
170 `" Attempt to retrieve the descriptor *.vmdk: $descriptor_url"
171 if [[ $flat_path != file* ]]; then
172 if [[ ! -f $FILES/$descriptor_fname || \
173 "$(stat -c "%s" $FILES/$descriptor_fname)" = "0" ]]; then
174 wget -c $descriptor_url -O $FILES/$descriptor_fname
175 fi
176 descriptor_url="$FILES/$descriptor_fname"
177 else
178 descriptor_url=$(echo $descriptor_url | sed "s/^file:\/\///g")
179 if [[ ! -f $descriptor_url || \
180 "$(stat -c "%s" $descriptor_url)" == "0" ]]; then
181 echo "Descriptor not found: $descriptor_url"
182 return 1
Arnaud Legendre90bcd2f2013-11-22 16:05:39 -0800183 fi
184 fi
Ryan Hsu99b622a2014-03-05 15:35:49 -0800185 vmdk_adapter_type="$(head -25 $descriptor_url | { grep -a -F -m 1 'ddb.adapterType =' $descriptor_url || true; })"
186 vmdk_adapter_type="${vmdk_adapter_type#*\"}"
187 vmdk_adapter_type="${vmdk_adapter_type%?}"
188 fi
Isaku Yamahata6681a4f2014-01-10 15:28:29 +0900189 vmdk_disktype="preallocated"
Arnaud Legendre5ea53ee2013-11-01 16:42:54 -0700190 else
Arnaud Legendre5ea53ee2013-11-01 16:42:54 -0700191 vmdk_disktype="preallocated"
192 fi
Ryan Hsubfb3e5e2013-11-11 21:20:14 -0800193
194 # NOTE: For backwards compatibility reasons, colons may be used in place
195 # of semi-colons for property delimiters but they are not permitted
196 # characters in NTFS filesystems.
Dean Troyere9f76672014-07-25 11:09:36 -0500197 property_string=`echo "$image_name" | { grep -oP '(?<=-)(?!.*-).*[:;].*[:;].*$' || true; }`
Ryan Hsubfb3e5e2013-11-11 21:20:14 -0800198 IFS=':;' read -a props <<< "$property_string"
199 vmdk_disktype="${props[0]:-$vmdk_disktype}"
200 vmdk_adapter_type="${props[1]:-$vmdk_adapter_type}"
201 vmdk_net_adapter="${props[2]:-$vmdk_net_adapter}"
Ryan Hsua6273b92013-09-04 23:51:29 -0700202
Victor Ryzhenkin878d7d82016-04-27 15:15:52 +0300203 openstack --os-cloud=devstack-admin --os-region-name="$REGION_NAME" image create "$image_name" --public --container-format bare --disk-format vmdk --property vmware_disktype="$vmdk_disktype" --property vmware_adaptertype="$vmdk_adapter_type" --property hw_vif_model="$vmdk_net_adapter" < "${image}"
Sreeram Yerrapragadacbaff862013-07-24 19:49:23 -0700204 return
205 fi
206
Mate Lakatbc2ef922013-08-15 18:06:59 +0100207 # XenServer-vhd-ovf-format images are provided as .vhd.tgz
Davanum Srinivas316ed6c2013-02-06 15:29:49 -0500208 # and should not be decompressed prior to loading
209 if [[ "$image_url" =~ '.vhd.tgz' ]]; then
Dean Troyere9f76672014-07-25 11:09:36 -0500210 image_name="${image_fname%.vhd.tgz}"
211 local force_vm_mode=""
212 if [[ "$image_name" =~ 'cirros' ]]; then
Bob Ballf1a2dbf2014-03-19 11:08:54 +0000213 # Cirros VHD image currently only boots in PV mode.
214 # Nova defaults to PV for all VHD images, but
215 # the glance setting is needed for booting
216 # directly from volume.
Dean Troyere9f76672014-07-25 11:09:36 -0500217 force_vm_mode="--property vm_mode=xen"
Bob Ballf1a2dbf2014-03-19 11:08:54 +0000218 fi
Steve Martinelli8d3ac2d2014-08-02 23:47:15 -0400219 openstack \
Victor Ryzhenkin878d7d82016-04-27 15:15:52 +0300220 --os-cloud=devstack-admin --os-region-name="$REGION_NAME" \
Steve Martinelli8d3ac2d2014-08-02 23:47:15 -0400221 image create \
222 "$image_name" --public \
Bob Ballf1a2dbf2014-03-19 11:08:54 +0000223 --container-format=ovf --disk-format=vhd \
Dean Troyere9f76672014-07-25 11:09:36 -0500224 $force_vm_mode < "${image}"
Davanum Srinivas316ed6c2013-02-06 15:29:49 -0500225 return
226 fi
227
Mate Lakatbc2ef922013-08-15 18:06:59 +0100228 # .xen-raw.tgz suggests a Xen capable raw image inside a tgz.
229 # and should not be decompressed prior to loading.
230 # Setting metadata, so PV mode is used.
231 if [[ "$image_url" =~ '.xen-raw.tgz' ]]; then
Dean Troyere9f76672014-07-25 11:09:36 -0500232 image_name="${image_fname%.xen-raw.tgz}"
Steve Martinelli8d3ac2d2014-08-02 23:47:15 -0400233 openstack \
Victor Ryzhenkin878d7d82016-04-27 15:15:52 +0300234 --os-cloud=devstack-admin --os-region-name="$REGION_NAME" \
Steve Martinelli8d3ac2d2014-08-02 23:47:15 -0400235 image create \
236 "$image_name" --public \
Mate Lakatbc2ef922013-08-15 18:06:59 +0100237 --container-format=tgz --disk-format=raw \
Dean Troyere9f76672014-07-25 11:09:36 -0500238 --property vm_mode=xen < "${image}"
Mate Lakatbc2ef922013-08-15 18:06:59 +0100239 return
240 fi
241
Maxim Nestratov54ee8a82015-07-15 11:47:11 +0300242 if [[ "$image_url" =~ '.hds' ]]; then
243 image_name="${image_fname%.hds}"
244 vm_mode=${image_name##*-}
245 if [[ $vm_mode != 'exe' && $vm_mode != 'hvm' ]]; then
246 die $LINENO "Unknown vm_mode=${vm_mode} for Virtuozzo image"
247 fi
248
249 openstack \
Victor Ryzhenkin878d7d82016-04-27 15:15:52 +0300250 --os-cloud=devstack-admin --os-region-name="$REGION_NAME" \
Maxim Nestratov54ee8a82015-07-15 11:47:11 +0300251 image create \
252 "$image_name" --public \
253 --container-format=bare --disk-format=ploop \
254 --property vm_mode=$vm_mode < "${image}"
255 return
256 fi
257
Dean Troyere9f76672014-07-25 11:09:36 -0500258 local kernel=""
259 local ramdisk=""
260 local disk_format=""
261 local container_format=""
262 local unpack=""
263 local img_property=""
264 case "$image_fname" in
Dean Troyerca0e3d02012-04-13 15:58:37 -0500265 *.tar.gz|*.tgz)
266 # Extract ami and aki files
Dean Troyere9f76672014-07-25 11:09:36 -0500267 [ "${image_fname%.tar.gz}" != "$image_fname" ] &&
268 image_name="${image_fname%.tar.gz}" ||
269 image_name="${image_fname%.tgz}"
270 local xdir="$FILES/images/$image_name"
Dean Troyerca0e3d02012-04-13 15:58:37 -0500271 rm -Rf "$xdir";
272 mkdir "$xdir"
Dean Troyere9f76672014-07-25 11:09:36 -0500273 tar -zxf $image -C "$xdir"
274 kernel=$(for f in "$xdir/"*-vmlinuz* "$xdir/"aki-*/image; do
Sean Dague537d4022013-10-22 07:43:22 -0400275 [ -f "$f" ] && echo "$f" && break; done; true)
Dean Troyere9f76672014-07-25 11:09:36 -0500276 ramdisk=$(for f in "$xdir/"*-initrd* "$xdir/"ari-*/image; do
Sean Dague537d4022013-10-22 07:43:22 -0400277 [ -f "$f" ] && echo "$f" && break; done; true)
Dean Troyere9f76672014-07-25 11:09:36 -0500278 image=$(for f in "$xdir/"*.img "$xdir/"ami-*/image; do
Sean Dague537d4022013-10-22 07:43:22 -0400279 [ -f "$f" ] && echo "$f" && break; done; true)
Dean Troyere9f76672014-07-25 11:09:36 -0500280 if [[ -z "$image_name" ]]; then
281 image_name=$(basename "$image" ".img")
Dean Troyerca0e3d02012-04-13 15:58:37 -0500282 fi
283 ;;
284 *.img)
Dean Troyere9f76672014-07-25 11:09:36 -0500285 image_name=$(basename "$image" ".img")
Ian Wienandada886d2015-10-07 14:06:26 +1100286 local format
287 format=$(qemu-img info ${image} | awk '/^file format/ { print $3; exit }')
Dean Troyer636a3ff2012-09-14 11:36:07 -0500288 if [[ ",qcow2,raw,vdi,vmdk,vpc," =~ ",$format," ]]; then
Dean Troyere9f76672014-07-25 11:09:36 -0500289 disk_format=$format
Dean Troyer636a3ff2012-09-14 11:36:07 -0500290 else
Dean Troyere9f76672014-07-25 11:09:36 -0500291 disk_format=raw
Dean Troyer636a3ff2012-09-14 11:36:07 -0500292 fi
Dean Troyere9f76672014-07-25 11:09:36 -0500293 container_format=bare
Dean Troyerca0e3d02012-04-13 15:58:37 -0500294 ;;
295 *.img.gz)
Dean Troyere9f76672014-07-25 11:09:36 -0500296 image_name=$(basename "$image" ".img.gz")
297 disk_format=raw
298 container_format=bare
299 unpack=zcat
Dean Troyerca0e3d02012-04-13 15:58:37 -0500300 ;;
301 *.qcow2)
Dean Troyere9f76672014-07-25 11:09:36 -0500302 image_name=$(basename "$image" ".qcow2")
303 disk_format=qcow2
304 container_format=bare
Dean Troyerca0e3d02012-04-13 15:58:37 -0500305 ;;
Jonathan Michalon06802042013-03-21 14:29:58 +0100306 *.iso)
Dean Troyere9f76672014-07-25 11:09:36 -0500307 image_name=$(basename "$image" ".iso")
308 disk_format=iso
309 container_format=bare
Jonathan Michalon06802042013-03-21 14:29:58 +0100310 ;;
Alessandro Pilottica823942014-08-07 02:05:26 +0300311 *.vhd|*.vhdx|*.vhd.gz|*.vhdx.gz)
312 local extension="${image_fname#*.}"
313 image_name=$(basename "$image" ".$extension")
314 disk_format=vhd
315 container_format=bare
316 if [ "${image_fname##*.}" == "gz" ]; then
317 unpack=zcat
318 fi
319 ;;
Dean Troyere9f76672014-07-25 11:09:36 -0500320 *) echo "Do not know what to do with $image_fname"; false;;
Dean Troyerca0e3d02012-04-13 15:58:37 -0500321 esac
322
Rafael Folco72f530f2016-02-09 07:08:38 -0600323 if is_arch "ppc64le" || is_arch "ppc64" || is_arch "ppc"; then
324 img_property="--property hw_disk_bus=scsi --property hw_scsi_model=virtio-scsi --property hw_cdrom_bus=scsi --property os_command_line=console=hvc0"
Rafael Folcoab775872013-12-02 14:04:32 -0200325 fi
326
Clark Laughlinfcc3f6e2015-04-07 16:31:47 +0000327 if is_arch "aarch64"; then
328 img_property="--property hw_machine_type=virt --property hw_cdrom_bus=virtio --property os_command_line='console=ttyAMA0'"
329 fi
330
Dean Troyere9f76672014-07-25 11:09:36 -0500331 if [ "$container_format" = "bare" ]; then
332 if [ "$unpack" = "zcat" ]; then
Victor Ryzhenkin878d7d82016-04-27 15:15:52 +0300333 openstack --os-cloud=devstack-admin --os-region-name="$REGION_NAME" image create "$image_name" $img_property --public --container-format=$container_format --disk-format $disk_format < <(zcat --force "${image}")
Dean Troyerca0e3d02012-04-13 15:58:37 -0500334 else
Victor Ryzhenkin878d7d82016-04-27 15:15:52 +0300335 openstack --os-cloud=devstack-admin --os-region-name="$REGION_NAME" image create "$image_name" $img_property --public --container-format=$container_format --disk-format $disk_format < "${image}"
Dean Troyerca0e3d02012-04-13 15:58:37 -0500336 fi
337 else
338 # Use glance client to add the kernel the root filesystem.
339 # We parse the results of the first upload to get the glance ID of the
340 # kernel for use when uploading the root filesystem.
Dean Troyere9f76672014-07-25 11:09:36 -0500341 local kernel_id="" ramdisk_id="";
342 if [ -n "$kernel" ]; then
Victor Ryzhenkin878d7d82016-04-27 15:15:52 +0300343 kernel_id=$(openstack --os-cloud=devstack-admin --os-region-name="$REGION_NAME" image create "$image_name-kernel" $img_property --public --container-format aki --disk-format aki < "$kernel" | grep ' id ' | get_field 2)
Dean Troyerca0e3d02012-04-13 15:58:37 -0500344 fi
Dean Troyere9f76672014-07-25 11:09:36 -0500345 if [ -n "$ramdisk" ]; then
Victor Ryzhenkin878d7d82016-04-27 15:15:52 +0300346 ramdisk_id=$(openstack --os-cloud=devstack-admin --os-region-name="$REGION_NAME" image create "$image_name-ramdisk" $img_property --public --container-format ari --disk-format ari < "$ramdisk" | grep ' id ' | get_field 2)
Dean Troyerca0e3d02012-04-13 15:58:37 -0500347 fi
Victor Ryzhenkin878d7d82016-04-27 15:15:52 +0300348 openstack --os-cloud=devstack-admin --os-region-name="$REGION_NAME" image create "${image_name%.img}" $img_property --public --container-format ami --disk-format ami ${kernel_id:+--property kernel_id=$kernel_id} ${ramdisk_id:+--property ramdisk_id=$ramdisk_id} < "${image}"
Dean Troyerca0e3d02012-04-13 15:58:37 -0500349 fi
350}
351
Dean Troyer1a6d4492013-06-03 16:47:36 -0500352
Dean Troyerc1b486a2012-11-05 14:26:09 -0600353# Set the database backend to use
354# When called from stackrc/localrc DATABASE_BACKENDS has not been
355# initialized yet, just save the configuration selection and call back later
356# to validate it.
Adam Spierscb961592013-10-05 12:11:07 +0100357#
358# ``$1`` - the name of the database backend to use (mysql, postgresql, ...)
Dean Troyerc1b486a2012-11-05 14:26:09 -0600359function use_database {
360 if [[ -z "$DATABASE_BACKENDS" ]]; then
Dean Troyerafc29fe2013-02-07 15:56:24 -0600361 # No backends registered means this is likely called from ``localrc``
362 # This is now deprecated usage
Dean Troyerc1b486a2012-11-05 14:26:09 -0600363 DATABASE_TYPE=$1
Sean Dague72ad9422015-10-07 11:51:40 -0400364 deprecated "The database backend needs to be properly set in ENABLED_SERVICES; use_database is deprecated localrc"
Attila Fazekas251d3b52012-12-16 15:05:44 +0100365 else
Dean Troyerafc29fe2013-02-07 15:56:24 -0600366 # This should no longer get called...here for posterity
Attila Fazekas251d3b52012-12-16 15:05:44 +0100367 use_exclusive_service DATABASE_BACKENDS DATABASE_TYPE $1
Dean Troyerc1b486a2012-11-05 14:26:09 -0600368 fi
Dean Troyerc1b486a2012-11-05 14:26:09 -0600369}
370
sridhargaddamb5ab6462015-02-24 07:23:24 +0000371#Macro for curl statements. curl requires -g option for literal IPv6 addresses.
372CURL_GET="${CURL_GET:-curl -g}"
Dean Troyer1a6d4492013-06-03 16:47:36 -0500373
Dean Troyer3a3a2ba2012-12-11 15:26:24 -0600374# Wait for an HTTP server to start answering requests
375# wait_for_service timeout url
Ian Wienandaee18c72014-02-21 15:35:08 +1100376function wait_for_service {
Dean Troyer3a3a2ba2012-12-11 15:26:24 -0600377 local timeout=$1
378 local url=$2
Atsushi SAKAI2ca8af42015-12-08 15:36:13 +0900379 time_start "wait_for_service"
sridhargaddamb5ab6462015-02-24 07:23:24 +0000380 timeout $timeout sh -c "while ! $CURL_GET -k --noproxy '*' -s $url >/dev/null; do sleep 1; done"
Atsushi SAKAI2ca8af42015-12-08 15:36:13 +0900381 time_stop "wait_for_service"
Dean Troyer3a3a2ba2012-12-11 15:26:24 -0600382}
383
Dean Troyer1a6d4492013-06-03 16:47:36 -0500384
Nachi Uenofda946e2012-10-24 17:26:02 -0700385# ping check
Sean Dagueaf9bf862015-04-16 08:58:32 -0400386# Uses globals ``ENABLED_SERVICES``, ``TOP_DIR``, ``MULTI_HOST``, ``PRIVATE_NETWORK``
387# ping_check <ip> [boot-timeout] [from_net] [expected]
Ian Wienandaee18c72014-02-21 15:35:08 +1100388function ping_check {
Sean Dagueaf9bf862015-04-16 08:58:32 -0400389 local ip=$1
390 local timeout=${2:-30}
391 local from_net=${3:-""}
392 local expected=${4:-True}
393 local op="!"
394 local failmsg="[Fail] Couldn't ping server"
395 local ping_cmd="ping"
Nachi Uenofda946e2012-10-24 17:26:02 -0700396
Sean Dagueaf9bf862015-04-16 08:58:32 -0400397 # if we don't specify a from_net we're expecting things to work
398 # fine from our local box.
399 if [[ -n "$from_net" ]]; then
400 if is_service_enabled neutron; then
401 ping_cmd="$TOP_DIR/tools/ping_neutron.sh $from_net"
402 elif [[ "$MULTI_HOST" = "True" && "$from_net" = "$PRIVATE_NETWORK_NAME" ]]; then
403 # there is no way to address the multihost / private case, bail here for compatibility.
404 # TODO: remove this cruft and redo code to handle this at the caller level.
405 return
Nachi Ueno5db5bfa2012-10-29 11:25:29 -0700406 fi
Nachi Uenofda946e2012-10-24 17:26:02 -0700407 fi
Sean Dagueaf9bf862015-04-16 08:58:32 -0400408
409 # inverse the logic if we're testing no connectivity
410 if [[ "$expected" != "True" ]]; then
411 op=""
412 failmsg="[Fail] Could ping server"
413 fi
414
415 # Because we've transformed this command so many times, print it
416 # out at the end.
417 local check_command="while $op $ping_cmd -c1 -w1 $ip; do sleep 1; done"
418 echo "Checking connectivity with $check_command"
419
420 if ! timeout $timeout sh -c "$check_command"; then
421 die $LINENO $failmsg
422 fi
Nachi Uenofda946e2012-10-24 17:26:02 -0700423}
424
Nachi Ueno6769b162013-08-12 18:18:56 -0700425# Get ip of instance
Ian Wienandaee18c72014-02-21 15:35:08 +1100426function get_instance_ip {
Nachi Ueno6769b162013-08-12 18:18:56 -0700427 local vm_id=$1
428 local network_name=$2
Ian Wienand7ae97292016-02-16 14:50:53 +1100429 local nova_result
Ian Wienandada886d2015-10-07 14:06:26 +1100430 local ip
Ian Wienand7ae97292016-02-16 14:50:53 +1100431
432 nova_result="$(nova show $vm_id)"
Ian Wienandada886d2015-10-07 14:06:26 +1100433 ip=$(echo "$nova_result" | grep "$network_name" | get_field 2)
Nachi Ueno6769b162013-08-12 18:18:56 -0700434 if [[ $ip = "" ]];then
435 echo "$nova_result"
Atsushi SAKAI33c9a672015-11-12 19:50:00 +0900436 die $LINENO "[Fail] Couldn't get ipaddress of VM"
Nachi Ueno6769b162013-08-12 18:18:56 -0700437 fi
438 echo $ip
439}
Dean Troyer1a6d4492013-06-03 16:47:36 -0500440
Nachi Uenofda946e2012-10-24 17:26:02 -0700441# ssh check
Nachi Ueno5db5bfa2012-10-29 11:25:29 -0700442
Dean Troyer1a6d4492013-06-03 16:47:36 -0500443# ssh_check net-name key-file floating-ip default-user active-timeout
Ian Wienandaee18c72014-02-21 15:35:08 +1100444function ssh_check {
Mark McClainb05c8762013-07-06 23:29:39 -0400445 if is_service_enabled neutron; then
446 _ssh_check_neutron "$1" $2 $3 $4 $5
Nachi Ueno5db5bfa2012-10-29 11:25:29 -0700447 return
448 fi
449 _ssh_check_novanet "$1" $2 $3 $4 $5
450}
451
Ian Wienandaee18c72014-02-21 15:35:08 +1100452function _ssh_check_novanet {
Nachi Uenofda946e2012-10-24 17:26:02 -0700453 local NET_NAME=$1
454 local KEY_FILE=$2
455 local FLOATING_IP=$3
456 local DEFAULT_INSTANCE_USER=$4
457 local ACTIVE_TIMEOUT=$5
Dean Troyer6931c132012-11-07 16:51:21 -0600458 local probe_cmd=""
Dean Troyercc6b4432013-04-08 15:38:03 -0500459 if ! timeout $ACTIVE_TIMEOUT sh -c "while ! ssh -o StrictHostKeyChecking=no -i $KEY_FILE ${DEFAULT_INSTANCE_USER}@$FLOATING_IP echo success; do sleep 1; done"; then
Nachi Ueno07115eb2013-02-26 12:38:18 -0800460 die $LINENO "server didn't become ssh-able!"
Nachi Uenofda946e2012-10-24 17:26:02 -0700461 fi
462}
Dean Troyer13dc5cc2012-03-27 14:50:45 -0500463
Vincent Untz856a11e2012-11-21 16:04:12 +0100464
Vincent Untz856a11e2012-11-21 16:04:12 +0100465# Get the location of the $module-rootwrap executables, where module is cinder
466# or nova.
467# get_rootwrap_location module
Ian Wienandaee18c72014-02-21 15:35:08 +1100468function get_rootwrap_location {
Vincent Untz856a11e2012-11-21 16:04:12 +0100469 local module=$1
470
Jakub Ruzicka4196d552013-01-30 15:35:54 +0100471 echo "$(get_python_exec_prefix)/$module-rootwrap"
Vincent Untz856a11e2012-11-21 16:04:12 +0100472}
473
Dean Troyer1a6d4492013-06-03 16:47:36 -0500474
Ian Wienand0488edd2013-04-11 12:04:36 +1000475# Path permissions sanity check
476# check_path_perm_sanity path
Ian Wienandaee18c72014-02-21 15:35:08 +1100477function check_path_perm_sanity {
Ian Wienand0488edd2013-04-11 12:04:36 +1000478 # Ensure no element of the path has 0700 permissions, which is very
479 # likely to cause issues for daemons. Inspired by default 0700
480 # homedir permissions on RHEL and common practice of making DEST in
481 # the stack user's homedir.
482
Ian Wienandada886d2015-10-07 14:06:26 +1100483 local real_path
484 real_path=$(readlink -f $1)
Ian Wienand0488edd2013-04-11 12:04:36 +1000485 local rebuilt_path=""
486 for i in $(echo ${real_path} | tr "/" " "); do
487 rebuilt_path=$rebuilt_path"/"$i
488
489 if [[ $(stat -c '%a' ${rebuilt_path}) = 700 ]]; then
490 echo "*** DEST path element"
491 echo "*** ${rebuilt_path}"
492 echo "*** appears to have 0700 permissions."
Dean Troyerdc97cb72015-03-28 08:20:50 -0500493 echo "*** This is very likely to cause fatal issues for DevStack daemons."
Ian Wienand0488edd2013-04-11 12:04:36 +1000494
495 if [[ -n "$SKIP_PATH_SANITY" ]]; then
496 return
497 else
498 echo "*** Set SKIP_PATH_SANITY to skip this check"
499 die $LINENO "Invalid path permissions"
500 fi
501 fi
502 done
503}
504
Dean Troyer1a6d4492013-06-03 16:47:36 -0500505
Kyle Mestery51a3f1f2013-06-13 11:47:56 +0000506# This function recursively compares versions, and is not meant to be
507# called by anything other than vercmp_numbers below. This function does
508# not work with alphabetic versions.
509#
510# _vercmp_r sep ver1 ver2
511function _vercmp_r {
Sean Dague537d4022013-10-22 07:43:22 -0400512 typeset sep
513 typeset -a ver1=() ver2=()
514 sep=$1; shift
515 ver1=("${@:1:sep}")
516 ver2=("${@:sep+1}")
Kyle Mestery51a3f1f2013-06-13 11:47:56 +0000517
Sean Dague537d4022013-10-22 07:43:22 -0400518 if ((ver1 > ver2)); then
519 echo 1; return 0
520 elif ((ver2 > ver1)); then
521 echo -1; return 0
522 fi
Kyle Mestery51a3f1f2013-06-13 11:47:56 +0000523
Sean Dague537d4022013-10-22 07:43:22 -0400524 if ((sep <= 1)); then
525 echo 0; return 0
526 fi
Kyle Mestery51a3f1f2013-06-13 11:47:56 +0000527
Sean Dague537d4022013-10-22 07:43:22 -0400528 _vercmp_r $((sep-1)) "${ver1[@]:1}" "${ver2[@]:1}"
Kyle Mestery51a3f1f2013-06-13 11:47:56 +0000529}
530
531
532# This function compares two versions and is meant to be called by
533# external callers. Please note the function assumes non-alphabetic
534# versions. For example, this will work:
535#
536# vercmp_numbers 1.10 1.4
537#
538# The above will return "1", as 1.10 is greater than 1.4.
539#
540# vercmp_numbers 5.2 6.4
541#
542# The above will return "-1", as 5.2 is less than 6.4.
543#
544# vercmp_numbers 4.0 4.0
545#
546# The above will return "0", as the versions are equal.
547#
548# vercmp_numbers ver1 ver2
Ian Wienandaee18c72014-02-21 15:35:08 +1100549function vercmp_numbers {
Sean Dague537d4022013-10-22 07:43:22 -0400550 typeset v1=$1 v2=$2 sep
551 typeset -a ver1 ver2
Kyle Mestery51a3f1f2013-06-13 11:47:56 +0000552
Ian Wienand2ba36cd2015-11-12 13:52:36 +1100553 deprecated "vercmp_numbers is deprecated for more generic vercmp"
554
Sean Dague537d4022013-10-22 07:43:22 -0400555 IFS=. read -ra ver1 <<< "$v1"
556 IFS=. read -ra ver2 <<< "$v2"
Kyle Mestery51a3f1f2013-06-13 11:47:56 +0000557
Sean Dague537d4022013-10-22 07:43:22 -0400558 _vercmp_r "${#ver1[@]}" "${ver1[@]}" "${ver2[@]}"
Kyle Mestery51a3f1f2013-06-13 11:47:56 +0000559}
560
Ian Wienand2ba36cd2015-11-12 13:52:36 +1100561# vercmp ver1 op ver2
562# Compare VER1 to VER2
563# - op is one of < <= == >= >
564# - returns true if satisified
565# e.g.
566# if vercmp 1.0 "<" 2.0; then
567# ...
568# fi
569function vercmp {
570 local v1=$1
571 local op=$2
572 local v2=$3
573 local result
574
575 # sort the two numbers with sort's "-V" argument. Based on if v2
576 # swapped places with v1, we can determine ordering.
577 result=$(echo -e "$v1\n$v2" | sort -V | head -1)
578
579 case $op in
580 "==")
581 [ "$v1" = "$v2" ]
582 return
583 ;;
584 ">")
585 [ "$v1" != "$v2" ] && [ "$result" = "$v2" ]
586 return
587 ;;
588 "<")
589 [ "$v1" != "$v2" ] && [ "$result" = "$v1" ]
590 return
591 ;;
592 ">=")
593 [ "$result" = "$v2" ]
594 return
595 ;;
596 "<=")
597 [ "$result" = "$v1" ]
598 return
599 ;;
600 *)
601 die $LINENO "unrecognised op: $op"
602 ;;
603 esac
604}
Kyle Mestery51a3f1f2013-06-13 11:47:56 +0000605
Salvatore Orlando05ae8332013-08-20 14:51:08 -0700606# This function sets log formatting options for colorizing log
607# output to stdout. It is meant to be called by lib modules.
608# The last two parameters are optional and can be used to specify
609# non-default value for project and user format variables.
610# Defaults are respectively 'project_name' and 'user_name'
611#
612# setup_colorized_logging something.conf SOMESECTION
Ian Wienandaee18c72014-02-21 15:35:08 +1100613function setup_colorized_logging {
Salvatore Orlando05ae8332013-08-20 14:51:08 -0700614 local conf_file=$1
615 local conf_section=$2
616 local project_var=${3:-"project_name"}
617 local user_var=${4:-"user_name"}
618 # Add color to logging output
619 iniset $conf_file $conf_section logging_context_format_string "%(asctime)s.%(msecs)03d %(color)s%(levelname)s %(name)s [%(request_id)s %("$user_var")s %("$project_var")s%(color)s] %(instance)s%(color)s%(message)s"
620 iniset $conf_file $conf_section logging_default_format_string "%(asctime)s.%(msecs)03d %(color)s%(levelname)s %(name)s [-%(color)s] %(instance)s%(color)s%(message)s"
621 iniset $conf_file $conf_section logging_debug_format_suffix "from (pid=%(process)d) %(funcName)s %(pathname)s:%(lineno)d"
622 iniset $conf_file $conf_section logging_exception_prefix "%(color)s%(asctime)s.%(msecs)03d TRACE %(name)s %(instance)s"
623}
624
Ian Wienand54e39102014-06-03 16:05:12 +1000625# These functions are provided for basic fall-back functionality for
Dean Troyerdc97cb72015-03-28 08:20:50 -0500626# projects that include parts of DevStack (Grenade). stack.sh will
627# override these with more specific versions for DevStack (with fancy
Ian Wienand54e39102014-06-03 16:05:12 +1000628# spinners, etc). We never override an existing version
629if ! function_exists echo_summary; then
630 function echo_summary {
631 echo $@
632 }
633fi
634if ! function_exists echo_nolog; then
635 function echo_nolog {
636 echo $@
637 }
638fi
Dean Troyerdff49a22014-01-30 15:37:40 -0600639
Sébastien Han36f2f022014-01-06 18:09:26 +0100640
641# create_disk - Create backing disk
642function create_disk {
643 local node_number
644 local disk_image=${1}
645 local storage_data_dir=${2}
646 local loopback_disk_size=${3}
647
648 # Create a loopback disk and format it to XFS.
649 if [[ -e ${disk_image} ]]; then
650 if egrep -q ${storage_data_dir} /proc/mounts; then
651 sudo umount ${storage_data_dir}/drives/sdb1
652 sudo rm -f ${disk_image}
653 fi
654 fi
655
656 sudo mkdir -p ${storage_data_dir}/drives/images
657
658 sudo truncate -s ${loopback_disk_size} ${disk_image}
659
660 # Make a fresh XFS filesystem. Use bigger inodes so xattr can fit in
661 # a single inode. Keeping the default inode size (256) will result in multiple
662 # inodes being used to store xattr. Retrieving the xattr will be slower
663 # since we have to read multiple inodes. This statement is true for both
664 # Swift and Ceph.
665 sudo mkfs.xfs -f -i size=1024 ${disk_image}
666
667 # Mount the disk with mount options to make it as efficient as possible
668 if ! egrep -q ${storage_data_dir} /proc/mounts; then
669 sudo mount -t xfs -o loop,noatime,nodiratime,nobarrier,logbufs=8 \
670 ${disk_image} ${storage_data_dir}
671 fi
672}
673
Dean Troyer27e32692012-03-16 16:16:56 -0500674# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +1100675$_XTRACE_FUNCTIONS
Dean Troyer4a43b7b2012-08-28 17:43:40 -0500676
Dean Troyer4a43b7b2012-08-28 17:43:40 -0500677# Local variables:
Sean Dague584d90e2013-03-29 14:34:53 -0400678# mode: shell-script
Andrew Laskif900bd72012-09-05 17:23:14 -0400679# End: