From cd6bace9bfd845a2301995a8562eb323fe66f158 Mon Sep 17 00:00:00 2001 From: timhallinflux Date: Mon, 27 Apr 2020 17:24:33 -0700 Subject: [PATCH 01/12] Update use.md re-ordered the templates page: Community should be the starting point for this. --- content/v2.0/influxdb-templates/use.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/content/v2.0/influxdb-templates/use.md b/content/v2.0/influxdb-templates/use.md index 8709a9a05..3e385ca87 100644 --- a/content/v2.0/influxdb-templates/use.md +++ b/content/v2.0/influxdb-templates/use.md @@ -14,10 +14,23 @@ 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 Community Template for Docker can be accessed via `https://raw.githubusercontent.com/influxdata/community-templates/master/docker/docker.yml`. {{% /note %}} + + +View InfluxDB Community Templates ## View a template summary To view a summary of what's included in a template before installing the template, @@ -200,11 +213,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. - -View InfluxDB Community Templates From 3289ccf2084eab3f33b2fd47611417e122cef809 Mon Sep 17 00:00:00 2001 From: timhallinflux Date: Tue, 28 Apr 2020 11:29:07 -0700 Subject: [PATCH 02/12] Create get_started_cloud.md add instructions for grabbing the CLI...this is required today. --- .../influxdb-templates/get_started_cloud.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 content/v2.0/influxdb-templates/get_started_cloud.md diff --git a/content/v2.0/influxdb-templates/get_started_cloud.md b/content/v2.0/influxdb-templates/get_started_cloud.md new file mode 100644 index 000000000..bbf661bd1 --- /dev/null +++ b/content/v2.0/influxdb-templates/get_started_cloud.md @@ -0,0 +1,18 @@ +--- +title: Get Started with InfluxDB Templates +description: > + To get started with InfluxDB Template, you need to download the InfluxDB CLI. +menu: + v2_0: + parent: InfluxDB templates + name: Get Started with Templates in Cloud + identifier: Templates requires CLI + product: InfluxDB Cloud +weight: 101 +v2.0/tags: [templates] +--- + +If you are an InfluxDB Cloud user, you'll need the InfluxDB CLI (`influx`) in order to run the +various `influx pkg` commands against your Cloud account. + + From c59e8c3adbce0b9b4b859625e077b3b06ad6e6c8 Mon Sep 17 00:00:00 2001 From: timhallinflux Date: Tue, 28 Apr 2020 11:29:59 -0700 Subject: [PATCH 03/12] Update get_started_cloud.md --- content/v2.0/influxdb-templates/get_started_cloud.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/v2.0/influxdb-templates/get_started_cloud.md b/content/v2.0/influxdb-templates/get_started_cloud.md index bbf661bd1..5a2888c05 100644 --- a/content/v2.0/influxdb-templates/get_started_cloud.md +++ b/content/v2.0/influxdb-templates/get_started_cloud.md @@ -7,9 +7,9 @@ menu: parent: InfluxDB templates name: Get Started with Templates in Cloud identifier: Templates requires CLI - product: InfluxDB Cloud weight: 101 v2.0/tags: [templates] +products: [cloud] --- If you are an InfluxDB Cloud user, you'll need the InfluxDB CLI (`influx`) in order to run the From 9b96faa0b30e9dae3cba6266ee7c5cdc4cb04b5a Mon Sep 17 00:00:00 2001 From: timhallinflux Date: Tue, 28 Apr 2020 11:30:50 -0700 Subject: [PATCH 04/12] Update use.md --- content/v2.0/influxdb-templates/use.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/v2.0/influxdb-templates/use.md b/content/v2.0/influxdb-templates/use.md index 3e385ca87..1c9f26eb5 100644 --- a/content/v2.0/influxdb-templates/use.md +++ b/content/v2.0/influxdb-templates/use.md @@ -7,7 +7,7 @@ menu: v2_0: parent: InfluxDB templates name: Use templates -weight: 101 +weight: 102 v2.0/tags: [templates] --- From d90f958563383ff558fadac13a4ca470a8b156bc Mon Sep 17 00:00:00 2001 From: timhallinflux Date: Tue, 28 Apr 2020 11:31:17 -0700 Subject: [PATCH 05/12] Update create.md --- content/v2.0/influxdb-templates/create.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/v2.0/influxdb-templates/create.md b/content/v2.0/influxdb-templates/create.md index 1f9333220..a11f24f47 100644 --- a/content/v2.0/influxdb-templates/create.md +++ b/content/v2.0/influxdb-templates/create.md @@ -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] --- From a9a848e5fb6f8921306cda91949b894ad5a63b18 Mon Sep 17 00:00:00 2001 From: timhallinflux Date: Tue, 28 Apr 2020 14:16:14 -0700 Subject: [PATCH 06/12] Update get_started_cloud.md --- content/v2.0/influxdb-templates/get_started_cloud.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/content/v2.0/influxdb-templates/get_started_cloud.md b/content/v2.0/influxdb-templates/get_started_cloud.md index 5a2888c05..c144683fd 100644 --- a/content/v2.0/influxdb-templates/get_started_cloud.md +++ b/content/v2.0/influxdb-templates/get_started_cloud.md @@ -15,4 +15,13 @@ products: [cloud] If you are an InfluxDB Cloud user, you'll need the InfluxDB CLI (`influx`) in order to run the various `influx pkg` commands against your Cloud account. +The CLI is currently contained within the InfluxDB OSS 2.0 package that you can find on the [downloads page]( + +The download package contains both the InfluxDB OSS 2.0 database executable and the CLI tooling. You can follow the +[instructions](get-started/#start-with-influxdb-oss) for how to unpack these executables. + +You can check out [how to setup and use the InfluxDB CLI tooling](/reference/cli/influx/) to use the appropriate +InfluxDB Cloud instance URL, organization, and tokens associated with your account. + + From 2400058cf0e25f2e12223e108ede83ad4e794f70 Mon Sep 17 00:00:00 2001 From: timhallinflux Date: Tue, 28 Apr 2020 14:18:46 -0700 Subject: [PATCH 07/12] Update get_started_cloud.md --- content/v2.0/influxdb-templates/get_started_cloud.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/v2.0/influxdb-templates/get_started_cloud.md b/content/v2.0/influxdb-templates/get_started_cloud.md index c144683fd..9ca083c9e 100644 --- a/content/v2.0/influxdb-templates/get_started_cloud.md +++ b/content/v2.0/influxdb-templates/get_started_cloud.md @@ -23,5 +23,7 @@ The download package contains both the InfluxDB OSS 2.0 database executable and You can check out [how to setup and use the InfluxDB CLI tooling](/reference/cli/influx/) to use the appropriate InfluxDB Cloud instance URL, organization, and tokens associated with your account. - +In the following instructions, the InfluxDB CLI (`influx`) along with the package command (`pkg`) is used heavily to do +everything from listing a summary of InfluxDB related artifacts contained within the template to installing +the template within your InfluxDB Cloud account. From 95d427748702fd582522b43b92ad473b73db225a Mon Sep 17 00:00:00 2001 From: timhallinflux Date: Tue, 28 Apr 2020 14:21:01 -0700 Subject: [PATCH 08/12] Update get_started_cloud.md --- content/v2.0/influxdb-templates/get_started_cloud.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/v2.0/influxdb-templates/get_started_cloud.md b/content/v2.0/influxdb-templates/get_started_cloud.md index 9ca083c9e..919a15b5b 100644 --- a/content/v2.0/influxdb-templates/get_started_cloud.md +++ b/content/v2.0/influxdb-templates/get_started_cloud.md @@ -15,7 +15,7 @@ products: [cloud] If you are an InfluxDB Cloud user, you'll need the InfluxDB CLI (`influx`) in order to run the various `influx pkg` commands against your Cloud account. -The CLI is currently contained within the InfluxDB OSS 2.0 package that you can find on the [downloads page]( +The CLI is currently contained within the InfluxDB OSS 2.0 package that you can find on the [downloads page](https://portal.influxdata.com/downloads/). The download package contains both the InfluxDB OSS 2.0 database executable and the CLI tooling. You can follow the [instructions](get-started/#start-with-influxdb-oss) for how to unpack these executables. From c467676be3d6451d8f8f7027c14fea5fb42735ae Mon Sep 17 00:00:00 2001 From: kelseiv <47797004+kelseiv@users.noreply.github.com> Date: Tue, 28 Apr 2020 16:05:33 -0700 Subject: [PATCH 09/12] Update get_started_cloud.md add edits --- .../influxdb-templates/get_started_cloud.md | 25 ++++++++----------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/content/v2.0/influxdb-templates/get_started_cloud.md b/content/v2.0/influxdb-templates/get_started_cloud.md index 919a15b5b..ecb85a673 100644 --- a/content/v2.0/influxdb-templates/get_started_cloud.md +++ b/content/v2.0/influxdb-templates/get_started_cloud.md @@ -1,29 +1,24 @@ --- -title: Get Started with InfluxDB Templates +title: Get started with InfluxDB templates description: > - To get started with InfluxDB Template, you need to download the InfluxDB CLI. + 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 + name: Get started with templates in Cloud identifier: Templates requires CLI weight: 101 v2.0/tags: [templates] products: [cloud] --- -If you are an InfluxDB Cloud user, you'll need the InfluxDB CLI (`influx`) in order to run the -various `influx pkg` commands against your Cloud account. +If you are an InfluxDB Cloud user, you'll need the InfluxDB CLI (`influx`) to run `pkg` commands against your Cloud account. -The CLI is currently contained within the InfluxDB OSS 2.0 package that you can find on the [downloads page](https://portal.influxdata.com/downloads/). +InfluxDB OSS 2.0 includes the InfluxDB CLI (`influx`). If you haven’t already, do the following: -The download package contains both the InfluxDB OSS 2.0 database executable and the CLI tooling. You can follow the -[instructions](get-started/#start-with-influxdb-oss) for how to unpack these executables. - -You can check out [how to setup and use the InfluxDB CLI tooling](/reference/cli/influx/) to use the appropriate -InfluxDB Cloud instance URL, organization, and tokens associated with your account. - -In the following instructions, the InfluxDB CLI (`influx`) along with the package command (`pkg`) is used heavily to do -everything from listing a summary of InfluxDB related artifacts contained within the template to installing -the template within your InfluxDB Cloud account. +- [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/) From 387333c8468cfc1b0030caa88b2fc70c85b16578 Mon Sep 17 00:00:00 2001 From: kelseiv <47797004+kelseiv@users.noreply.github.com> Date: Tue, 28 Apr 2020 16:06:19 -0700 Subject: [PATCH 10/12] Update get_started_cloud.md --- content/v2.0/influxdb-templates/get_started_cloud.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/v2.0/influxdb-templates/get_started_cloud.md b/content/v2.0/influxdb-templates/get_started_cloud.md index ecb85a673..5c81f8885 100644 --- a/content/v2.0/influxdb-templates/get_started_cloud.md +++ b/content/v2.0/influxdb-templates/get_started_cloud.md @@ -12,7 +12,7 @@ v2.0/tags: [templates] products: [cloud] --- -If you are an InfluxDB Cloud user, you'll need the InfluxDB CLI (`influx`) to run `pkg` commands against your Cloud account. +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: From 5c1f35d15d1d76f1d5f12a152d1af0f0a7302c8a Mon Sep 17 00:00:00 2001 From: kelseiv <47797004+kelseiv@users.noreply.github.com> Date: Tue, 28 Apr 2020 16:07:56 -0700 Subject: [PATCH 11/12] Update get_started_cloud.md space --- content/v2.0/influxdb-templates/get_started_cloud.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/v2.0/influxdb-templates/get_started_cloud.md b/content/v2.0/influxdb-templates/get_started_cloud.md index 5c81f8885..a6a9b094e 100644 --- a/content/v2.0/influxdb-templates/get_started_cloud.md +++ b/content/v2.0/influxdb-templates/get_started_cloud.md @@ -20,5 +20,6 @@ InfluxDB OSS 2.0 includes the InfluxDB CLI (`influx`). If you haven’t already, - [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/) From 83702433a4a69eb226330ed0c35f66e29875dfb0 Mon Sep 17 00:00:00 2001 From: kelseiv <47797004+kelseiv@users.noreply.github.com> Date: Tue, 28 Apr 2020 16:13:24 -0700 Subject: [PATCH 12/12] Update use.md minor edits --- content/v2.0/influxdb-templates/use.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/content/v2.0/influxdb-templates/use.md b/content/v2.0/influxdb-templates/use.md index 1c9f26eb5..9ac5e72b8 100644 --- a/content/v2.0/influxdb-templates/use.md +++ b/content/v2.0/influxdb-templates/use.md @@ -21,14 +21,13 @@ your local filesystem and from URLs. ## Use InfluxDB community templates -The [InfluxDB Community Templates repository](https://github.com/influxdata/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 Community Template for Docker can be accessed via `https://raw.githubusercontent.com/influxdata/community-templates/master/docker/docker.yml`. {{% /note %}} - +{{% 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 %}} View InfluxDB Community Templates @@ -63,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.