docs-v2/content/influxdb/cloud/tools/influxdb-templates/cloud.md

3.9 KiB
Raw Permalink Blame History

title list_title description menu weight aliases influxdb/cloud/tags
InfluxDB templates in InfluxDB Cloud 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.
influxdb_cloud
parent name
InfluxDB templates Templates in Cloud
101
/influxdb/cloud/influxdb-templates/get_started_cloud/
/influxdb/cloud/influxdb-templates/cloud/
templates

To use templates in InfluxDB Cloud, you have a couple options:

Install and customize a template in the Cloud UI

{{% note %}} 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. {{% /note %}}

  1. Under Settings icon in the navigation bar.

    {{< nav-icon "settings" >}}

  2. Click Templates.

  3. (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).

  4. 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).

  5. Click Install Template. A message confirms the template has been successfully installed.

  6. Under Installed Templates, find the template, and do the following:

  7. (Optional) Add or delete resources from the template, and then use the influx CLI to export resources to a new template (JSON or YAML file).

{{% note %}} To install and configure the influx CLI, complete steps 1-2 in the procedure below. {{% /note %}}

Apply and manage templates using the influx CLI

Use the influx CLI to apply and manage templates in your InfluxDB Cloud account. If you havent already, do the following:

  1. Download and install influx CLI.

  2. Configure the influx CLI to use your InfluxDB Cloud instance URL, organization, and tokens.

  3. Use the influx CLI to use, manage, and create InfluxDB templates: