search

IBM / ibm-spectrum-scale-csi

The IBM Spectrum Scale Container Storage Interface (CSI) project enables container orchestrators, such as Kubernetes and OpenShift, to manage the life-cycle of persistent storage.
Apache License 2.0
68 stars 49 forks source link

Documentation: storageClass table does not show available options for filesetType #907

Closed gfschmidt closed 1 year ago

gfschmidt commented 1 year ago

Describe the bug

The documentation on page https://www.ibm.com/docs/en/spectrum-scale-csi?topic=class-storage-creating-fileset-based-volumes does not list the available parameters for filesetType in the table. These are "independent", "dependent".

It reads:

Following fields comes under parameters section of storageClass. Parameters section is mandatory
for Spectrum Scale CSI driver storageClass:
Field name    | Description
filesetType   | The default value is independent.

It should read:

The following fields are available for the "parameters:" section in a storageClass manifest. 
The "parameters:" section is a mandatory section for the IBM Spectrum Scale CSI driver storageClass:
Field name    | Description
filesetType   | Valid options are "independent", "dependent".
              | The default value is independent.
gfschmidt commented 1 year ago

By the way.... this option in the same table would also need some more explanation...

shared (optional) | Use shared=true, if you have pods with non-root users 
                              that are using PVCs with ReadWriteMany(RWX) access mode. Default value is false.

What does it do? And It should (probably) read as shared: "true"

shared (optional) | Use shared: "true", if you have pods with non-root users 
                              that are using PVCs with ReadWriteMany(RWX) access mode. Default value is false.

Please verify. At least shared=true is definitely wrong. And without putting it into quotes like "true" I also get an error.

So I assume it should be

parameters:
  volBackendFs: "fs1"
  clusterId: "215057217487177715"
  shared: "true"
reclaimPolicy: Delete

When using 

parameters:
  volBackendFs: "fs1"
  clusterId: "215057217487177715"
  shared: true

I get an error :

# oc apply -f ibm-spectrum-scale-sc2.yaml
Error from server (BadRequest): error when creating "ibm-spectrum-scale-sc2.yaml": StorageClass in version "v1" cannot be handled as a StorageClass: json: cannot unmarshal bool into Go struct field StorageClass.parameters of type string
amdabhad commented 1 year ago

Thanks Gero for this issue, we have updated the documentation in 2.9.0 - https://www.ibm.com/docs/en/spectrum-scale-csi?topic=class-storage-creating-fileset-based-volumes