Mismatch of documentation between operation and HELM chart

kubernetes-sigs / sig-storage-local-static-provisioner

Static provisioner of local volumes

Apache License 2.0

1.07k stars 334 forks source link

Mismatch of documentation between operation and HELM chart #329

Open AssafKatz3 opened 2 years ago

AssafKatz3 commented 2 years ago

Hi, Operations mention discovery directory but helm documentation doesn't refer to it at all. Therefore it isn't clear how should I configure the HELM chart for the case of Sharing a disk filesystem by multiple filesystem PVs . Thanks

mauriciopoppe commented 2 years ago

The setup is a 2 step process for the case "Sharing a disk filesystem by multiple filesystem PVs"

Do the setup described in Sharing a disk filesystem by multiple filesystem PVs, this setup is typically done when the node is bootstrapped
As you can see in the commands there are n mount points created in /mnt/disks therefore the discovery directory is /mnt/disks. Next install the helm chart with a class that uses this discovery directory e.g. https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner/blob/master/helm/examples/development-gke.yaml. In the README search for the options that start with classes.[n] too.

k8s-triage-robot commented 2 years ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

mauriciopoppe commented 2 years ago

/remove-lifecycle stale

I think we could add a reference from the helm docs to the operations docs for the glossary among other things.

Kartik494 commented 2 years ago

I would like to give a try on this. /assign

Kartik494 commented 1 year ago

I am somehow unclear on where to add helm documentation in https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner/blob/master/docs/operations.md . Should i reference it here https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner/blob/master/docs/operations.md#sharing-a-disk-filesystem-by-multiple-filesystem-pvs ?

AssafKatz3 commented 1 year ago

I am somehow unclear on where to add helm documentation in https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner/blob/master/docs/operations.md . Should i reference it here https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner/blob/master/docs/operations.md#sharing-a-disk-filesystem-by-multiple-filesystem-pvs ?

Hi, We need it as part of helm/README.md. Thanks