Add UI Install instructions to all readmes, ensure every readme has a…

… Quick Install and Setup Instructions sections
kgartland-rstudio · Sep 4, 2020 · 24b6573 · 24b6573
1 parent 656e85c
commit 24b6573
Show file tree

Hide file tree

Showing 39 changed files with 256 additions and 57 deletions.
diff --git a/Example_README.md → Example_readme.md b/Example_README.md → Example_readme.md
@@ -11,7 +11,12 @@ Provide a short description of your template and use case here. Try to keep it t
 
 ### Quick Install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/{your_template_dir}/{your_template_file}
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/{your_template_dir}/{your_template_file}

diff --git a/InfluxDBv2_Covid19_SouthAmerica/readme.md b/InfluxDBv2_Covid19_SouthAmerica/readme.md
@@ -8,7 +8,12 @@ This Dashboard graph information about COVID-19 focused in Argentina, Bolivia, B
 
 ### Quick Install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/InfluxDBv2_Covid19_SouthAmerica/covid.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/InfluxDBv2_Covid19_SouthAmerica/covid.yml

diff --git a/apache_jmeter/readme.md b/apache_jmeter/readme.md
@@ -24,7 +24,12 @@ JMeter metrics available in this dashboard:
 
 ### Quick Install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/apache_jmeter/apache_jmeter.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/apache_jmeter/apache_jmeter.yml

diff --git a/apache_postgresql/readme.md b/apache_postgresql/readme.md
@@ -6,7 +6,12 @@ This InfluxDB Template can be used to monitor a website running on Apache HTTPd
 
 ### Quick Install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/apache_postgresql/website_template.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/apache_postgresql/website_template.yml

