InfluxDB templates

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

Template manifests

A template manifest is a file that defines InfluxDB resources. Template manifests support the following formats:

• YAML
• JSON
• Jsonnet

The metadata.name field in manifests uniquely identifies each resource in the template. metadata.name values must be DNS-1123 compliant. The spec object contains the resource configuration.

Example

# 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.

Template resources

Templates may contain the following InfluxDB resources:

• buckets
• checks
• dashboards
• dashboard variables
• labels
• notification endpoints
• notification rules
• tasks
• Telegraf configurations

Stacks

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.