Make documentation about nameTemplate more clear and incorporate more examples

[b2cc]

Page URL

https://docs.netapp.com/us-en/trident/trident-use/vol-custom-name.html

Page title

Customize volume names and labels

Summary

I'd like to suggest changes to make it more clear, how the nameTemplate feature works, since I had trouble understanding it.

See this issue for reference: NetApp/trident#995

The documentation is very sparse about this feature, and, in places, also feels wrong to me. E.g.:

• https://docs.netapp.com/us-en/trident/trident-use/ontap-nas-examples.html#minimal-configuration-examples , in Backend configuration example with nameTemplate seems to mix up YAML and JSON. If this is actually meant like this, please explain how because I wasn't able to derive valid YAML from this example
• https://docs.netapp.com/us-en/trident/trident-use/vol-custom-name.html : Again, this is in JSON format, and the documentation is not clear if this is a tridentBackend or tridentBackendConfiguration.

There is no complete working example including a PVC declaration that would make use of this, nor any examples and their expected outcome. It is really hard to understand how this is supposed to work.

User @YvosOnTheHub has some very useful documentation here:

• https://github.com/YvosOnTheHub/LabNetApp/tree/master/Kubernetes_v6/Trident_Scenarios/Scenario23

Please update (fix?) the docs and incorporate a fully working configuration for this feature.

Public issues must not contain sensitive information

• This issue contains no sensitive information.

[netapp-aruldeepa]

Hi @b2cc,

Thanks for sharing the details.

We'll work with our team to update the document.

Regards,
Deepa

[VinayKumarHavanur]

Hi @b2cc

The Customisable Volume Names feature is the name the volumes in storage (ONTAP) according to the template defined by the user in backend.

The template has to be in JSON format irrespective of tridentBackend or tridentBackendConfiguration is used for backend creation.

Please note that the Kubernetes object names i.e PV and PVC names will not be modified. Only the volume name in storage is modified. So that a user looking at the storage (ex: ONTAP System manager) can easily map volume to the application or the k8s cluster to which it belongs.

We will incorporate all the above description in the documentation to avoid any confusion.

[Wagz123]

The docs should go into more detail like the fact that you can use some go string manipulation primitives and show examples. Or what trident Custom resources key value pairs you can reference to construct the name.

[crossond]

Adding here a customer posting on Discord requesting more clarity and examples of this feature in the doc page.
As others have commented above, some clear example of results after using the templates would be very helpful showing the custom volume name that is achieved, etc..

_"I have trident in k8s environment. We have a requirement to provision volumes with specific naming convention."

SVMname<application-id><Environment>_volxxx_s1

E.g.
AU2004NP0400_A0009A_PROD_vol001_s1
AU2004NT0400_A0033F_TEST_vol001_s2

"As per trident documentation custom volume names can be created. However, I am not able to identify the correct options to be used for achieving this._"