lint: fix shellcheck findings in embedded shell scripts

- prevent wordsplitting and accidental globbling by quoting variables
- use parameter expansion with braces for consistency
- remove a number of useless cat-expressions
- replace printf with echo for less differences across examples
- align coreos-installer snippets for a more consistent reading experience

vmware:
- use correct gzip file ending (See #524 (comment) for details) in example

modules/ROOT/pages/getting-started-libvirt.adoc

@@ -8,7 +8,7 @@ STREAM="stable"
 # as an installed binary:
 coreos-installer download -s "${STREAM}" -p qemu -f qcow2.xz --decompress -C ~/.local/share/libvirt/images/
 # or as a container:
-podman run --pull=always --rm -v $HOME/.local/share/libvirt/images/:/data -w /data \
+podman run --pull=always --rm -v "${HOME}/.local/share/libvirt/images/:/data" -w /data \
     quay.io/coreos/coreos-installer:release download -s "${STREAM}" -p qemu -f qcow2.xz --decompress
 ----
 +

modules/ROOT/pages/producing-ign.adoc

@@ -49,17 +49,17 @@ podman run --interactive --rm quay.io/coreos/butane:release \
 [source,bash]
 ----
 podman run --interactive --rm --security-opt label=disable \
-       --volume ${PWD}:/pwd --workdir /pwd quay.io/coreos/butane:release \
+       --volume "${PWD}:/pwd" --workdir /pwd quay.io/coreos/butane:release \
        --pretty --strict your_config.bu > transpiled_config.ign
 ----
 
 To make it simpler to type, you may also add the following alias to your shell configuration:
 
 [source,bash]
 ----
-alias butane='podman run --rm --interactive       \
-              --security-opt label=disable        \
-              --volume ${PWD}:/pwd --workdir /pwd \
+alias butane='podman run --rm --interactive         \
+              --security-opt label=disable          \
+              --volume "${PWD}:/pwd" --workdir /pwd \
               quay.io/coreos/butane:release'
 ----
 

modules/ROOT/pages/provisioning-aliyun.adoc

@@ -140,7 +140,7 @@ VSWITCH_ID=$(aliyun vpc CreateVSwitch \
 ----
 KEY_PAIR_NAME="fcos-key"
 PUBLIC_KEY_PATH="<Please fill the path to your public key>"
-PUBLIC_KEY_BODY=$(cat ${PUBLIC_KEY_PATH})
+PUBLIC_KEY_BODY=$(cat "${PUBLIC_KEY_PATH}")
 aliyun ecs ImportKeyPair --region="${REGION}" \
     --KeyPairName="${KEY_PAIR_NAME}" --PublicKeyBody="${PUBLIC_KEY_BODY}"
 ----

modules/ROOT/pages/provisioning-exoscale.adoc

@@ -22,7 +22,7 @@ Exoscale provides https://community.exoscale.com/documentation/compute/custom-te
 [source, bash]
 ----
 STREAM="stable"
-coreos-installer download -d -s "${STREAM}" -p exoscale -f qcow2.xz
+coreos-installer download -d -s ${STREAM} -p exoscale -f qcow2.xz
 ----
 
 Alternatively, QCOW2 images can be downloaded from the https://fedoraproject.org/coreos/download/?stream=stable#cloud_images[download page] and manually decompressed.
@@ -35,15 +35,15 @@ Next you can https://community.exoscale.com/documentation/compute/custom-templat
 # Set the version and calcuate the checksum
 FCOS_VERSION='...'
 FILE="fedora-coreos-${FCOS_VERSION}-exoscale.x86_64.qcow2"
-CHECKSUM=$(md5sum $FILE | cut -d " " -f 1)
+CHECKSUM=$(md5sum "${FILE}" | cut -d " " -f 1)
 
 # Upload to object storage
 BUCKET='newbucket'
 exo storage mb "sos://${BUCKET}"
-exo storage upload --acl public-read $FILE "sos://${BUCKET}/image-import/"
+exo storage upload --acl public-read "${FILE}" "sos://${BUCKET}/image-import/"
 
 # Create the template using given URL and CHECKSUM
-URL=$(exo storage show "sos://${BUCKET}/image-import/$FILE" --output-template "{{.URL}}")
+URL=$(exo storage show "sos://${BUCKET}/image-import/${FILE}" --output-template "{{.URL}}")
 TEMPLATE="fedora-coreos-${FCOS_VERSION}"
 exo compute instance-template register --boot-mode=uefi $TEMPLATE $URL $CHECKSUM
 ----
@@ -65,18 +65,18 @@ NAME='worker'
 TYPE='standard.medium'
 DISK='10' # in GiB
 SSHKEY='mykey'
-TEMPLATE=$TEMPLATE # template name set above
-exo compute instance create $NAME \
+TEMPLATE="${TEMPLATE}" # template name set above
+exo compute instance create "${NAME}" \
     --disk-size $DISK \
-    --ssh-key $SSHKEY \
+    --ssh-key "${SSHKEY}" \
     --template $TEMPLATE \
     --template-visibility private \
     --cloud-init "path/to/ignition-file.ign"
 ----
 
 NOTE: If just SSH access is desired and no further customization is required, you don't need to pass any Ignition file and can omit the `--cloud-init` argument.
 
-TIP: You can find out the instance's assigned IP by running `exo compute instance show $NAME`
+TIP: You can find out the instance's assigned IP by running `exo compute instance show "${NAME}"`
 
 You now should be able to SSH into the instance using the associated IP address.
 

modules/ROOT/pages/provisioning-ibmcloud.adoc

@@ -47,7 +47,7 @@ The following sets of commands will show you how to download the most recent ima
 ----
 STREAM='stable'
 ARCH='x86_64' # or 's390x'
-coreos-installer download -s $STREAM -a $ARCH -p ibmcloud -f qcow2.xz --decompress
+coreos-installer download -s ${STREAM} -a ${ARCH} -p ibmcloud -f qcow2.xz --decompress
 ----
 
 .Create a Service Account for uploading and an Authorization Policy to allow creating images from the uploaded objects.
@@ -66,7 +66,7 @@ ibmcloud iam authorization-policy-create is --source-resource-type image cloud-o
 FCOS_VERSION='...'
 FILE="fedora-coreos-${FCOS_VERSION}-ibmcloud.${ARCH}.qcow2"
 ibmcloud cos create-bucket --bucket $BUCKET --ibm-service-instance-id $SERVICE_INSTANCE_ID
-ibmcloud cos upload --bucket=$BUCKET --key=$FILE --file=$FILE
+ibmcloud cos upload --bucket=$BUCKET --key="${FILE}" --file="${FILE}"
 ----
 
 .Create the image from the storage object.
@@ -76,7 +76,7 @@ IMAGE=${FILE:0:-6}     # pull off .qcow2
 IMAGE=${IMAGE//[._]/-} # replace . and _ with -
 [ $ARCH == 'x86_64' ] && OSNAME='fedora-coreos-stable-amd64'
 [ $ARCH == 's390x' ] && OSNAME='red-8-s390x-byol'
-ibmcloud is image-create $IMAGE --file "cos://${REGION}/${BUCKET}/${FILE}" --os-name $OSNAME
+ibmcloud is image-create "${IMAGE}" --file "cos://${REGION}/${BUCKET}/${FILE}" --os-name $OSNAME
 ----
 
 NOTE: For `s390x` we use `--os-name=red-8-s390x-byol` (a RHEL 8 profile) here because there is not currently a `fedora-coreos-stable-s390x` profile to use.
@@ -105,10 +105,10 @@ VPC='r014-c9c65cc4-cfd3-44de-ad54-865aac182ea1'    # `ibmcloud is vpcs`
 IMAGE='r014-1823b4cf-9c63-499e-8a27-b771be714ad8'  # `ibmcloud is images --visibility private`
 SUBNET='0777-bf99cbf4-bc82-4c46-895a-5b7304201182' # `ibmcloud is subnets`
 SSHKEY='r014-b44c37d0-5c21-4c2b-aba2-438a5b0a228d' # `ibmcloud is keys`
-ibmcloud is instance-create $NAME $VPC $ZONE $PROFILE $SUBNET --image $IMAGE --keys $SSHKEY --user-data @example.ign
+ibmcloud is instance-create "${NAME}" $VPC $ZONE $PROFILE $SUBNET --image $IMAGE --keys $SSHKEY --user-data @example.ign
 ----
 
-TIP: If needed you may have to first create a subnet with a command like `'ibmcloud is subnet-create my-subnet $VPC --ipv4-address-count 256 --zone $ZONE'`.
+TIP: If needed you may have to first create a subnet with a command like `ibmcloud is subnet-create my-subnet $VPC --ipv4-address-count 256 --zone $ZONE`.
 
 WARNING: Make sure you choose an appropriate instance type based on your architecture. For example, you may want to use `bz2-2x8` instead of `bx2-2x8` above if you are targeting `s390x`.
 

modules/ROOT/pages/provisioning-openstack.adoc

@@ -31,7 +31,7 @@ NOTE: For more information on FCOS stream offerings see xref:update-streams.adoc
 [source, bash]
 ----
 STREAM='stable'
-coreos-installer download --decompress -s $STREAM -p openstack -f qcow2.xz
+coreos-installer download --decompress -s ${STREAM} -p openstack -f qcow2.xz
 ----
 
 Alternatively, you can manually download an OpenStack image from the
@@ -45,15 +45,15 @@ Verify the download, following the instructions on that page, and decompress it.
 ----
 FILE=fedora-coreos-XX.XXXXXXXX.X.X-openstack.x86_64.qcow2
 IMAGE=${FILE:0:-6} # pull off .qcow2
-openstack image create --disk-format=qcow2 --min-disk=10 --min-ram=2 --file=$FILE $IMAGE
+openstack image create --disk-format=qcow2 --min-disk=10 --min-ram=2 --file="${FILE}" "${IMAGE}"
 ----
 
 NOTE: If you're uploading an `aarch64` disk image then add `--property architecture=aarch64`.
 
 .Monitor image creation progress by listing the image
 [source, bash]
 ----
-openstack image list --name=$IMAGE
+openstack image list --name="${IMAGE}"
 ----
 
 == Launching a VM instance
@@ -69,22 +69,22 @@ a file in the current directory named `example.ign`.
 .Launching a VM instance
 [source, bash]
 ----
-OPENSTACK_NETWORK=private
-OPENSTACK_KEYPAIR=mykeypair # optional
-OPENSTACK_FLAVOR=v1-standard-2
-INSTANCE_NAME=myinstance # choose a name
-openstack server create            \
-     --key-name=$OPENSTACK_KEYPAIR \
-     --network=$OPENSTACK_NETWORK  \
-     --flavor=$OPENSTACK_FLAVOR    \
-     --image=$IMAGE                \
-     --user-data ./example.ign     \
-     $INSTANCE_NAME
+OPENSTACK_NETWORK="private"
+OPENSTACK_KEYPAIR="mykeypair" # optional
+OPENSTACK_FLAVOR="v1-standard-2"
+INSTANCE_NAME="myinstance" # choose a name
+openstack server create                \
+     --key-name="${OPENSTACK_KEYPAIR}" \
+     --network=$OPENSTACK_NETWORK      \
+     --flavor=$OPENSTACK_FLAVOR        \
+     --image="${IMAGE}"                \
+     --user-data ./example.ign         \
+     "${INSTANCE_NAME}"
 ----
 
 NOTE: Specifying `--key-name` is optional if you provide an SSH key in your Ignition config.
 
-TIP: Monitor progress of the instance creation with `openstack server show $INSTANCE_NAME`.
+TIP: Monitor progress of the instance creation with `openstack server show "${INSTANCE_NAME}"`.
 
 Next, if you'd like to SSH into the instance from outside the
 OpenStack environment, you can assign a public IP to the instance:
@@ -96,7 +96,7 @@ OPENSTACK_NETWORK=public
 openstack floating ip create $OPENSTACK_NETWORK
 
 FLOATING_IP=1.1.1.1  # from just created floating IP
-openstack server add floating ip $INSTANCE_NAME $FLOATING_IP
+openstack server add floating ip "${INSTANCE_NAME}" $FLOATING_IP
 ----
 
 You now should be able to SSH into the instance using the floating IP address.

modules/ROOT/pages/provisioning-qemu.adoc

@@ -25,7 +25,7 @@ Fetch the latest image suitable for your target stream (or https://fedoraproject
 [source, bash]
 ----
 STREAM="stable"
-coreos-installer download -s "${STREAM}" -p qemu -f qcow2.xz --decompress -C ~/.local/share/libvirt/images/
+coreos-installer download -s ${STREAM} -p qemu -f qcow2.xz --decompress -C ~/.local/share/libvirt/images/
 ----
 
 === Setting up a new VM
@@ -47,14 +47,14 @@ IGNITION_DEVICE_ARG="-fw_cfg name=opt/com.coreos/config,file=${IGNITION_CONFIG}"
 IGNITION_DEVICE_ARG="-drive file=${IGNITION_CONFIG},if=none,format=raw,readonly=on,id=ignition -device virtio-blk,serial=ignition,drive=ignition"
 
 qemu-kvm -m 2048 -cpu host -nographic -snapshot \
-  -drive if=virtio,file=${IMAGE} ${IGNITION_DEVICE_ARG} \
+  -drive if=virtio,file="${IMAGE}" ${IGNITION_DEVICE_ARG} \
   -nic user,model=virtio,hostfwd=tcp::2222-:22
 ----
 
 .Launching FCOS with QEMU (persistent storage)
 [source, bash]
 ----
-qemu-img create -f qcow2 -F qcow2 -b ${IMAGE} my-fcos-vm.qcow2
+qemu-img create -f qcow2 -F qcow2 -b "${IMAGE}" my-fcos-vm.qcow2
 qemu-kvm -m 2048 -cpu host -nographic \
   -drive if=virtio,file=my-fcos-vm.qcow2 ${IGNITION_DEVICE_ARG} \
   -nic user,model=virtio,hostfwd=tcp::2222-:22

modules/ROOT/pages/provisioning-raspberry-pi4.adoc

@@ -56,8 +56,8 @@ Run `coreos-installer` to install to the target disk. There are https://coreos.g
 [source, bash]
 ----
 FCOSDISK=/dev/sdX
-STREAM=stable # or `next` or `testing`
-sudo coreos-installer install -a aarch64 -s $STREAM -i config.ign $FCOSDISK
+STREAM="stable" # or `next` or `testing`
+sudo coreos-installer install -a aarch64 -s ${STREAM} -i config.ign $FCOSDISK
 ----
 
 NOTE: Make sure you provide an xref:producing-ign.adoc[Ignition config] when you run `coreos-installer`.
@@ -158,7 +158,7 @@ First, run `coreos-installer` to install to the target disk:
 ----
 FCOSDISK=/dev/sdX
 STREAM=stable # or `next` or `testing`
-sudo coreos-installer install -a aarch64 -s $STREAM -i config.ign $FCOSDISK
+sudo coreos-installer install -a aarch64 -s ${STREAM} -i config.ign $FCOSDISK
 ----
 
 Now you can mount the 2nd partition and pull down the EDK2 firmware files:

modules/ROOT/pages/provisioning-vmware.adoc

@@ -39,15 +39,15 @@ For maximum compatibility, it is recommended to use `base64` encoding and to pre
 [source, bash]
 ----
 CONFIG_ENCODING='base64'
-CONFIG_ENCODED=$(cat example.ign | base64 -w0 -)
+CONFIG_ENCODED=$(base64 -w0 example.ign)
 ----
 
 An alternative to plain `base64` encoding is `gzip+base64` as described in the https://coreos.github.io/ignition/supported-platforms/[Ignition supported platforms]. This is especially useful when submitting the Ignition config via `govc` as an _inline_ argument. In that case the encoded config is limited to slightly under 128 KiB on Linux, 256 KiB on macOS, and 32 KiB on Windows (8 KiB if using `cmd.exe` or PowerShell). If your config is larger than that limit, you may be able to submit it inline after compressing it with `gzip`.
 
 [source, bash]
 ----
 CONFIG_ENCODING='gzip+base64'
-CONFIG_ENCODED=$(cat example.ign | gzip -9 | base64 -w0 -)
+CONFIG_ENCODED=$(gzip -9c example.ign | base64 -w0 -)
 ----
 
 If your generated Ignition configuration is still too large, you will encounter an `Argument list too long` error or similar. The solution to that problem depends on whether you are working with vSphere or Workstation/Fusion.
@@ -58,7 +58,7 @@ For vSphere the solution is simple because instead of inlining the configuration
 ----
 CONFIG_ENCODING="gzip+base64"
 CONFIG_FILE="example.ign"
-CONFIG_FILE_ENCODED="${CONFIG_FILE}.gzip.b64"
+CONFIG_FILE_ENCODED="${CONFIG_FILE}.gz.b64"
 
 gzip -9c "${CONFIG_FILE}" | base64 -w0 - > "${CONFIG_FILE_ENCODED}"
 
@@ -72,7 +72,7 @@ In the case of Workstation/Fusion, or as a last resort in general, there is the
 
 [source, bash]
 ----
-printf "extraConfig:guestinfo.ignition.config.data=$(cat example.ign | base64 -w0 -)\n" > ovftool.cfg
+echo "extraConfig:guestinfo.ignition.config.data=$(base64 -w0 example.ign)" > ovftool.cfg
 ----
 
 == Booting a new VM on Workstation or Fusion

modules/ROOT/pages/stream-metadata.adoc

@@ -17,7 +17,7 @@ The `coreos-installer` tool has built-in support for fetching artifacts:
 [source, bash]
 ----
 STREAM='stable'
-coreos-installer download --decompress -s $STREAM -p openstack -f qcow2.xz
+coreos-installer download --decompress -s ${STREAM} -p openstack -f qcow2.xz
 ----
 
 == Using coreos/stream-metadata-go
@@ -32,7 +32,7 @@ Fetch the latest `x86_64` AMI in `us-west-1` and use it to launch an instance:
 [source, bash]
 ----
 $ AMI=$(curl -sSL https://builds.coreos.fedoraproject.org/streams/stable.json | jq -r '.architectures.x86_64.images.aws.regions["us-west-1"].image')
-$ echo $AMI
+$ echo "${AMI}"
 ami-021238084bf8c95ff
 $ aws ec2 run-instances --region us-west-1 --image-id "${AMI}" ...
 ----

modules/ROOT/pages/tutorial-autologin.adoc

@@ -122,7 +122,7 @@ chcon --verbose --type svirt_home_t autologin.ign
 virt-install --name=fcos --vcpus=2 --ram=2048 --os-variant=fedora-coreos-stable \
     --import --network=bridge=virbr0 --graphics=none \
     --qemu-commandline="-fw_cfg name=opt/com.coreos/config,file=${PWD}/autologin.ign" \
-    --disk=size=20,backing_store=${PWD}/fedora-coreos.qcow2
+    --disk=size=20,backing_store="${PWD}/fedora-coreos.qcow2"
 ----
 
 The `virt-install` command will start an instance named `fcos` from the `fedora-coreos.qcow2` image using the `autologin.ign` Ignition config. It will auto-attach the serial console of the machine so you will be able to see the image bootup messages.

modules/ROOT/pages/tutorial-containers.adoc

@@ -107,7 +107,7 @@ chcon --verbose --type svirt_home_t containers.ign
 virt-install --name=fcos --vcpus=2 --ram=2048 --os-variant=fedora-coreos-stable \
     --import --network=bridge=virbr0 --graphics=none \
     --qemu-commandline="-fw_cfg name=opt/com.coreos/config,file=${PWD}/containers.ign" \
-    --disk=size=20,backing_store=${PWD}/fedora-coreos.qcow2
+    --disk=size=20,backing_store="${PWD}/fedora-coreos.qcow2"
 ----
 
 On the console you will see:

modules/ROOT/pages/tutorial-services.adoc

@@ -124,7 +124,7 @@ chcon --verbose --type svirt_home_t services.ign
 virt-install --name=fcos --vcpus=2 --ram=2048 --os-variant=fedora-coreos-stable \
     --import --network=bridge=virbr0 --graphics=none \
     --qemu-commandline="-fw_cfg name=opt/com.coreos/config,file=${PWD}/services.ign" \
-    --disk=size=20,backing_store=${PWD}/fedora-coreos.qcow2
+    --disk=size=20,backing_store="${PWD}/fedora-coreos.qcow2"
 ----
 
 And view on the console that the `Detected Public IPv4` is shown in the console output right before you are dropped to a login prompt:

modules/ROOT/pages/tutorial-setup.adoc

@@ -56,20 +56,20 @@ To make it simpler to type, you may add the following aliases to your shell conf
 
 [source,bash]
 ----
-alias butane='podman run --rm --interactive       \
-              --security-opt label=disable        \
-              --volume ${PWD}:/pwd --workdir /pwd \
+alias butane='podman run --rm --interactive         \
+              --security-opt label=disable          \
+              --volume "${PWD}:/pwd" --workdir /pwd \
               quay.io/coreos/butane:release'
 
-alias coreos-installer='podman run --pull=always            \
-                        --rm --interactive                  \
-                        --security-opt label=disable        \
-                        --volume ${PWD}:/pwd --workdir /pwd \
+alias coreos-installer='podman run --pull=always              \
+                        --rm --interactive                    \
+                        --security-opt label=disable          \
+                        --volume "${PWD}:/pwd" --workdir /pwd \
                         quay.io/coreos/coreos-installer:release'
 
-alias ignition-validate='podman run --rm --interactive       \
-                         --security-opt label=disable        \
-                         --volume ${PWD}:/pwd --workdir /pwd \
+alias ignition-validate='podman run --rm --interactive         \
+                         --security-opt label=disable          \
+                         --volume "${PWD}:/pwd" --workdir /pwd \
                          quay.io/coreos/ignition-validate:release'
 ----
 
@@ -118,23 +118,23 @@ If none of the previous solutions work for you, you can still manually download
 [source,bash,subs="attributes"]
 ----
 RELEASE="{stable-version}"
-curl -O https://builds.coreos.fedoraproject.org/prod/streams/stable/builds/$RELEASE/x86_64/fedora-coreos-$RELEASE-qemu.x86_64.qcow2.xz
-curl -O https://builds.coreos.fedoraproject.org/prod/streams/stable/builds/$RELEASE/x86_64/fedora-coreos-$RELEASE-qemu.x86_64.qcow2.xz.sig
+curl -O https://builds.coreos.fedoraproject.org/prod/streams/stable/builds/${RELEASE}/x86_64/fedora-coreos-${RELEASE}-qemu.x86_64.qcow2.xz
+curl -O https://builds.coreos.fedoraproject.org/prod/streams/stable/builds/${RELEASE}/x86_64/fedora-coreos-${RELEASE}-qemu.x86_64.qcow2.xz.sig
 ----
 
 Once the archive has been downloaded, make sure to verify its integrity by following the instructions available by clicking on the `Verify signature & SHA256` button. You will have to download the checksum file, the signature and Fedora GPG keys to verify your download:
 
 [source,bash]
 ----
 curl https://fedoraproject.org/fedora.gpg | gpg --import
-gpg --verify fedora-coreos-$RELEASE-qemu.x86_64.qcow2.xz.sig
+gpg --verify fedora-coreos-${RELEASE}-qemu.x86_64.qcow2.xz.sig
 ----
 
 Once you have verified the archive, you can extract it with:
 
 [source,bash]
 ----
-unxz fedora-coreos-$RELEASE-qemu.x86_64.qcow2.xz
+unxz fedora-coreos-${RELEASE}-qemu.x86_64.qcow2.xz
 ----
 
 To make the tutorial simpler, you should rename the image that we have just downloaded to a shorter name: