more updates to envRefs in template docs

pull/765/head
Scott Anderson 2020-02-19 15:37:41 -07:00
parent cb5e5f3c0f
commit 8b84f1ef54
1 changed files with 22 additions and 20 deletions

View File

@ -115,11 +115,15 @@ influx pkg export all \
After exporting a template manifest, replace resource names with **environment references**
to let users customize resource names when installing your template.
In your template manifest, replace a [supported resource field](#resource-fields-that-support-environment-references)
with an `envRef` object.
A `envRef` object contains a single `key` property.
`key` is a string that references the key of a key-value pair a user should
provide when installing the template.
1. [Export a template](#export-a-template)
2. Select any of the following resource fields to update:
- `metadata.name`
- `associations[].name`
- `endpointName` _(unique to `NotificationRule` resources)_
3. Replace the resource field value with an `envRef` object with a `key` property
that reference the key of a key-value pair the user provides when installing the template.
During installation, the `envRef` object is replaced by the value of the
referenced key-value pair.
If the user does not provide the environment reference key-value pair, InfluxDB
@ -176,9 +180,7 @@ exist in the template and what keys to use to replace them._
#### Resource fields that support environment references
Only the following fields support environment references:
- `metadata.name`
- `associations[].name`
- `endpointName` _(unique to `NotificationRule` resources)_
{{% /note %}}
## Share your InfluxDB templates