1#!/usr/bin/env bash 2 3# create_vbox.sh 4# 5# Creates a virtual box with vagrant in the $PWD. 6# 7# This script creates a subdirectory called $PWD/<distro> and copies the Vagrantfile 8# into that directory before running 'vagrant up' 9 10set -e 11 12VAGRANT_TARGET="$PWD" 13 14DIR="$(cd "$(dirname $0)" && pwd)" 15SPDK_DIR="$(cd "${DIR}/../../" && pwd)" 16 17# The command line help 18display_help() { 19 echo 20 echo " Usage: ${0##*/} [-b nvme-backing-file] [-n <num-cpus>] [-s <ram-size>] [-x <http-proxy>] [-hvrldcu] <distro>" 21 echo 22 echo " distro = <centos7 | centos8| ubuntu1604 | ubuntu1804 | ubuntu2004 |" 23 echo " fedora31 | fedora32 | fedora33 | freebsd11 | freebsd12 | arch | clearlinux>" 24 echo 25 echo " -s <ram-size> in MB Default: ${SPDK_VAGRANT_VMRAM}" 26 echo " -n <num-cpus> 1 to 4 Default: ${SPDK_VAGRANT_VMCPU}" 27 echo " -x <http-proxy> Default: \"${SPDK_VAGRANT_HTTP_PROXY}\"" 28 echo " -p <provider> \"libvirt\" or \"virtualbox\". Default: ${SPDK_VAGRANT_PROVIDER}" 29 echo " -b <nvme-backing-file> Emulated NVMe options." 30 echo " If no -b option is specified then this option defaults to emulating single" 31 echo " NVMe with 1 namespace and assumes path: /var/lib/libvirt/images/nvme_disk.img" 32 echo " -b option can be used multiple times for attaching multiple files to the VM" 33 echo " Parameters for -b option: <path>,<type>,<namespaces>,<cmb>,<pmr_file[:pmr_size]>" 34 echo " Available types: nvme, ocssd." 35 echo " Default pmr size: 16M" 36 echo " Default cmb: false" 37 echo " -c Create all above disk, default 0" 38 echo " -H Use hugepages for allocating VM memory. Only for libvirt provider. Default: false." 39 echo " -u Use password authentication to the VM instead of SSH keys." 40 echo " -l Use a local copy of spdk, don't try to rsync from the host." 41 echo " -a Copy spdk/autorun.sh artifacts from VM to host system." 42 echo " -d Deploy a test vm by provisioning all prerequisites for spdk autotest" 43 echo " -o Add network interface for openstack tests" 44 echo " --qemu-emulator=<path> Path to custom QEMU binary. Only works with libvirt provider" 45 echo " --vagrantfiles-dir=<path> Destination directory to put Vagrantfile into." 46 echo " --package-box Install all dependencies for SPDK and create a local vagrant box version." 47 echo " --vagrantfile=<path> Path to a custom Vagrantfile" 48 echo " -r dry-run" 49 echo " -h help" 50 echo " -v verbose" 51 echo 52 echo " Examples:" 53 echo 54 echo " $0 -x http://user:password@host:port fedora33" 55 echo " $0 -s 2048 -n 2 ubuntu16" 56 echo " $0 -rv freebsd" 57 echo " $0 fedora33" 58 echo " $0 -b /var/lib/libvirt/images/nvme1.img,nvme,1 fedora33" 59 echo " $0 -b /var/lib/libvirt/images/ocssd.img,ocssd fedora33" 60 echo " $0 -b /var/lib/libvirt/images/nvme5.img,nvme,5 -b /var/lib/libvirt/images/ocssd.img,ocssd fedora33" 61 echo 62} 63 64# Set up vagrant proxy. Assumes git-bash on Windows 65# https://stackoverflow.com/questions/19872591/how-to-use-vagrant-in-a-proxy-environment 66SPDK_VAGRANT_HTTP_PROXY="" 67 68VERBOSE=0 69HELP=0 70COPY_SPDK_DIR=1 71COPY_SPDK_ARTIFACTS=0 72DRY_RUN=0 73DEPLOY_TEST_VM=0 74SPDK_VAGRANT_DISTRO="distro" 75SPDK_VAGRANT_VMCPU=4 76SPDK_VAGRANT_VMRAM=4096 77SPDK_VAGRANT_PROVIDER="virtualbox" 78SPDK_QEMU_EMULATOR="" 79SPDK_OPENSTACK_NETWORK=0 80OPTIND=1 81NVME_DISKS_TYPE="" 82NVME_DISKS_NAMESPACES="" 83NVME_FILE="" 84NVME_AUTO_CREATE=0 85VAGRANTFILE_DIR="" 86VAGRANT_PASSWORD_AUTH=0 87VAGRANT_PACKAGE_BOX=0 88VAGRANT_HUGE_MEM=0 89VAGRANTFILE=$DIR/Vagrantfile 90 91while getopts ":b:n:s:x:p:uvcraldoHh-:" opt; do 92 case "${opt}" in 93 -) 94 case "${OPTARG}" in 95 package-box) VAGRANT_PACKAGE_BOX=1 ;; 96 qemu-emulator=*) SPDK_QEMU_EMULATOR="${OPTARG#*=}" ;; 97 vagrantfiles-dir=*) VAGRANTFILE_DIR="${OPTARG#*=}" ;; 98 vagrantfile=*) [[ -n ${OPTARG#*=} ]] && VAGRANTFILE="${OPTARG#*=}" ;; 99 *) echo "Invalid argument '$OPTARG'" ;; 100 esac 101 ;; 102 x) 103 http_proxy=$OPTARG 104 https_proxy=$http_proxy 105 SPDK_VAGRANT_HTTP_PROXY="${http_proxy}" 106 ;; 107 n) 108 SPDK_VAGRANT_VMCPU=$OPTARG 109 ;; 110 s) 111 SPDK_VAGRANT_VMRAM=$OPTARG 112 ;; 113 p) 114 SPDK_VAGRANT_PROVIDER=$OPTARG 115 ;; 116 v) 117 VERBOSE=1 118 ;; 119 c) 120 NVME_AUTO_CREATE=1 121 ;; 122 r) 123 DRY_RUN=1 124 ;; 125 h) 126 display_help >&2 127 exit 0 128 ;; 129 a) 130 COPY_SPDK_ARTIFACTS=1 131 ;; 132 l) 133 COPY_SPDK_DIR=0 134 ;; 135 d) 136 DEPLOY_TEST_VM=1 137 ;; 138 o) 139 SPDK_OPENSTACK_NETWORK=1 140 ;; 141 b) 142 NVME_FILE+="${OPTARG#*=} " 143 ;; 144 u) 145 VAGRANT_PASSWORD_AUTH=1 146 ;; 147 H) 148 VAGRANT_HUGE_MEM=1 149 ;; 150 *) 151 echo " Invalid argument: -$OPTARG" >&2 152 echo " Try: \"$0 -h\"" >&2 153 exit 1 154 ;; 155 esac 156done 157 158shift "$((OPTIND - 1))" # Discard the options and sentinel -- 159 160SPDK_VAGRANT_DISTRO="$*" 161 162case "${SPDK_VAGRANT_DISTRO}" in 163 centos[78]) ;& 164 ubuntu1[68]04 | ubuntu2004) ;& 165 fedora3[1-3]) ;& 166 freebsd1[12]) ;& 167 arch | clearlinux) 168 export SPDK_VAGRANT_DISTRO 169 ;; 170 *) 171 echo " Invalid argument \"${SPDK_VAGRANT_DISTRO}\"" >&2 172 echo " Try: \"$0 -h\"" >&2 173 exit 1 174 ;; 175esac 176 177if [ -z "$NVME_FILE" ]; then 178 TMP="/var/lib/libvirt/images/nvme_disk.img" 179 NVME_DISKS_TYPE="nvme" 180else 181 TMP="" 182 for args in $NVME_FILE; do 183 while IFS=, read -r path type namespace cmb pmr; do 184 TMP+="$path," 185 if [ -z "$type" ]; then 186 type="nvme" 187 fi 188 if [[ -n $cmb ]]; then 189 NVME_CMB=${NVME_CMB:+$NVME_CMB,}$cmb 190 fi 191 if [[ -n $pmr ]]; then 192 NVME_PMR=${NVME_PMR:+$NVME_PMR,}$pmr 193 fi 194 NVME_DISKS_TYPE+="$type," 195 if [ -z "$namespace" ] && [ -n "$SPDK_QEMU_EMULATOR" ]; then 196 namespace="1" 197 fi 198 NVME_DISKS_NAMESPACES+="$namespace," 199 if [ ${NVME_AUTO_CREATE} = 1 ]; then 200 $SPDK_DIR/scripts/vagrant/create_nvme_img.sh -t $type -n $path 201 fi 202 done <<< $args 203 done 204fi 205NVME_FILE=$TMP 206 207if [ ${VERBOSE} = 1 ]; then 208 echo 209 echo DIR=${DIR} 210 echo SPDK_DIR=${SPDK_DIR} 211 echo VAGRANT_TARGET=${VAGRANT_TARGET} 212 echo HELP=$HELP 213 echo DRY_RUN=$DRY_RUN 214 echo NVME_FILE=$NVME_FILE 215 echo NVME_DISKS_TYPE=$NVME_DISKS_TYPE 216 echo NVME_AUTO_CREATE=$NVME_AUTO_CREATE 217 echo NVME_DISKS_NAMESPACES=$NVME_DISKS_NAMESPACES 218 echo NVME_CMB=$NVME_CMB 219 echo NVME_PMR=$NVME_PMR 220 echo SPDK_VAGRANT_DISTRO=$SPDK_VAGRANT_DISTRO 221 echo SPDK_VAGRANT_VMCPU=$SPDK_VAGRANT_VMCPU 222 echo SPDK_VAGRANT_VMRAM=$SPDK_VAGRANT_VMRAM 223 echo SPDK_VAGRANT_PROVIDER=$SPDK_VAGRANT_PROVIDER 224 echo SPDK_VAGRANT_HTTP_PROXY=$SPDK_VAGRANT_HTTP_PROXY 225 echo SPDK_QEMU_EMULATOR=$SPDK_QEMU_EMULATOR 226 echo SPDK_OPENSTACK_NETWORK=$SPDK_OPENSTACK_NETWORK 227 echo VAGRANT_PACKAGE_BOX=$VAGRANT_PACKAGE_BOX 228 echo VAGRANTFILE=$VAGRANTFILE 229 echo 230fi 231 232export SPDK_VAGRANT_HTTP_PROXY 233export SPDK_VAGRANT_VMCPU 234export SPDK_VAGRANT_VMRAM 235export SPDK_DIR 236export SPDK_OPENSTACK_NETWORK 237export COPY_SPDK_DIR 238export COPY_SPDK_ARTIFACTS 239export DEPLOY_TEST_VM 240export NVME_CMB 241export NVME_PMR 242export NVME_DISKS_TYPE 243export NVME_DISKS_NAMESPACES 244export NVME_FILE 245export VAGRANT_PASSWORD_AUTH 246export VAGRANT_HUGE_MEM 247 248if [ -n "$SPDK_VAGRANT_PROVIDER" ]; then 249 provider="--provider=${SPDK_VAGRANT_PROVIDER}" 250fi 251 252if [ -n "$SPDK_VAGRANT_PROVIDER" ]; then 253 export SPDK_VAGRANT_PROVIDER 254fi 255 256if [ -n "$SPDK_QEMU_EMULATOR" ] && [ "$SPDK_VAGRANT_PROVIDER" == "libvirt" ]; then 257 export SPDK_QEMU_EMULATOR 258fi 259 260if [ ${DRY_RUN} = 1 ]; then 261 echo "Environemnt Variables" 262 printenv SPDK_VAGRANT_DISTRO 263 printenv SPDK_VAGRANT_VMRAM 264 printenv SPDK_VAGRANT_VMCPU 265 printenv SPDK_VAGRANT_PROVIDER 266 printenv SPDK_VAGRANT_HTTP_PROXY 267 printenv SPDK_QEMU_EMULATOR 268 printenv NVME_DISKS_TYPE 269 printenv NVME_AUTO_CREATE 270 printenv NVME_DISKS_NAMESPACES 271 printenv NVME_FILE 272 printenv SPDK_DIR 273 printenv VAGRANT_HUGE_MEM 274 printenv VAGRANTFILE 275fi 276if [ -z "$VAGRANTFILE_DIR" ]; then 277 VAGRANTFILE_DIR="${VAGRANT_TARGET}/${SPDK_VAGRANT_DISTRO}-${SPDK_VAGRANT_PROVIDER}" 278 export VAGRANTFILE_DIR 279fi 280 281if [ -d "${VAGRANTFILE_DIR}" ]; then 282 echo "Error: ${VAGRANTFILE_DIR} already exists!" 283 exit 1 284fi 285 286if [[ ! -f $VAGRANTFILE ]]; then 287 echo "$VAGRANTFILE is not a regular file!" 288 exit 1 289fi 290 291if [ ${DRY_RUN} != 1 ]; then 292 mkdir -vp "${VAGRANTFILE_DIR}" 293 ln -s "$VAGRANTFILE" "${VAGRANTFILE_DIR}/Vagrantfile" 294 pushd "${VAGRANTFILE_DIR}" 295 if [ -n "${http_proxy}" ]; then 296 export http_proxy 297 export https_proxy 298 if echo "$SPDK_VAGRANT_DISTRO" | grep -q freebsd; then 299 cat > ~/vagrant_pkg.conf << EOF 300pkg_env: { 301http_proxy: ${http_proxy} 302} 303EOF 304 fi 305 fi 306 mkdir -p "${VAGRANTFILE_DIR}/output" 307 vagrant up $provider 308 if [ ${VAGRANT_PACKAGE_BOX} == 1 ]; then 309 vagrant ssh -c 'sudo spdk_repo/spdk/scripts/vagrant/update.sh' 310 vagrant halt 311 vagrant package --output spdk_${SPDK_VAGRANT_DISTRO}.box 312 vagrant box add spdk/${SPDK_VAGRANT_DISTRO} spdk_${SPDK_VAGRANT_DISTRO}.box \ 313 && rm spdk_${SPDK_VAGRANT_DISTRO}.box 314 vagrant destroy 315 fi 316 echo "" 317 echo " SUCCESS!" 318 echo "" 319 echo " cd to ${VAGRANTFILE_DIR} and type \"vagrant ssh\" to use." 320 echo " Use vagrant \"suspend\" and vagrant \"resume\" to stop and start." 321 echo " Use vagrant \"destroy\" followed by \"rm -rf ${VAGRANTFILE_DIR}\" to destroy all trace of vm." 322 echo "" 323fi 324