Merge pull request #1288 from tkatila/readme-zsh-updates

Update README kubectl applies for zsh support

Author: mythi

cmd/dlb_plugin/README.md

@@ -37,8 +37,8 @@ List eventdev devices:
 $ ./usertools/dpdk-devbind.py -s | grep -A10 ^Eventdev
 Eventdev devices using kernel driver
 ====================================
-0000:6d:00.0 'Device 2710' drv=dlb2 unused= 
-0000:72:00.0 'Device 2710' drv=dlb2 unused= 
+0000:6d:00.0 'Device 2710' drv=dlb2 unused=
+0000:72:00.0 'Device 2710' drv=dlb2 unused=
 ...
 ```
 
@@ -59,12 +59,12 @@ Check that new eventdev devices appear:
 $ ./usertools/dpdk-devbind.py -s | grep -A14 ^Eventdev
 Eventdev devices using kernel driver
 ====================================
-0000:6d:00.0 'Device 2710' drv=dlb2 unused= 
-0000:6d:00.1 'Device 2711' drv=dlb2 unused= 
-0000:6d:00.2 'Device 2711' drv=dlb2 unused= 
-0000:6d:00.3 'Device 2711' drv=dlb2 unused= 
-0000:6d:00.4 'Device 2711' drv=dlb2 unused= 
-0000:72:00.0 'Device 2710' drv=dlb2 unused= 
+0000:6d:00.0 'Device 2710' drv=dlb2 unused=
+0000:6d:00.1 'Device 2711' drv=dlb2 unused=
+0000:6d:00.2 'Device 2711' drv=dlb2 unused=
+0000:6d:00.3 'Device 2711' drv=dlb2 unused=
+0000:6d:00.4 'Device 2711' drv=dlb2 unused=
+0000:72:00.0 'Device 2710' drv=dlb2 unused=
 ...
 ```
 
@@ -142,7 +142,7 @@ release version numbers in the format `x.y.z`, corresponding to the branches and
 repository. Thus the easiest way to deploy the plugin in your cluster is to run this command
 
 ```bash
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/dlb_plugin?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/dlb_plugin?ref=<RELEASE_VERSION>'
 daemonset.apps/intel-dlb-plugin created
 ```
 

cmd/dsa_plugin/README.md

@@ -31,7 +31,7 @@ release version numbers in the format `x.y.z`, corresponding to the branches and
 repository. Thus the easiest way to deploy the plugin in your cluster is to run this command
 
 ```bash
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/dsa_plugin?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/dsa_plugin?ref=<RELEASE_VERSION>'
 daemonset.apps/intel-dsa-plugin created
 ```
 

cmd/fpga_plugin/README.md

