Skip to content

Commit

Permalink
chore: update CLI command to use stable CLI API
Browse files Browse the repository at this point in the history
all influx pkg commands are deprecated moving forward and will be sunset.

closes: influxdata#140
  • Loading branch information
jsteenb2 committed Jul 1, 2020
1 parent 535eb2c commit 0a47f8d
Show file tree
Hide file tree
Showing 37 changed files with 42 additions and 42 deletions.
2 changes: 1 addition & 1 deletion Example_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Provide a short description of your template and use case here. Try to keep it t
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/{your_template_dir}/{your_template_file}
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/{your_template_dir}/{your_template_file}
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion InfluxDBv2_Covid19_SouthAmerica/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This Dashboard graph information about COVID-19 focused in Argentina, Bolivia, B
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/InfluxDBv2_Covid19_SouthAmerica/covid.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/InfluxDBv2_Covid19_SouthAmerica/covid.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,6 @@ You can also ask the community to create a template for a specific use-case by c

Community InfluxDB templates are provided by members of the community. Template authors are solely responsible for supporting their templates. InfluxData does not test contributed templates, nor guarantee their quality or safety. If you have questions about or need help with a specific template, please contact the template author using the contact information provided in the template README.

InfluxData provides and supports the `influx` command-line tool and `influx pkg` command for importing and exporting template manifests. You'll need the [InfluxDB 2.0.0 beta or greater](https://portal.influxdata.com/downloads/) for the `influx pkg` command. For help with these tools, please join our [Community Slack](https://influxdata.com/slack) and ask for help in the `#community-support` channel.
InfluxData provides and supports the `influx` command-line tool and `influx apply` command for importing and exporting template manifests. You'll need the [InfluxDB 2.0.0 beta or greater](https://portal.influxdata.com/downloads/) for the `influx apply` command. For help with these tools, please join our [Community Slack](https://influxdata.com/slack) and ask for help in the `#community-support` channel.

