added notes for stack/template additions and restructure

pull/1046/head
Scott Anderson 2020-06-15 16:45:10 -06:00
parent 3be86cb9ae
commit e0a9468674
2 changed files with 24 additions and 1 deletions

View File

@ -13,8 +13,15 @@ from dashboards and Telegraf configurations to notifications and alerts.
Use InfluxDB templates to quickly set up a fresh instance of InfluxDB, back up your
dashboard configuration, or share your configuration with the InfluxData community.
**InfluxDB templates do the following:**
- Reduce setup time
- Facilitate secure, portable, source-controlled InfluxDB platform states.
- Simplify sharing and using pre-built InfluxDB solutions.
## Template manifests
A template is defined in a single file known as a **manifest**.
A template is comprised of a single file known as a **manifest** that defines the
desired state InfluxDB and associated [resources](#template-resources).
Template manifests support the following formats:
- [YAML](https://yaml.org/)
@ -26,6 +33,11 @@ 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.
`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.
_See [Create an InfluxDB template](/v2.0/influxdb-templates/create/) for information about
generating template manifests._

View File

@ -17,6 +17,17 @@ that let you:
- Avoid duplicating resources when applying the same or similar templates more than once.
- Easily and gracefully apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud.
## _Notes_
- Whenever you apply a template, that resources created by that template are assigned to a stack ID.
- Any application of a template without a stack ID creates a new stack and all new resources.
- A stack manages the state of a template and the state of InfluxDB and resolves
discrepancies between the two.
- Atomic unit of execution - If there's an error when applying a stack, all the applied resources are rolled back.
### Workflow
- Stacks are uniquely identified by stack ID
- When applying a template to a stack, the stack checks to see if those resources already exists.
## Manage InfluxDB Stacks
{{< children type="anchored-list" >}}