CSI iSCSI updates for quick.md
@@ -16,6 +16,7 @@ This has steps have been tested on:
* MayaStor Daemonset (MDS) requires privileged mode
* MDS requires 2MB huge pages
* For testing, MDS requires the Network Block Device driver (NBD) and the XFS filesystem kernel module
+ * For use with iSCSI see [Prerequisites (iSCSI client)](https://docs.openebs.io/docs/next/prerequisites.html)
## Quickstart
@@ -129,16 +130,36 @@ This has steps have been tested on:
```
6. Create a Storage Class using MayaStor CSI plugin for volume provisioning:
+
+ The underlying MayaStor volume can made available using NBD or iSCSI, so there are 2 possible definitions for storage classes
+ * NBD
```bash
cat <<EOF | kubectl create -f -
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
name: mayastor
+ parameters:
+ repl: '1'
+ protocol: 'nbd'
+ provisioner: io.openebs.csi-mayastor
+ EOF
+ ```
+ * iSCSI
+ ```bash
+ cat <<EOF | kubectl create -f -
+ kind: StorageClass
+ apiVersion: storage.k8s.io/v1
+ metadata:
+ name: mayastor-iscsi
+ parameters:
+ repl: '1'
+ protocol: 'iscsi'
provisioner: io.openebs.csi-mayastor
EOF
```
+
7. Create a Persistent Volume Claim (PVC):
```bash
cat <<EOF | kubectl create -f -
@@ -155,6 +176,8 @@ This has steps have been tested on:
storageClassName: mayastor
EOF
```
+ Note: change value of `storageClassName` if required, for example: ` storageClassName: mayastor-iscsi`
+
Verify that the PVC and Persistent Volume (PV) for the PVC have been
created:
```bash
@@ -238,7 +261,7 @@ This has steps have been tested on:
* Missing finalizers
- Finalizers have not been implemented yet, therefor, it is important to follow
+ Finalizers have not been implemented yet, therefore, it is important to follow
the proper order of tear down:
- delete the pods using a mayastor PVC
