Merge pull request #653 from influxdata/packager

influx pkg cli docs
pull/645/head^2
pierwill 2019-12-05 09:13:30 -08:00 committed by GitHub
commit c47e51e67e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 41 additions and 0 deletions

View File

@ -51,6 +51,7 @@ retrieving authentication tokens._
| [help](/v2.0/reference/cli/influx/help) | Help about any command |
| [org](/v2.0/reference/cli/influx/org) | Organization management commands |
| [ping](/v2.0/reference/cli/influx/ping) | Check the InfluxDB `/health` endpoint |
| [pkg](/v2.0/reference/cli/influx/pkg) | Manage InfluxDB packages
| [query](/v2.0/reference/cli/influx/query) | Execute a Flux query |
| [repl](/v2.0/reference/cli/influx/repl) | Interactive REPL (read-eval-print-loop) |
| [setup](/v2.0/reference/cli/influx/setup) | Create default username, password, org, bucket, etc. |

View File

@ -0,0 +1,40 @@
---
title: influx pkg package management commands
description: The 'influx pkg' command and its subcommands manage packages in InfluxDB.
menu:
v2_0_ref:
name: influx pkg
parent: influx
weight: 101
v2.0/tags: [packages]
---
The `influx pkg` command manages packages in InfluxDB.
## Usage
```
influx pkg [flags]
influx pkg [command]
```
## Available commands
| Command | Description |
|:--------|----------------------------------------------------------------|
| `all` | Export all existing resources for an organization as a package |
## Flags
| Flag | Description | Input Type |
|:----------------------|:--------------------------------------------------------------------------------|-----------------|
| `--buckets` | Comma-separated list of bucket IDs | list of strings |
| `--dashboards` | Comma-separated list of dashboard IDs | list of strings |
| `-d`, `--description` | Package description | string |
| `-f`, `--file` | Package output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string |
| `-h`, `--help` | Help for the `export` command | |
| `--labels` | Comma-separated list of label IDs | list of strings |
| `-n`, `--name` | Package name | string |
| `--resource-type` | Resource type associated with all IDs via stdin | string |
| `--variables` | Comma-separated list of variable IDs | list of strings |
| `-v`, `--version` | Package version | string |
{{% influx-cli-global-flags %}}