diff --git a/apex_legends/readme.md b/apex_legends/readme.md
@@ -12,7 +12,12 @@ Stats are that of a fantastic YouTuber [iTemp Plays](https://www.youtube.com/use
 
 ### Quick Install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/apex_legends/apex_legends_template.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/apex_legends/apex_legends_template.yml

diff --git a/aws_cloudwatch/readme.md b/aws_cloudwatch/readme.md
@@ -15,7 +15,12 @@ Provided by: [bonitoo.io](.)
 
 ### Quick install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/aws_cloudwatch/aws_cloudwatch.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -f https://raw.githubusercontent.com/influxdata/community-templates/master/aws_cloudwatch/aws_cloudwatch.yml
@@ -30,7 +35,7 @@ This template includes the following:
 - 1 Variable: `bucket`
 - 1 Telegraf Configuration: `AWS CloudWatch`
 
-## Setup instructions
+## Setup Instructions
 
 Load the dashboards and use the [Telegraf CloudWatch plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/cloudwatch) into your
 environment.

diff --git a/csgo/readme.md b/csgo/readme.md
@@ -8,7 +8,12 @@ This Dashboard offers you information about your game in CSGO. Information about
 
 ### Quick Install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/csgo/csgo.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/csgo/csgo.yml

diff --git a/currency_exchange_rates/readme.md b/currency_exchange_rates/readme.md
@@ -22,7 +22,12 @@ It also shows how to use functions such as [timedMovingAverage()](https://v2.doc
 
 ### Quick Install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/currency_exchange_rates/currency_exchange_rates.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/currency_exchange_rates/currency_exchange_rates.yml

diff --git a/docker/readme.md b/docker/readme.md
@@ -6,7 +6,12 @@ Use this InfluxDB template to monitor Docker.
 
 ### Quick install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/docker/docker.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -f https://raw.githubusercontent.com/influxdata/community-templates/master/docker/docker.yml
@@ -23,7 +28,7 @@ influx apply -f https://raw.githubusercontent.com/influxdata/community-templates
 - 1 Notification Endpoint: Http Post
 - 1 Notification Rules: Crit Alert
 
-## Setup instructions
+## Setup Instructions
 
   General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document.
 

diff --git a/endpoint-security-state/readme.md b/endpoint-security-state/readme.md
@@ -1,4 +1,4 @@
-# Endpoint Security State Template
+## Endpoint Security State Template
 
 This InfluxDB template works by connecting to secure endpoints and attempting to log in. Using the `http_response` and `x509_cert` Telegraf plugins, availability, authentication, and certificate information is collected.
 The dashboard displays the general availability for each endpoint along with the x509 certificate status and authentication state.
@@ -10,6 +10,18 @@ The dashboard displays the general availability for each endpoint along with the
 - "🔴" Service is critical.  Endpoint is unavailable, certificate is or will expire in less than 1 day, or authentication is failing.
 - "❓" We could not determine the state of the service.
 
+### Quick Install
+
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/endpoint-security-state/endpoint-security-state.yml
+
+#### Influx CLI
+From your [InfluxDB configured CLI environment](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/):
+```
+influx apply --template-url https://raw.githubusercontent.com/influxdata/community-templates/master/endpoint-security-state/endpoint-security-state.yml
+```
+
 ## Included Resources
 
 - 1 Bucket: `telegraf`
@@ -25,12 +37,6 @@ The dashboard displays the general availability for each endpoint along with the
 
 ## Setup Instructions
 
-### Install the template package
-From your [InfluxDB configured CLI environment](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/):
-```
-influx apply --template-url https://raw.githubusercontent.com/influxdata/community-templates/master/endpoint-security-state/endpoint-security-state.yml
-```
-
 ### Customize the Telegraf configuration
 Add the endpoints you would like to watch to specific input section(s).
 For certificate verfification add URLs to the `sources` list in the `x509_cert` plugin configuration.

diff --git a/fortnite/readme.md b/fortnite/readme.md
@@ -27,6 +27,11 @@ Provides performance insights and metrics tracking for both professional and ama
 
 ### Quick Install
 
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/fortnite/fn-template.yml
+
+#### Influx CLI
 If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```

diff --git a/gcp_monitoring/readme.md b/gcp_monitoring/readme.md
@@ -19,7 +19,12 @@ Cloud Monitoring API v3. There are three dashboards in this template.**
 
 ### Quick install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/gcp_monitoring/gcp_monitoring.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -f https://raw.githubusercontent.com/influxdata/community-templates/master/gcp_monitoring/gcp_monitoring.yml
@@ -34,7 +39,7 @@ This template includes the following:
 - 1 Variable: `bucket`
 - 1 Telegraf Config: `GCP Stackdriver`
 
-## Setup instructions
+## Setup Instructions
 
 
 Load the dashboards and use the Telegraf Stackdriver plugin into your

diff --git a/github/readme.md b/github/readme.md
@@ -8,7 +8,12 @@ This dashboard help you get metrics of your Github repository.
 
 ### Quick Install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/github/github.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/github/github.yml

diff --git a/haproxy/readme.md b/haproxy/readme.md
@@ -8,7 +8,12 @@ This dashboard help you get metrics of your HAProxy instance.
 
 ### Quick Install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/haproxy/haproxy.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/haproxy/haproxy.yml

diff --git a/influxdb2_oss_metrics/readme.md b/influxdb2_oss_metrics/readme.md
@@ -8,7 +8,12 @@ This InfluxDB Template can be used to monitor your already running InfluxDB 2 in
 
 ### Quick Install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/influxdb2_oss_metrics/influxdb2_oss_metrics.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/influxdb2_oss_metrics/influxdb2_oss_metrics.yml

diff --git a/jboss_wildfly/readme.md b/jboss_wildfly/readme.md
@@ -8,7 +8,12 @@ This Dashboard offers you information about your jBoss-Wildfly instance. Uptime,
 
 ### Quick Install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/jboss_wildfly/jboss_wildfly.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/jboss_wildfly/jboss_wildfly.yml

diff --git a/jenkins/readme.md b/jenkins/readme.md
@@ -6,7 +6,12 @@ This InfluxDB Template can be used to montior a Jenkins instance
 
 ### Quick Install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/jenkins/jenkins.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/jenkins/jenkins.yml

diff --git a/k8s/readme.md b/k8s/readme.md
@@ -15,7 +15,12 @@ supports Google Cloud Platform, AWS and on-premise K8S environments.**
 
 ### Quick install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/k8s/k8s.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -f https://raw.githubusercontent.com/influxdata/community-templates/master/k8s/k8s.yml
@@ -31,7 +36,7 @@ This template includes the following:
 - 1 Telegraf Config: `K8S Configuration`
 
 
-## Setup instructions
+## Setup Instructions
 
 Set up and install Telegraf `kubernetes` and `kube_inventory` plugins into your
 Telegraf configmap.

diff --git a/kafka/readme.md b/kafka/readme.md
@@ -1,23 +1,34 @@
-# Kafka Monitoring Template with Telegraf and Jolokia
+## Kafka Monitoring Template with Telegraf and Jolokia
 
-## Dashboards
+### Dashboards
 
-### Kafka
+#### Kafka
 
    <img src="images/kafka-dash.png" width="425"/> <img src="images/kafka-dash-light.png" width="425"/>
 
-### Kafka Producer Metrics
+#### Kafka Producer Metrics
 
    <img src="images/kafka-dash-producer.png" width="425"/> <img src="images/kafka-dash-producer-light.png" width="425"/>
 
-### Kafka Consumer Metrics
+#### Kafka Consumer Metrics
 
    <img src="images/kafka-dash-consumer.png" width="425"/> <img src="images/kafka-dash-consumer-light.png" width="425"/>
 
-### Kafka JVM
+#### Kafka JVM
 
    <img src="images/kafka-dash-jvm.png" width="425"/> <img src="images/kafka-dash-jvm-light.png" width="425"/>
 
+### Quick Install
+
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/kafka/kafka-template.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials configured in the CLI, you can install this template with:
+
+`influx apply -f https://raw.githubusercontent.com/influxdata/community-templates/master/kafka/kafka-template.yml`
+
 ## Requirements
 
 * Set environment variables on host/s from which Telegraf will be sending metrics.  These are:
@@ -35,10 +46,7 @@
 
 *Note: Kafka and Zookeper can be easily obtained and managed through the open source [Confluent Platform](https://www.confluent.io/download).*
 
-## Get started
-If you have your InfluxDB credentials configured in the CLI, you can install this template with:
-
-`influx apply -f https://raw.githubusercontent.com/influxdata/community-templates/master/kafka/kafka-template.yml`
+## Setup Instructions
 
 Once installed, you'll need to start up Telegraf to pull metrics from your Jolokia-attached Kafka broker/s.  Checkout [Telegraf docs](https://docs.influxdata.com/telegraf/v1.14/) for installing and starting Telegraf.
 

diff --git a/linux_system/readme.md b/linux_system/readme.md
@@ -6,7 +6,12 @@ This InfluxDB Template can be used to monitor your Linux System.
 
 ### Quick Install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/linux_system/linux_system.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/linux_system/linux_system.yml

diff --git a/minio/readme.md b/minio/readme.md
@@ -8,7 +8,12 @@ This template allows you to monitor your MinIO instance. The data you can watch
 
 ### Quick Install
 
-If you have your InfluxDB credentials [configured in the CLI](Vhttps://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
+#### InfluxDB UI
+
+In the InfluxDB UI, go to Settings->Templates and enter this URL: https://raw.githubusercontent.com/influxdata/community-templates/master/minio/minio.yml
+
+#### Influx CLI
+If you have your InfluxDB credentials [configured in the CLI](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/), you can install this template with:
 
 ```
 influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/minio/minio.yml