NetAppDocs / NetAppDocs/trident
Make documentation about nameTemplate more clear and incorporate more examples
@joan-ing is already working on this.
Since Mar 19, 2026.
- Dominant language
- No language data
- Stars
- 1
- Forks
- 22
- Avg merge
- 36m
- Merged PRs (30d)
- 8
Description
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: https://github.com/NetApp/trident/issues/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 nameTemplateseems 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
tridentBackendortridentBackendConfiguration.
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:
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.