[BUG]: cert-csi documentation clarity - Githubissues

dell / csm

Dell Container Storage Modules (CSM)

Apache License 2.0

68 stars 15 forks source link

[BUG]: cert-csi documentation clarity #1503

Open dancohen21 opened 3 weeks ago

dancohen21 commented 3 weeks ago

Bug Description

The driver specific examples in the documentation are great https://dell.github.io/csm-docs/docs/support/cert-csi/

For PowerStore, as an example, the values (true/false) are setup properly for valid use cases.

in contrast, https://github.com/dell/cert-csi/example-certify-config.yaml seems incomplete example-certify-config.yaml

requests:

include driver specific example in the github repository
remove the example-certify-config.yaml from the github repository
include critical comments in the driver specific tests yaml for any test requirements. For example, the "waitforfirstconsumer" requirement for the CapacityTracking test, and in OpenShift, any labels that need to be applied to the CSI driver

Logs

n/a

Screenshots

No response

Additional Environment Information

No response

Steps to Reproduce

n/a

Expected Behavior

n/a

CSM Driver(s)

powerstore 2.10.1

Installation Type

No response

Container Storage Modules Enabled

No response

Container Orchestrator

OpenShift 4.14

Operating System

OpenShift 4.14

csmbot commented 3 weeks ago

@dancohen21: Thank you for submitting this issue!

The issue is currently awaiting triage. Please make sure you have given us as much context as possible.

If the maintainers determine this is a relevant issue, they will remove the needs-triage label and respond appropriately.

We want your feedback! If you have any questions or suggestions regarding our contributing process/workflow, please reach out to us at container.storage.modules@dell.com.