@@ -151,7 +151,7 @@ The following images are available on the Docker hub:
 
 Depending on the FPGA mode, run either
 ```bash
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/fpga_plugin/overlays/af?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/fpga_plugin/overlays/af?ref=<RELEASE_VERSION>'
 namespace/intelfpgaplugin-system created
 customresourcedefinition.apiextensions.k8s.io/acceleratorfunctions.fpga.intel.com created
 customresourcedefinition.apiextensions.k8s.io/fpgaregions.fpga.intel.com created
@@ -168,7 +168,7 @@ issuer.cert-manager.io/intelfpgaplugin-selfsigned-issuer created
 ```
 or
 ```bash
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/fpga_plugin/overlays/region?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/fpga_plugin/overlays/region?ref=<RELEASE_VERSION>'
 namespace/intelfpgaplugin-system created
 customresourcedefinition.apiextensions.k8s.io/acceleratorfunctions.fpga.intel.com created
 customresourcedefinition.apiextensions.k8s.io/fpgaregions.fpga.intel.com created

cmd/iaa_plugin/README.md

@@ -31,7 +31,7 @@ release version numbers in the format `x.y.z`, corresponding to the branches and
 repository. Thus the easiest way to deploy the plugin in your cluster is to run this command
 
 ```bash
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/iaa_plugin?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/iaa_plugin?ref=<RELEASE_VERSION>'
 daemonset.apps/intel-iaa-plugin created
 ```
 

cmd/operator/README.md

@@ -20,11 +20,11 @@ Install NFD (if it's not already installed) and node labelling rules (requires N
 
 ```
 # either with default NFD installation
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/nfd?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/nfd?ref=<RELEASE_VERSION>'
 # or when setting up with SGX
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/nfd/overlays/sgx?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/nfd/overlays/sgx?ref=<RELEASE_VERSION>'
 # and finally, NodeFeatureRules
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/nfd/overlays/node-feature-rules?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/nfd/overlays/node-feature-rules?ref=<RELEASE_VERSION>'
 ```
 Make sure both NFD master and worker pods are running:
 
@@ -111,7 +111,7 @@ $ export no_proxy=$no_proxy,.svc,.svc.cluster.local
 Finally deploy the operator itself:
 
 ```
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/operator/default?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/operator/default?ref=<RELEASE_VERSION>'
 ```
 
 Now you can deploy the device plugins by creating corresponding custom resources.

cmd/qat_plugin/README.md

@@ -104,15 +104,15 @@ release version numbers in the format `x.y.z`, corresponding to the branches and
 repository. Thus the easiest way to deploy the plugin in your cluster is to run this command
 
 ```bash
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/qat_plugin?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/qat_plugin?ref=<RELEASE_VERSION>'
 ```
 
 Where `<RELEASE_VERSION>` needs to be substituted with the desired [release tag](https://github.com/intel/intel-device-plugins-for-kubernetes/tags) or `main` to get `devel` images.
 
 An alternative kustomization for deploying the plugin is with the debug mode switched on:
 
 ```bash
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/qat_plugin/overlays/debug?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/qat_plugin/overlays/debug?ref=<RELEASE_VERSION>'
 ```
 
 > **Note**: It is also possible to run the QAT device plugin using a non-root user. To do this,
@@ -122,7 +122,7 @@ $ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/
 
 #### Automatic Provisioning
 
-There's a sample [qat initcontainer](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/main/build/docker/intel-qat-initcontainer.Dockerfile). Regardless of device types, the script running inside the initcontainer enables QAT SR-IOV VFs. 
+There's a sample [qat initcontainer](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/main/build/docker/intel-qat-initcontainer.Dockerfile). Regardless of device types, the script running inside the initcontainer enables QAT SR-IOV VFs.
 
 To deploy, run as follows:
 
@@ -132,9 +132,9 @@ $ kubectl apply -k deployments/qat_plugin/overlays/qat_initcontainer/
 
 In addition to the default configuration, you can add device-specific configurations via ConfigMap.
 
-| Device | Possible Configuration | How To Customize | Options | Notes | 
+| Device | Possible Configuration | How To Customize | Options | Notes |
 |:-------|:-----------------------|:-----------------|:--------|:------|
-| 4xxx, 401xx | [cfg_services](https://github.com/torvalds/linux/blob/42e66b1cc3a070671001f8a1e933a80818a192bf/Documentation/ABI/testing/sysfs-driver-qat) reports the configured services (crypto services or compression services) of the QAT device. | `ServicesEnabled=<value>` | compress:`dc`, crypto:`sym;asym` | Linux 6.0+ kernel is required. | 
+| 4xxx, 401xx | [cfg_services](https://github.com/torvalds/linux/blob/42e66b1cc3a070671001f8a1e933a80818a192bf/Documentation/ABI/testing/sysfs-driver-qat) reports the configured services (crypto services or compression services) of the QAT device. | `ServicesEnabled=<value>` | compress:`dc`, crypto:`sym;asym` | Linux 6.0+ kernel is required. |
 
 To create a provisioning config after customizing, run as follows:
 

cmd/sgx_plugin/README.md

@@ -84,8 +84,8 @@ Where `<RELEASE_VERSION>` needs to be substituted with the desired [release tag]
 First, deploy `node-feature-discovery`:
 
 ```bash
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/nfd/overlays/sgx?ref=<RELEASE_VERSION>
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/nfd/overlays/node-feature-rules?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/nfd/overlays/sgx?ref=<RELEASE_VERSION>'
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/nfd/overlays/node-feature-rules?ref=<RELEASE_VERSION>'
 ```
 
 **Note:** The [default configuration](/deployments/nfd/overlays/node-feature-rules/node-feature-rules.yaml) assumes that the in-tree driver is used and enabled (`CONFIG_X86_SGX=y`). If
@@ -94,15 +94,15 @@ the SGX DCAP out-of-tree driver is used, the `kernel.config` match expression mu
 Next, deploy the Intel Device plugin operator:
 
 ```bash
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/operator/default?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/operator/default?ref=<RELEASE_VERSION>'
 ```
 
 **Note:** See the operator [deployment details](/cmd/operator/README.md) for its dependencies and for setting it up on systems behind proxies.
 
 Finally, deploy the SGX device plugin with the operator
 
 ```bash
-$ kubectl apply -f https://raw.githubusercontent.com/intel/intel-device-plugins-for-kubernetes/<RELEASE_VERSION>/deployments/operator/samples/deviceplugin_v1_sgxdeviceplugin.yaml
+$ kubectl apply -f 'https://raw.githubusercontent.com/intel/intel-device-plugins-for-kubernetes/<RELEASE_VERSION>/deployments/operator/samples/deviceplugin_v1_sgxdeviceplugin.yaml'
 ```
 
 ### Installation Using kubectl
@@ -193,7 +193,7 @@ for generating SGX quotes for workloads. It is deployed with `hostNetwork: true`
 to allow connections to localhost PCCS.
 
 ```bash
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/sgx_aesmd?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/sgx_aesmd?ref=<RELEASE_VERSION>'
 $ kubectl get pods
   NAME                     READY     STATUS    RESTARTS   AGE
   intel-sgx-aesmd-mrnm8                1/1     Running   0          3h47m
@@ -211,15 +211,15 @@ $ kubectl get pods
 >   extraMounts:
 >   - hostPath: /var/run/aesmd
 >     containerPath: /var/run/aesmd
->     propagation: Bidirectional 
+>     propagation: Bidirectional
 >```
 > And bootstrap kind with it \
 > `$ kind create cluster --config kind_config.yaml`
 
 The sample application runs SGX DCAP Quote Generation sample:
 
 ```bash
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/sgx_enclave_apps/overlays/sgx_ecdsa_aesmd_quote?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/sgx_enclave_apps/overlays/sgx_ecdsa_aesmd_quote?ref=<RELEASE_VERSION>'
 $ kubectl get pods
   NAME                                 READY   STATUS      RESTARTS   AGE
   intel-sgx-aesmd-mrnm8                1/1     Running     0          3h55m

cmd/vpu_plugin/README.md

@@ -51,7 +51,7 @@ release version numbers in the format `x.y.z`, corresponding to the branches and
 repository. Thus the easiest way to deploy the plugin in your cluster is to run this command
 
 ```bash
-$ kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/vpu_plugin?ref=<RELEASE_VERSION>
+$ kubectl apply -k 'https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/vpu_plugin?ref=<RELEASE_VERSION>'
 daemonset.apps/intel-vpu-plugin created
 ```