This page documents an earlier version of InfluxDB. InfluxDB v2.6 is the latest stable version. View this page in the v2.6 documentation.
InfluxDB templates are prepackaged InfluxDB configurations that contain everything from dashboards and Telegraf configurations to notifications and alerts. Use templates to monitor your technology stack, 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 by giving you resources that are already configured for your use-case.
- Facilitate secure, portable, and source-controlled InfluxDB resource states.
- Simplify sharing and using pre-built InfluxDB solutions.
View InfluxDB community templates
A template manifest is a file that defines InfluxDB resources. Template manifests support the following formats:
Template manifests are compatible with Kubernetes Custom Resource Definitions (CRD).
metadata.name field in manifests uniquely identifies each resource in the template.
metadata.name values must be DNS-1123 compliant.
spec object contains the resource configuration.
# bucket-template.yml # Template manifest that defines two buckets. apiVersion: influxdata.com/v2alpha1 kind: Bucket metadata: name: thirsty-shaw-91b005 spec: description: My IoT Center Bucket name: iot-center retentionRules: - everySeconds: 86400 type: expire --- apiVersion: influxdata.com/v2alpha1 kind: Bucket metadata: name: upbeat-fermat-91b001 spec: name: air_sensor ---
See Create an InfluxDB template for information about generating template manifests.
Templates may contain the following InfluxDB resources:
- dashboard variables
- notification endpoints
- notification rules
- Telegraf configurations
Use InfluxDB stacks to manage InfluxDB templates. When you apply a template, InfluxDB associates resources in the template with a stack. Use stacks to add, update, or remove InfluxDB templates over time.
For more information, see InfluxDB stacks below.
Use InfluxDB templates
influx command line interface (CLI) to summarize, validate, and apply templates from your local filesystem and from URLs.
Create an InfluxDB template
Use the InfluxDB UI and the
influx export command to create InfluxDB templates.
Use an InfluxDB stack to manage your InfluxDB templates—add, update, or remove templates over time.
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:
InfluxDB Cloud and InfluxDB Enterprise customers can contact InfluxData Support.