trident icon indicating copy to clipboard operation
trident copied to clipboard

Helm NOTES.txt tridentctl reference

Open wonderland opened this issue 3 years ago • 2 comments

The current NOTES.txt for the Helm chart states

To configure Trident to manage storage resources, you will need a copy of tridentctl [...]

As we provide backend mgmt via kubectl, most users will never need to touch tridentctl. I believe it would be more approriate to outline the necessary next steps and point to the documentation, something like

You will now need to configure at least one storage backend and add a matching storageClass.

Example backend and storageClass definitions are provided at https://github.com/NetApp/trident/tree/master/trident-installer/sample-input

Creation and management of storage backends and storage classes is documented at https://docs.netapp.com/us-en/trident/

wonderland avatar Jan 21 '22 10:01 wonderland

@wonderland, to clarify your request are you asking that we review the Trident documentation with the idea to make it more GitOps friendly?

gnarl avatar Jan 21 '22 15:01 gnarl

No, just edit the NOTES.txt (that is displayed after deploying Trident via Helm). It feels a bit outdated, given that tridentctl is no longer be the only/preferred way to manage backends.

In general, the NOTES.txt should point users to the necessary next steps after installing. My feeling is that pointing out the next steps (backend + storage class) plus a link to the official docs would be valuable information, compared to the current "you need a copy of tridentctl".

No changes to the docs required, only a small modification to NOTES.txt.

wonderland avatar Jan 21 '22 15:01 wonderland