diff --git a/content/v2.0/influxdb-templates/_index.md b/content/v2.0/influxdb-templates/_index.md index 9e62b25cc..3534a98c9 100644 --- a/content/v2.0/influxdb-templates/_index.md +++ b/content/v2.0/influxdb-templates/_index.md @@ -20,8 +20,8 @@ dashboard configuration, or share your configuration with the InfluxData communi - Simplify sharing and using pre-built InfluxDB solutions. ## Template manifests -A template is comprised of a single file known as a **manifest** that defines the -desired state InfluxDB and associated [resources](#template-resources). +A template consists of a single file known as a **manifest** that defines the +InfluxDB state and associated [resources](#template-resources). Template manifests support the following formats: - [YAML](https://yaml.org/) @@ -33,10 +33,10 @@ Template manifests are compatible with [Kubernetes Custom Resource Definitions (CRD)](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/). {{% /note %}} -The `metadata.name` field in manifests uniquely identify each resource in the template. +The `metadata.name` field in manifests uniquely identifies each resource in the template. `metadata.name` values must be [DNS-1123](https://tools.ietf.org/html/rfc1123) compliant. -If templated resources depend on other InfluxDB resources, all dependencies -must be provided in the template. +If resources in the template depend on other InfluxDB resources, all dependencies +must be included in the template. _See [Create an InfluxDB template](/v2.0/influxdb-templates/create/) for information about generating template manifests._ @@ -56,8 +56,8 @@ Include the following **resources** in a template: ## Stacks **InfluxDB stacks** are stateful InfluxDB templates. -Any time you apply a template, InfluxDB associates the applied resources with a stack. -Use stacks to gracefully add, update, and remove templated resources over time. +When you apply a template, InfluxDB associates resources in the template with a stack. +Use stacks to add, update, or remove templated resources over time. For more information, see [InfluxDB Stacks](#influxdb-stacks) below. diff --git a/content/v2.0/influxdb-templates/create.md b/content/v2.0/influxdb-templates/create.md index 876d2cab8..314c0806b 100644 --- a/content/v2.0/influxdb-templates/create.md +++ b/content/v2.0/influxdb-templates/create.md @@ -141,8 +141,8 @@ influx export all \ ``` ### Export a stack -To export a stack and all its associated resources in their current state as a template, -use the `influx export stack` command. +To export a stack and all its associated resources as a template, use the +`influx export stack` command. Provide the following: - **Organization name** or **ID** diff --git a/content/v2.0/influxdb-templates/stacks/_index.md b/content/v2.0/influxdb-templates/stacks/_index.md index 9b9e0bff4..df956bf03 100644 --- a/content/v2.0/influxdb-templates/stacks/_index.md +++ b/content/v2.0/influxdb-templates/stacks/_index.md @@ -1,10 +1,10 @@ --- title: InfluxDB stacks description: > - InfluxDB stacks are stateful InfluxDB templates that let you gracefully add, + InfluxDB stacks are stateful InfluxDB templates that let you add, update, and remove templated resources over time, avoid duplicating resources - when applying the same or similar templates more than once, and easily and - gracefully apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud. + when applying the same or similar templates more than once, and apply + changes to distributed instances of InfluxDB OSS or InfluxDB Cloud. menu: v2_0: parent: InfluxDB templates @@ -14,31 +14,35 @@ related: --- **InfluxDB stacks** are **stateful [InfluxDB templates](/v2.0/influxdb-templates)** -that let you gracefully add, update, and remove templated resources over time, -avoid duplicating resources when applying the same or similar templates more than once, -and easily and gracefully apply changes to distributed instances of InfluxDB OSS -or InfluxDB Cloud. +that let you add, update, and remove templated resources over time, avoid +duplicating resources when applying the same or similar templates more than once, +and apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud. ## Ideal use cases for InfluxDB stacks +Stacks help save time and effort in the following use cases: + +- [Actively develop and extend templates](#actively-develop-and-extend-templates) +- [Apply updates from source-controlled templates](#apply-updates-from-source-controlled-templates) +- [Apply template updates across multiple InfluxDB instances](#apply-template-updates-across-multiple-influxdb-instances) ### Actively develop and extend templates InfluxDB stacks aid in developing and maintaining InfluxDB templates. -They allow template builders to modify and update template manifests and gracefully -apply those changes in any that that uses their template. +Stacks let you modify and update template manifests and apply those changes in +any stack that uses the template. ### Apply updates from source-controlled templates -Users can use a variety of InfluxDB templates from many different sources including +You can use a variety of InfluxDB templates from many different sources including [Community Templates](https://github.com/influxdata/community-templates/) or self-built custom templates. As templates are updated over time, stacks allow template users to gracefully -apply those updates without creating duplicate resources. +apply updates without creating duplicate resources. ### Apply template updates across multiple InfluxDB instances In many cases, users have more than one instance of InfluxDB running and apply the same template to each separate instance. By using stacks, you can make changes to a stack on one instance, [export the stack as a template](/v2.0/influxdb-templates/create/#export-a-stack) -and then easily apply those same changes to your other InfluxDB instances. +and then apply the changes to your other InfluxDB instances. ## Manage InfluxDB Stacks diff --git a/content/v2.0/influxdb-templates/stacks/init.md b/content/v2.0/influxdb-templates/stacks/init.md index db2aadd39..2f0df0bf4 100644 --- a/content/v2.0/influxdb-templates/stacks/init.md +++ b/content/v2.0/influxdb-templates/stacks/init.md @@ -4,8 +4,7 @@ list_title: Initialize a stack description: > InfluxDB automatically creates a new stack each time you [apply an InfluxDB template](/v2.0/influxdb-templates/use/) **without providing a stack ID**. - You can also use the [`influx stacks init` command](/v2.0/reference/cli/influx/stacks/init/) - to manually create or initialize a new stack. + To manually create or initialize a new stack, use the [`influx stacks init` command](/v2.0/reference/cli/influx/stacks/init/). menu: v2_0: parent: InfluxDB stacks @@ -31,13 +30,12 @@ list_code_example: | InfluxDB automatically creates a new stack each time you [apply an InfluxDB template](/v2.0/influxdb-templates/use/) **without providing a stack ID**. -You can also use the [`influx stacks init` command](/v2.0/reference/cli/influx/stacks/init/) -to manually create or initialize a new stack. +To manually create or initialize a new stack, use the [`influx stacks init` command](/v2.0/reference/cli/influx/stacks/init/). ## Initialize a stack when applying a template To automatically create a new stack when [applying an InfluxDB template](/v2.0/influxdb-templates/use/) **don't provide a stack ID**. -InfluxDB applies the templated resources to a new stack and provides the **stack ID** the output. +InfluxDB applies the resources in the template to a new stack and provides the **stack ID** the output. ```sh influx apply \ @@ -47,7 +45,7 @@ influx apply \ ## Manually initialize a new stack Use the [`influx stacks init` command](/v2.0/reference/cli/influx/stacks/init/) -to create or initialize a new InfluxDB Stack. +to create or initialize a new InfluxDB stack. **Provide the following:** diff --git a/content/v2.0/influxdb-templates/stacks/update.md b/content/v2.0/influxdb-templates/stacks/update.md index b598102af..9535c0cf3 100644 --- a/content/v2.0/influxdb-templates/stacks/update.md +++ b/content/v2.0/influxdb-templates/stacks/update.md @@ -6,8 +6,8 @@ description: > to update a stack with a modified template. When applying a template to an existing stack, InfluxDB checks to see if the resources in the template match existing resources. - InfluxDB updates, adds, and removes resources to resolves differences between - current state of the stack and the newly applied template. + InfluxDB updates, adds, and removes resources to resolve differences between + the current state of the stack and the newly applied template. menu: v2_0: parent: InfluxDB stacks @@ -30,13 +30,13 @@ Use the [`influx apply` command](/v2.0/reference/cli/influx/apply/) to update a stack with a modified template. When applying a template to an existing stack, InfluxDB checks to see if the resources in the template match existing resources. -InfluxDB updates, adds, and removes resources to resolves differences between -current state of the stack and the newly applied template. +InfluxDB updates, adds, and removes resources to resolve differences between +the current state of the stack and the newly applied template. Each stack is uniquely identified by a **stack ID**. -For information about retrieving your stack ID, see [View stacks](/v2.0/influxdb-templates/stacks/view/) +For information about retrieving your stack ID, see [View stacks](/v2.0/influxdb-templates/stacks/view/). -**To update a stack, provide the following:** +**Provide the following:** - Organization name or ID - Stack ID diff --git a/content/v2.0/influxdb-templates/stacks/view.md b/content/v2.0/influxdb-templates/stacks/view.md index f95f8b243..aaf71df89 100644 --- a/content/v2.0/influxdb-templates/stacks/view.md +++ b/content/v2.0/influxdb-templates/stacks/view.md @@ -1,5 +1,5 @@ --- -title: View InfluxDB Stacks +title: View InfluxDB stacks list_title: View stacks description: > Use the [`influx stacks` command](/v2.0/reference/cli/influx/stacks/)