Merge pull request #984 from influxdata/timhallinflux-templates
Update InfluxDB Templates Docspull/992/head
commit
524f97d13f
|
@ -7,7 +7,7 @@ menu:
|
|||
parent: InfluxDB templates
|
||||
name: Create a template
|
||||
identifier: Create an InfluxDB template
|
||||
weight: 102
|
||||
weight: 103
|
||||
v2.0/tags: [templates]
|
||||
---
|
||||
|
||||
|
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
title: Get started with InfluxDB templates
|
||||
description: >
|
||||
To get started with InfluxDB templates, you need to download the InfluxDB CLI.
|
||||
menu:
|
||||
v2_0:
|
||||
parent: InfluxDB templates
|
||||
name: Get started with templates in Cloud
|
||||
identifier: Templates requires CLI
|
||||
weight: 101
|
||||
v2.0/tags: [templates]
|
||||
products: [cloud]
|
||||
---
|
||||
|
||||
If you're an InfluxDB Cloud user, you'll need the InfluxDB CLI (`influx`) to run `pkg` commands against your Cloud account.
|
||||
|
||||
InfluxDB OSS 2.0 includes the InfluxDB CLI (`influx`). If you haven’t already, do the following:
|
||||
|
||||
- [Install OSS 2.0](/v2.0/get-started/#start-with-influxdb-oss).
|
||||
- [Set up and use InfluxDB CLI](/v2.0/reference/cli/influx/) with the appropriate InfluxDB Cloud instance URL, organization, and tokens associated with your account.
|
||||
|
||||
Next, discover how to use `influx` and `pkg` to do the following:
|
||||
|
||||
- [Create templates](/v2.0/influxdb-templates/create/)
|
||||
- [Use templates](/v2.0/influxdb-templates/use/)
|
|
@ -7,17 +7,29 @@ menu:
|
|||
v2_0:
|
||||
parent: InfluxDB templates
|
||||
name: Use templates
|
||||
weight: 101
|
||||
weight: 102
|
||||
v2.0/tags: [templates]
|
||||
---
|
||||
|
||||
Use the `influx pkg` command to summarize, validate, and install templates from
|
||||
your local filesystem and from URLs.
|
||||
|
||||
- [Use InfluxDB community templates](#use-influxdb-community-templates)
|
||||
- [View a template summary](#view-a-template-summary)
|
||||
- [Validate a template](#validate-a-template)
|
||||
- [Install templates](#install-templates)
|
||||
- [Use InfluxDB community templates](#use-influxdb-community-templates)
|
||||
|
||||
|
||||
## Use InfluxDB community templates
|
||||
The [InfluxDB community templates repository](https://github.com/influxdata/community-templates/)
|
||||
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.
|
||||
|
||||
{{% note %}} When attempting to access the community templates via the URL, the templates use the following as the root of the URL: `https://raw.githubusercontent.com/influxdata/community-templates/master/`. For example, the Docker community template can be accessed via `https://raw.githubusercontent.com/influxdata/community-templates/master/docker/docker.yml`. {{% /note %}}
|
||||
|
||||
<a class="btn" href="https://github.com/influxdata/community-templates/" target="\_blank">View InfluxDB Community Templates</a>
|
||||
|
||||
## View a template summary
|
||||
To view a summary of what's included in a template before installing the template,
|
||||
|
@ -50,7 +62,7 @@ influx pkg summary -u https://raw.githubusercontent.com/influxdata/community-tem
|
|||
{{% /code-tabs-wrapper %}}
|
||||
|
||||
## Validate a template
|
||||
To validate a template before your install it or troubleshoot a template, use
|
||||
To validate a template before you install it or troubleshoot a template, use
|
||||
the [`influx pkg validate` command](/v2.0/reference/cli/influx/pkg/validate/).
|
||||
Validate a template stored in your local filesystem or from a URL.
|
||||
|
||||
|
@ -200,11 +212,3 @@ influx pkg -f /path/to/template.yml \
|
|||
|
||||
_To add a secret after installing a template, see [Add secrets](/v2.0/security/secrets/manage-secrets/add/)._
|
||||
|
||||
## Use InfluxDB community templates
|
||||
The [InfluxDB Community Templates repository](https://github.com/influxdata/community-templates/)
|
||||
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.
|
||||
|
||||
<a class="btn" href="https://github.com/influxdata/community-templates/" target="\_blank">View InfluxDB Community Templates</a>
|
||||
|
|
Loading…
Reference in New Issue