InfluxDB Docs

Use InfluxDB templates

Use the influx pkg command to summarize, validate, and install templates from your local filesystem and from URLs.

View a template summary

To view a summary of what’s included in a template before installing the template, use the influx pkg summary command. View a summary of a template stored in your local filesystem or from a URL.

# Syntax
influx pkg summary -f <template-file-path>

# Example
influx pkg summary -f /path/to/template.yml
# Syntax
influx pkg summary -u <template-url>

# Example
influx pkg summary -u https://raw.githubusercontent.com/influxdata/community-templates/master/linux_system/linux_system.yml

Validate a template

To validate a template before your install it or troubleshoot a template, use the influx pkg validate command. Validate a template stored in your local filesystem or from a URL.

# Syntax
influx pkg validate -f <template-file-path>

# Example
influx pkg validate -f /path/to/template.yml
# Syntax
influx pkg validate -u <template-url>

# Example
influx pkg validate -u https://raw.githubusercontent.com/influxdata/community-templates/master/linux_system/linux_system.yml

Install templates

Use the influx pkg command to install templates from your local filesystem or from URLs.

Install a template from a file

To install templates stored on your local machine, use the -f or --file flag to provide the file path of the template manifest.

# Syntax
influx pkg -f <template-file-path>

# Examples
# Install a single template
influx pkg -f /path/to/template.yml

# Install multiple templates
influx pkg \
  -f /path/to/this/template.yml \
  -f /path/to/that/template.yml

Install all templates in a directory

To install all templates in a directory, use the -f or --file flag to provide the directory path of the directory where template manifests are stored. By default, this only installs templates stored in the specified directory. To install all templates stored in the specified directory and its subdirectories, include the --recurse flag.

# Syntax
influx pkg -f <template-directory-path>

# Examples
# Install all templates in a directory
influx pkg -f /path/to/template/dir/

# Install all templates in a directory and its subdirectories
influx pkg -f /path/to/template/dir/ --recurse

Install a template from a URL

To install templates from a URL, use the -u or --url flag to provide the URL of the template manifest.

# Syntax
influx pkg -u <template-url>

# Examples
# Install a single template from a URL
influx pkg -u https://mydomain.com/templates/template.yml

# Install multiple templates from URLs
influx pkg \
  -u https://mydomain.com/templates/template1.yml \
  -u https://mydomain.com/templates/template2.yml

Install templates from both files and URLs

To install templates from both files and URLs in a single command, include multiple file or directory paths and URLs, each with the appropriate -f or -u flag.

# Syntax
influx pkg -u <template-url> -f <template-path>

# Example
influx pkg \
  -u https://mydomain.com/templates/template1.yml \
  -u https://mydomain.com/templates/template2.yml \
  -f ~/templates/custom-template.yml \
  -f ~/templates/iot/home/ \
  --recurse

Define environment references

Some templates include environment references that let you provide custom resource names. The influx pkg command prompts you to provide a value for each environment reference in the template. You can also provide values for environment references by including an --env-ref flag with a key-value pair comprised of the environment reference key and the value to replace it.

influx pkg -f /path/to/template.yml \
  --env-ref=bucket-name-1=myBucket
  --env-ref=label-name-1=Label1 \
  --env-ref=label-name-2=Label2

Include a secret when installing a template

Some templates use secrets in queries. Secret values are not included in templates. To define secret values when installing a template, include the --secret flag with the secret key-value pair.

# Syntax
influx pkg -f <template-file-path> --secret=<secret-key>=<secret-value>

# Examples
# Define a single secret when installing a template
influx pkg -f /path/to/template.yml \
  --secret=FOO=BAR

# Define multiple secrets when installing a template
influx pkg -f /path/to/template.yml \
  --secret=FOO=bar \
  --secret=BAZ=quz

To add a secret after installing a template, see Add secrets.

Use InfluxDB community templates

The InfluxDB Community Templates repository is home to a growing number of InfluxDB templates developed and maintained by others in the InfluxData community. Install community templates directly from GitHub using a template’s download URL or download the template.

View InfluxDB Community Templates