Documentation

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.



Was this page helpful?

Thank you for your feedback!


Select your region

Linux Package Signing Key Rotation

All signed InfluxData Linux packages have been resigned with an updated key. If using Linux, you may need to update your package configuration to continue to download and verify InfluxData software packages.

For more information, see the Linux Package Signing Key Rotation blog post.

InfluxDB Cloud backed by InfluxDB IOx

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by IOx, this is the correct documentation.

If powered by TSM, see the TSM-based InfluxDB Cloud documentation.

InfluxDB Cloud backed by InfluxDB TSM

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine which enables nearly unlimited series cardinality and SQL query support. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by TSM, this is the correct documentation.

If powered by IOx, see the IOx-based InfluxDB Cloud documentation.

State of the InfluxDB Cloud (IOx) documentation

The new documentation for InfluxDB Cloud backed by InfluxDB IOx is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.