[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://www.influxdata.com/slack)
2 changes: 1 addition & 1 deletion apache_postgresql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This InfluxDB Template can be used to monitor a website running on Apache HTTPd
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/apache_postgresql/website_template.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/apache_postgresql/website_template.yml
```

### Included Resources
Expand Down
2 changes: 1 addition & 1 deletion aws_cloudwatch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Provided by: [bonitoo.io](.)
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/aws_cloudwatch/aws_cloudwatch.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/aws_cloudwatch/aws_cloudwatch.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion csgo/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This Dashboard offers you information about your game in CSGO. Information about
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/csgo/csgo.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/csgo/csgo.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion currency_exchange_rates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ It also shows how to use functions such as [timedMovingAverage()](https://v2.doc
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/currency_exchange_rates/currency_exchange_rates.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/currency_exchange_rates/currency_exchange_rates.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This InfluxDB Template can be used to monitor Docker.
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/docker/docker.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/docker/docker.yml
```

### Included Resources
Expand Down
2 changes: 1 addition & 1 deletion docs/best_practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ This will give the user a drop-down menu with all of the unique values of the ta
[Labels](https://v2.docs.influxdata.com/v2.0/visualize-data/labels/) let you tag your resources for easier identification in the UI and make it easier to export resources into a Template. If you have a mix of resources in your InfluxDB instance you will have to individually specify which ones to export so that you don't export them all. However, if you use unique Labels to identify resources, you can filter resources by Label when exporting your Template:

```
influx pkg export all --filter=labelName=your_label_name
influx export all --filter=labelName=your_label_name
```

## Telegraf Configurations
Expand Down
2 changes: 1 addition & 1 deletion docs/submit_a_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To contribute a new template or enhance an existing template, submit a pull requ
Use the following command to export the template and generate a manifest file ([Influx pkg requires InfluxDB 2.0.0 beta or greater](https://portal.influxdata.com/downloads/)):

```
influx pkg export --file ~/path/to/template/manifest.yml
influx export --file ~/path/to/template/manifest.yml
```
> Exported manifest files will be YAML or JSON. The filename extension you provide will determine the format used.
Expand Down
8 changes: 4 additions & 4 deletions docs/use_a_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Each template provides a manifest file and instructions for using the template.
To import a template, use the following command:

```
influx pkg --file ~/path/to/template/manifest.yml
influx apply --file ~/path/to/template/manifest.yml
```

This imports the specified `manifest.yml` into an instance of InfluxDB running on `localhost`.
Expand All @@ -17,7 +17,7 @@ This imports the specified `manifest.yml` into an instance of InfluxDB running o
If you don't want to download the manifest file locally, you can point to its remote location using the `--url` flag, for example:
```
influx pkg --url https://raw.githubusercontent.com/influxdata/community-templates/master/template/manifest.yml
influx apply --url https://raw.githubusercontent.com/influxdata/community-templates/master/template/manifest.yml
```

NOTE: Ensure that when pulling a file from Github, you will need to use the `raw` content link from the `Raw` button, not the URL of the file.
Expand All @@ -27,7 +27,7 @@ NOTE: Ensure that when pulling a file from Github, you will need to use the `raw
If you are using InfluxDB Cloud, ensure that your Influx CLI is configured with your cloud account credentials and that configuration is active. See `influx config -h` or the [InfluxDB documentation](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/) for more details.

```
influx pkg --file ~/path/to/template/manifest.yml
influx apply --file ~/path/to/template/manifest.yml
```

> Your default organization name in InfluxDB Cloud will be your email address.
Expand All @@ -42,7 +42,7 @@ To apply templates and download Telegraf configurations from InfluxDB Cloud, cre
If running InfluxDB on a remote server, provide the URL of your InfluxDB instance using the `--host` flag and provide your InfluxDB authentication token using the ``--token`` flag:

```
influx pkg --file ~/path/to/template/manifest.yml
influx apply --file ~/path/to/template/manifest.yml
```


Expand Down
2 changes: 1 addition & 1 deletion enviro_plus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ View the air quality readings from a [Pimoroni Enviro+](https://shop.pimoroni.co
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/enviro_plus/enviro_plus.json
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/enviro_plus/enviro_plus.json
```

## Included Resources
Expand Down
4 changes: 2 additions & 2 deletions gcp_monitoring/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Cloud Monitoring API v3. There are three dashboards in this template.**
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/gcp_monitoring/gcp_monitoring.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/gcp_monitoring/gcp_monitoring.yml
```

## Included Resources
Expand All @@ -42,7 +42,7 @@ environment.

An example command:
```bash
$ ${INFLUX_PATH}/influx pkg --org qa --file ${myTemplateFile} -t ${INFLUX_TOKEN}
$ ${INFLUX_PATH}/influx apply --org qa --file ${myTemplateFile} -t ${INFLUX_TOKEN}
```

Include the [Telegraf Stackdriver plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/stackdriver) in your Telegraf configuration and start Telegraf.
Expand Down
2 changes: 1 addition & 1 deletion github/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This dashboard help you get metrics of your Github repository.
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/github/github.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/github/github.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion haproxy/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This dashboard help you get metrics of your HAProxy instance.
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/haproxy/haproxy.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/haproxy/haproxy.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion influxdb2_oss_metrics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This InfluxDB Template can be used to monitor your already running InfluxDB 2 in
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/influxdb2_oss_metrics/influxdb2_oss_metrics.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/influxdb2_oss_metrics/influxdb2_oss_metrics.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion jenkins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This InfluxDB Template can be used to montior a Jenkins instance
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/jenkins/jenkins.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/jenkins/jenkins.yml
```

### Included Resources
Expand Down
2 changes: 1 addition & 1 deletion k8s/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ supports Google Cloud Platform, AWS and on-premise K8S environments.**
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/k8s/k8s.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/k8s/k8s.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion linux_system/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This InfluxDB Template can be used to monitor your Linux System.
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/linux_system/linux_system.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/linux_system/linux_system.yml
```

### Included Resources
Expand Down
2 changes: 1 addition & 1 deletion minio/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This template allows you to monitor your MinIO instance. The data you can watch
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/minio/minio.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/minio/minio.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion modbus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The goal of this template is to provide an example of using Telgraf's Modbus inp
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/modbus/modbus.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/modbus/modbus.yml
```

### Included Resources
Expand Down
2 changes: 1 addition & 1 deletion mongodb/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This Dashboard offers you information about your MongoDB instance. Uptime, Conne
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/mongodb/mongodb.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/mongodb/mongodb.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion monitoring_influxdb_1.x/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This InfluxDB Template can be used to monitor your already running InfluxDB 1.x
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/monitoring_influxdb_1.x/influxdb1.x.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/monitoring_influxdb_1.x/influxdb1.x.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion mssql/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This Dashboard offers you information about your Microsoft SQL Server. Uptime, C
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/mssql/mssql.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/mssql/mssql.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion mysql_mariadb/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This Dashboard offers you information about your MySQL/MariaDB instance. Uptime,
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/mysql_mariadb/mysql_mariadb.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/mysql_mariadb/mysql_mariadb.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion network_interface_performance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This InfluxDB Template can be used to monitor your network traffic across multip
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/network_interface_performance/network_interface_performance.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/network_interface_performance/network_interface_performance.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion nginx_mysql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This InfluxDB Template can be used to monitor a website running on NGINX and MyS
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/nginx_mysql/nginx_mysql.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/nginx_mysql/nginx_mysql.yml
```

### Included Resources
Expand Down
2 changes: 1 addition & 1 deletion postgresql/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This Dashboard offers you information about your Postgres instance. CPU Usage, R
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/postgresql/postgres.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/postgresql/postgres.yml
```

## Included Resources
Expand Down
2 changes: 1 addition & 1 deletion redis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This InfluxDB Template can be used to monitor Redis.
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/redis/redis.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/redis/redis.yml
```

### Included Resources
Expand Down
2 changes: 1 addition & 1 deletion sflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This InfluxDB Template can be used to monitor traffic from sFlow sources.
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/sflow/sflow.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/sflow/sflow.yml
```

### Included Resources
Expand Down
2 changes: 1 addition & 1 deletion snmp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This template provides several dashboards showing metrics provided via SNMP prot
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/snmp/snmp.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/snmp/snmp.yml
```

## Included Resources
Expand Down
4 changes: 2 additions & 2 deletions telegraf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Provided by: Steven Soroka
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:

```
influx pkg -u https://raw.githubusercontent.com/influxdata/community-templates/master/telegraf/manifest.yml
influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/telegraf/manifest.yml
```

## Included Resources
Expand Down Expand Up @@ -66,7 +66,7 @@ ___example___
```sh
export TELEGRAF_MANIFEST_URL=https://raw.githubusercontent.com/influxdata/community-templates/master/telegraf/manifest.yml

influx pkg --url $TELEGRAF_MANIFEST_URL \
influx apply --url $TELEGRAF_MANIFEST_URL \
--org $INFLUX_ORG \
--host $INFLUX_HOST \
--token $INFLUX_TOKEN
Expand Down
Loading

0 comments on commit 0a47f8d

Please sign in to comment.