InfluxDB templates in InfluxDB Cloud
To use templates in InfluxDB Cloud, you have a couple options:
- Install and customize templates directly in the Cloud UI
- Apply and manage templates using the
influxCLI
Install and customize a template in the Cloud UI
To ensure the template works, complete the ReadMe instructions after installing a template. For example, you may need to configure telegraf to write specific data to your Cloud instance before the template can be used.
Under Settings icon in the navigation bar.
Click Templates.
(Optional) If you already have a template URL, you can skip this step. Click Browse Community Templates to explore templates and obtain a template URL (YAML or JSON file).
Enter the URL to the template’s YAML or JSON file (from the InfluxData Community Templates repository), and then click Lookup Template. The Template Installer displays the template name and the number of resources included in the template (for example, dashboards, Telegraf configurations, buckets, and more).
Click Install Template. A message confirms the template has been successfully installed.
Under Installed Templates, find the template, and do the following:
Click View Readme. Complete the instructions to finalize your template.
(Optional) To customize a template, under Installed Resources, expand the template resources, and then click a resource to update it. Update any of the following resources included in the template:
Buckets. Update buckets
Dashboards. Control dashboards
Labels. Edit labels
Checks. Update checks
Notification endpoints. Update notification endpoints
Notification rules. Update notification rules
Telegraf configurations. Update a Telegraf configurations
(Optional) Add or delete resources from the template, and then use the
influxCLI to export resources to a new template (JSON or YAML file).
To install and configure the influx CLI, complete steps 1-2 in the procedure below.
Apply and manage templates using the influx CLI
Use the influx CLI
to apply and manage templates in your InfluxDB Cloud account.
If you haven’t already, do the following:
Configure the
influxCLI to use your InfluxDB Cloud instance URL, organization, and tokens.Use the
influxCLI to use, manage, and create InfluxDB templates:
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.