InfluxDB templates
InfluxDB templates are prepackaged InfluxDB configurations that contain everything 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 consists of a single file known as a manifest that defines the InfluxDB state and associated resources. Template manifests support the following formats:
Template manifests are compatible with Kubernetes Custom Resource Definitions (CRD).
The metadata.name field in manifests uniquely identifies each resource in the template.
metadata.name values must be DNS-1123 compliant.
If resources in the template depend on other InfluxDB resources, all dependencies
must be included in the template.
See Create an InfluxDB template for information about generating template manifests.
Template resources
Include the following resources in a template:
- buckets
- checks
- dashboards
- dashboard variables
- labels
- notification endpoints
- notification rules
- tasks
- Telegraf configurations
Stacks
InfluxDB stacks are stateful InfluxDB templates. 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 below.
InfluxDB templates in Cloud
Install templates directly in the UI or download the influx CLI to apply and manage InfluxDB templates in your InfluxDB Cloud account.
Monitor InfluxDB Enterprise using a template
Monitor your InfluxDB Enterprise instance using InfluxDB Cloud and a pre-built InfluxDB template.
Use InfluxDB templates
Use the influx command line interface (CLI) and the InfluxDB /api/v2/templates API to summarize, validate, and apply templates from file systems and URLs.
Create an InfluxDB template
Use the InfluxDB UI and the influx export command to create InfluxDB templates.
InfluxDB stacks
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 apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.