Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #757 from influxdata/beta-3 

Beta 3
pull/762/head
Scott Anderson 2020-02-11 16:16:09 -07:00 committed by GitHub
parent 7652472ae0 f21f2ef027
commit 8b284f13c1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
21 changed files with 405 additions and 149 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
api-docs/v2.0/swagger.yml
View File

@ -3322,6 +3322,12 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/Bucket" $ref: "#/components/schemas/Bucket"
422:
description: Request body failed validation
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
default: default:
description: Unexpected error description: Unexpected error
content: content:
@ -7139,18 +7145,24 @@ components:
type: string type: string
package: package:
$ref: "#/components/schemas/Pkg" $ref: "#/components/schemas/Pkg"
packages:
type: array
items:
$ref: "#/components/schemas/Pkg"
secrets: secrets:
type: object type: object
additionalProperties: additionalProperties:
type: string type: string
remote: remotes:
type: object type: array
properties: items:
url: type: object
type: string properties:
contentType: url:
type: string type: string
required: ["url"] contentType:
type: string
required: ["url"]
PkgCreate: PkgCreate:
type: object type: object
properties: properties:
@ -7284,6 +7296,10 @@ components:
type: string type: string
labelID: labelID:
type: string type: string
missingEnvRefs:
type: array
items:
type: string
missingSecrets: missingSecrets:
type: array type: array
items: items:

14
content/v2.0/get-started.md
View File

@ -28,7 +28,7 @@ This article describes how to get started with InfluxDB OSS. To get started with
### Download and install InfluxDB v2.0 beta ### Download and install InfluxDB v2.0 beta
Download InfluxDB v2.0 beta for macOS. Download InfluxDB v2.0 beta for macOS.
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb_2.0.0-beta.2_darwin_amd64.tar.gz" download>InfluxDB v2.0 beta (macOS)</a> <a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb_2.0.0-beta.3_darwin_amd64.tar.gz" download>InfluxDB v2.0 beta (macOS)</a>
### Unpackage the InfluxDB binaries ### Unpackage the InfluxDB binaries
To unpackage the downloaded archive, **double click the archive file in Finder** To unpackage the downloaded archive, **double click the archive file in Finder**
@ -37,7 +37,7 @@ or run the following command in a macOS command prompt application such
```sh ```sh
# Unpackage contents to the current working directory # Unpackage contents to the current working directory
tar zxvf ~/Downloads/influxdb_2.0.0-beta.2_darwin_amd64.tar.gz tar zxvf ~/Downloads/influxdb_2.0.0-beta.3_darwin_amd64.tar.gz
``` ```
#### (Optional) Place the binaries in your $PATH #### (Optional) Place the binaries in your $PATH
@ -46,7 +46,7 @@ prefix the executables with `./` to run then in place.
```sh ```sh
# (Optional) Copy the influx and influxd binary to your $PATH # (Optional) Copy the influx and influxd binary to your $PATH
sudo cp influxdb_2.0.0-beta.2_darwin_amd64/{influx,influxd} /usr/local/bin/ sudo cp influxdb_2.0.0-beta.3_darwin_amd64/{influx,influxd} /usr/local/bin/
``` ```
{{% note %}} {{% note %}}
@ -106,8 +106,8 @@ influxd --reporting-disabled
### Download and install InfluxDB v2.0 beta ### Download and install InfluxDB v2.0 beta
Download the InfluxDB v2.0 beta package appropriate for your chipset. Download the InfluxDB v2.0 beta package appropriate for your chipset.
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb_2.0.0-beta.2_linux_amd64.tar.gz" download >InfluxDB v2.0 beta (amd64)</a> <a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb_2.0.0-beta.3_linux_amd64.tar.gz" download >InfluxDB v2.0 beta (amd64)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb_2.0.0-beta.2_linux_arm64.tar.gz" download >InfluxDB v2.0 beta (arm)</a> <a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb_2.0.0-beta.3_linux_arm64.tar.gz" download >InfluxDB v2.0 beta (arm)</a>
### Place the executables in your $PATH ### Place the executables in your $PATH
Unpackage the downloaded archive and place the `influx` and `influxd` executables in your system `$PATH`. Unpackage the downloaded archive and place the `influx` and `influxd` executables in your system `$PATH`.
@ -116,10 +116,10 @@ _**Note:** The following commands are examples. Adjust the file names, paths, an
```sh ```sh
# Unpackage contents to the current working directory # Unpackage contents to the current working directory
tar xvzf path/to/influxdb_2.0.0-beta.2_linux_amd64.tar.gz tar xvzf path/to/influxdb_2.0.0-beta.3_linux_amd64.tar.gz
# Copy the influx and influxd binary to your $PATH # Copy the influx and influxd binary to your $PATH
sudo cp influxdb_2.0.0-beta.2_linux_amd64/{influx,influxd} /usr/local/bin/ sudo cp influxdb_2.0.0-beta.3_linux_amd64/{influx,influxd} /usr/local/bin/
``` ```
{{% note %}} {{% note %}}

1
content/v2.0/reference/cli/influx/_index.md
View File

@ -55,6 +55,7 @@ retrieving authentication tokens._
| [pkg](/v2.0/reference/cli/influx/pkg) | Manage InfluxDB packages | | [pkg](/v2.0/reference/cli/influx/pkg) | Manage InfluxDB packages |
| [query](/v2.0/reference/cli/influx/query) | Execute a Flux query | | [query](/v2.0/reference/cli/influx/query) | Execute a Flux query |
| [repl](/v2.0/reference/cli/influx/repl) | Interactive REPL (read-eval-print-loop) | | [repl](/v2.0/reference/cli/influx/repl) | Interactive REPL (read-eval-print-loop) |
| [secret](/v2.0/reference/cli/influx/secret) | Manage secrets |
| [setup](/v2.0/reference/cli/influx/setup) | Create default username, password, org, bucket, etc. | | [setup](/v2.0/reference/cli/influx/setup) | Create default username, password, org, bucket, etc. |
| [task](/v2.0/reference/cli/influx/task) | Task management commands | | [task](/v2.0/reference/cli/influx/task) | Task management commands |
| [transpile](/v2.0/reference/cli/influx/transpile) | Manually transpile an InfluxQL query to Flux | | [transpile](/v2.0/reference/cli/influx/transpile) | Manually transpile an InfluxQL query to Flux |

27
content/v2.0/reference/cli/influx/pkg/_index.md
View File

@ -21,22 +21,25 @@ influx pkg [command]
| Command | Description | | Command | Description |
|:------- |:----------- | |:------- |:----------- |
| [export](/v2.0/reference/cli/influx/pkg/export/) | Export existing resources as a package | | [export](/v2.0/reference/cli/influx/pkg/export/) | Export existing resources as a package |
| [new](/v2.0/reference/cli/influx/pkg/new/) | Create a reusable pkg to create resources in a declarative manner |
| [summary](/v2.0/reference/cli/influx/pkg/summary/) | Summarize the provided package | | [summary](/v2.0/reference/cli/influx/pkg/summary/) | Summarize the provided package |
| [validate](/v2.0/reference/cli/influx/pkg/validate/) | Validate the provided package | | [validate](/v2.0/reference/cli/influx/pkg/validate/) | Validate the provided package |
## Flags ## Flags
| Flag | Description | Input Type | | Flag | Description | Input Type |
|:---- |:----------------------------- |:---------- | |:---- |:----------------------------- |:---------- |
| `-c`, `--disable-color` | Disable color in output | | | `-c`, `--disable-color` | Disable color in output | |
| `-f`, `--file` | Path to package file | string | | `--disable-table-borders` | Disable table borders | |
| `--force` | Ignore warnings about destructive changes | | | `-e`, `--encoding` | Encoding of the input stream | string |
| `-h`, `--help` | Help for the `pkg` command | | | `--env-ref` | Environment references to provide alongside the package (format: `--env-ref=REF_KEY=REF_VALUE`) | string |
| `-o`, `--org` | The name of the organization that owns the bucket | string | | `-f`, `--file` | Path to package file | string |
| `--org-id` | The ID of the organization that owns the bucket | string | | `--force` | Ignore warnings about destructive changes | |
| `-q`, `--quiet` | Disable output printing | | | `-h`, `--help` | Help for the `pkg` command | |
| `--secret` | Secrets to provide alongside the package (format: `--secret=SECRET_KEY=SECRET_VALUE`) | string | | `-o`, `--org` | The name of the organization that owns the bucket | string |
| `--disable-table-borders` | Disable table borders | | | `--org-id` | The ID of the organization that owns the bucket | string |
| `-q`, `--quiet` | Disable output printing | |
| `-R`, `--recurse` | Recurse through files in the directory specified in `-f`, `--file` | |
| `--secret` | Secrets to provide alongside the package (format: `--secret=SECRET_KEY=SECRET_VALUE`) | string |
| `-u`, `--url` | URL of package file | string |
{{% influx-cli-global-flags %}} {{% influx-cli-global-flags %}}

3
content/v2.0/reference/cli/influx/pkg/export/_index.md
View File

@ -27,17 +27,14 @@ influx pkg export [command]
| `--buckets` | Comma-separated list of bucket IDs | string | | `--buckets` | Comma-separated list of bucket IDs | string |
| `--checks` | Comma-separated list of check IDs | string | | `--checks` | Comma-separated list of check IDs | string |
| `--dashboards` | Comma-separated list of dashboard IDs | string | | `--dashboards` | Comma-separated list of dashboard IDs | string |
| `-d`, `--description` | Package description | string |
| `--endpoints` | Comma-separated list of notification endpoint IDs | string | | `--endpoints` | Comma-separated list of notification endpoint IDs | string |
| `-f`, `--file` | Package output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | | `-f`, `--file` | Package output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string |
| `-h`, `--help` | Help for the `export` command | | | `-h`, `--help` | Help for the `export` command | |
| `--labels` | Comma-separated list of label IDs | string | | `--labels` | Comma-separated list of label IDs | string |
| `-n`, `--name` | Package name | string |
| `--resource-type` | Resource type associated with all IDs via stdin | string | | `--resource-type` | Resource type associated with all IDs via stdin | string |
| `--rules` | Comma-separated list of notification rule IDs | string | | `--rules` | Comma-separated list of notification rule IDs | string |
| `--tasks` | Comma-separated list of task IDs | string | | `--tasks` | Comma-separated list of task IDs | string |
| `--telegraf-configs` | Comma-separated list of Telegraf configuration IDs | string | | `--telegraf-configs` | Comma-separated list of Telegraf configuration IDs | string |
| `--variables` | Comma-separated list of variable IDs | string | | `--variables` | Comma-separated list of variable IDs | string |
| `-v`, `--version` | Package version | string |
{{% influx-cli-global-flags %}} {{% influx-cli-global-flags %}}

3
content/v2.0/reference/cli/influx/pkg/export/all.md
View File

@ -20,12 +20,9 @@ influx pkg export all [flags]
| Flag | Description | Input Type | | Flag | Description | Input Type |
|:---- |:----------- |:---------- | |:---- |:----------- |:---------- |
| `-d`, `--description` | Package description | string |
| `-f`, `--file` | Package output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | | `-f`, `--file` | Package output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string |
| `-h`, `--help` | Help for the `export` command | | | `-h`, `--help` | Help for the `export` command | |
| `-n`, `--name` | Package name | string |
| `-o`, `--org` | The name of the organization that owns the resources | string | | `-o`, `--org` | The name of the organization that owns the resources | string |
| `--org-id` | The ID of the organization that owns the resources | string | | `--org-id` | The ID of the organization that owns the resources | string |
| `-v`, `--version` | Package version | string |
{{% influx-cli-global-flags %}} {{% influx-cli-global-flags %}}

31
content/v2.0/reference/cli/influx/pkg/new.md
View File

@ -1,31 +0,0 @@
---
title: influx pkg new
description: >
The 'influx pkg new' command creates a reusable package that create resources
in a declarative manner.
menu:
v2_0_ref:
parent: influx pkg
weight: 101
---
The `influx pkg new` command creates a reusable package that create resources in
a declarative manner.
## Usage
```
influx pkg new [flags]
```
## Flags
| Flag | Description | Input Type |
|:----------------------|:--------------------------------------------------------------------------------|-----------------|
| `-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 `new` command | |
| `-n`, `--name` | Package name | string |
| `-q`, `--quiet` | Skip interactive mode | |
| `-v`, `--version` | Package version | string |
{{% influx-cli-global-flags %}}

16
content/v2.0/reference/cli/influx/pkg/summary.md
View File

@ -17,11 +17,15 @@ influx pkg summary [flags]
## Flags ## Flags
| Flag | Description | Input Type | | Flag | Description | Input Type |
|:---- |:----------- |:---------- | |:---- |:----------- |:---------- |
| `-c`, `--color` | Enable color in output _(default is true) _ | | | `-c`, `--disable-color` | Disable color in output | |
| `-f`, `--file` | Package file to summarize | string | | `--disable-table-borders` | Disable table borders | |
| `-h`, `--help` | Help for the `summary` command | | | `-e`, `--encoding` | Encoding of the input stream | string |
| `--table-borders` | Enable table borders _(default is true)_ | | | `-f`, `--file` | Package file to summarize | string |
| `-h`, `--help` | Help for the `summary` command | |
| `-R`, `--recurse` | Recurse through files in the directory specified in `-f`, `--file` | |
| `-u`, `--url` | URL of package file to summarize | string |
{{% influx-cli-global-flags %}} {{% influx-cli-global-flags %}}

11
content/v2.0/reference/cli/influx/pkg/validate.md
View File

@ -17,9 +17,12 @@ influx pkg validate [flags]
## Flags ## Flags
| Flag | Description | Input Type | | Flag | Description | Input Type |
|:---- |:----------- |:---------- | |:---- |:----------- |:---------- |
| `-f`, `--file` | Package file to validate | string | | `-e`, `--encoding` | Encoding of the input stream | string |
| `-h`, `--help` | Help for the `validate` command | | | `-f`, `--file` | Package file to validate | string |
| `-h`, `--help` | Help for the `validate` command | |
| `-R`, `--recurse` | Recurse through files in the directory specified in `-f`, `--file` | |
| `-u`, `--url` | URL of package file to validate | string |
{{% influx-cli-global-flags %}} {{% influx-cli-global-flags %}}

32
content/v2.0/reference/cli/influx/secret/_index.md Normal file
View File

@ -0,0 +1,32 @@
---
title: influx secret – Manage secrets
description: The 'influx secret' command manages secrets.
menu:
v2_0_ref:
name: influx secret
parent: influx
weight: 101
v2.0/tags: [secrets]
---
The `influx secret` command manages secrets.
## Usage
```
influx secret [flags]
influx secret [subcommand]
```
## Subcommands
| Subcommand | Description |
|:---------- |:----------- |
| [delete](/v2.0/reference/cli/influx/secret/delete/) | Delete a secret |
| [find](/v2.0/reference/cli/influx/secret/find/) | Find secrets |
| [update](/v2.0/reference/cli/influx/secret/update/) | Add or update a secret |
## Flags
| Flag | Description |
|:---- |:----------- |
| `-h`, `--help` | Help for the `secret` command |
{{% influx-cli-global-flags %}}

27
content/v2.0/reference/cli/influx/secret/delete.md Normal file
View File

@ -0,0 +1,27 @@
---
title: influx secret delete
description: The 'influx secret delete' command deletes secrets.
menu:
v2_0_ref:
name: influx secret delete
parent: influx secret
weight: 101
v2.0/tags: [secrets]
---
The `influx secret delete` command deletes secrets.
## Usage
```
influx secret delete [flags]
```
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------:|
| `-h`, `--help` | Help for `secret delete` | |
| `-k`, `--key` | Secret key _**(required)**_ | string |
| `-o`, `--org` | Organization name | string |
| `--org-id` | Organization ID | string |
{{% influx-cli-global-flags %}}

26
content/v2.0/reference/cli/influx/secret/find.md Normal file
View File

@ -0,0 +1,26 @@
---
title: influx secret find
description: The 'influx secret find' command lists secret keys.
menu:
v2_0_ref:
name: influx secret find
parent: influx secret
weight: 101
v2.0/tags: [secrets]
---
The `influx secret find` command lists secret keys.
## Usage
```
influx secret find [flags]
```
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------:|
| `-h`, `--help` | Help for `secret find` | |
| `-o`, `--org` | Organization name | string |
| `--org-id` | Organization ID | string |
{{% influx-cli-global-flags %}}

29
content/v2.0/reference/cli/influx/secret/update.md Normal file
View File

@ -0,0 +1,29 @@
---
title: influx secret update
description: The 'influx secret update' command adds and updates secrets.
menu:
v2_0_ref:
name: influx secret update
parent: influx secret
weight: 101
v2.0/tags: [secrets]
---
The `influx secret update` command adds and updates secrets.
Provide the secret key with the `-k` or `--key` flag.
When prompted, enter and confirm the secret value.
## Usage
```
influx secret update [flags]
```
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------:|
| `-h`, `--help` | Help for `secret update` | |
| `-k`, `--key` | Secret key _**(required)**_ | string |
| `-o`, `--org` | Organization name | string |
| `--org-id` | Organization ID | string |
{{% influx-cli-global-flags %}}

14
content/v2.0/reference/release-notes/influxdb.md
View File

@ -8,6 +8,20 @@ menu:
weight: 101 weight: 101
--- ---
## v2.0.0-beta.3 [2020-02-11]
### Features
- Extend `influx cli pkg command` with ability to take multiple files and directories.
- Extend `influx cli pkg command` with ability to take multiple URLs, files,
directories, and stdin at the same time.
- `influx` CLI can manage secrets.
### Bug Fixes
- Fix notification rule renaming panics in UI.
- Fix the tooltip for stacked line graphs.
- Fixed false success notification for read-only users creating dashboards.
- Fix issue with pkger/http stack crashing on duplicate content type.
## v2.0.0-beta.2 [2020-01-24] ## v2.0.0-beta.2 [2020-01-24]
### Features ### Features

69
content/v2.0/security/secrets/manage-secrets.md
View File

@ -1,69 +0,0 @@
---
title: Manage secrets
description: Manage secrets in InfluxDB with the InfluxDB API.
v2.0/tags: [secrets, security]
menu:
v2_0:
parent: Store and use secrets
weight: 201
---
Manage secrets using the InfluxDB `/org/{orgID}/secrets` API endpoint.
All secrets belong to an organization and are stored in your [secret-store](/v2.0/security/secrets/).
Include your [organization ID](/v2.0/organizations/view-orgs/#view-your-organization-id)
and [authentication token](/v2.0/security/tokens/view-tokens/) with each request.
### Add a secret
Use the `PATCH` request method to add a new secret to your organization.
Pass the secret key-value pair in the request body.
```sh
curl -XPATCH http://localhost:9999/api/v2/orgs/<org-id>/secrets \
-H 'authorization: Token YOURAUTHTOKEN' \
-H 'Content-type: application/json' \
--data '{
"<secret-key>": "<secret-value>"
}'
```
### View secret keys
Use the `GET` request method to view your organization's secrets keys.
```sh
curl -XGET http://localhost:9999/api/v2/orgs/<org-id>/secrets \
-H 'authorization: Token YOURAUTHTOKEN'
```
### Delete a secret
Use the `POST` request method and the `orgs/{orgID}/secrets/delete` API endpoint
to delete one or more secrets.
Include an array of secret keys to delete in the requests body in the following format.
```bash
curl -XGET http://localhost:9999/api/v2/orgs/<org-id>/secrets/delete \
--H 'authorization: Token YOURAUTHTOKEN'
--data '{
"secrets": [
"<secret-key>"
]
}'
```
## Use secrets in a query
Import the `influxdata/influxd/secrets` package and use the `secrets.get()` function
to populate sensitive data in queries with secrets from your secret store.
```js
import "influxdata/influxdb/secrets"
import "sql"
username = secrets.get(key: "POSTGRES_USERNAME")
password = secrets.get(key: "POSTGRES_PASSWORD")
sql.from(
driverName: "postgres",
dataSourceName: "postgresql://${username}:${password}@localhost",
query:"SELECT * FROM example-table"
)
```

34
content/v2.0/security/secrets/manage-secrets/_index.md Normal file
View File

@ -0,0 +1,34 @@
---
title: Manage secrets
description: Manage secrets in InfluxDB with the InfluxDB API.
v2.0/tags: [secrets, security]
menu:
v2_0:
parent: Store and use secrets
weight: 201
---
Manage secrets using the [`influx` command line interface (CLI)](/v2.0/reference/cli/influx/) or the InfluxDB API.
All secrets belong to an organization and are stored in your [secret-store](/v2.0/security/secrets/).
{{< children >}}
---
## Use secrets in a query
Import the `influxdata/influxd/secrets` package and use the `secrets.get()` function
to populate sensitive data in queries with secrets from your secret store.
```js
import "influxdata/influxdb/secrets"
import "sql"
username = secrets.get(key: "POSTGRES_USERNAME")
password = secrets.get(key: "POSTGRES_PASSWORD")
sql.from(
driverName: "postgres",
dataSourceName: "postgresql://${username}:${password}@localhost",
query:"SELECT * FROM example-table"
)
```

45
content/v2.0/security/secrets/manage-secrets/add.md Normal file
View File

@ -0,0 +1,45 @@
---
title: Add secrets
description: Add secrets using the `influx` CLI or the InfluxDB API.
v2.0/tags: [secrets, security]
menu:
v2_0:
parent: Manage secrets
weight: 301
---
Add secrets using the `influx` command line interface (CLI) or the InfluxDB API.
## Add a secret using the influx CLI
Use the [`influx secret update` command](/v2.0/reference/cli/influx/secret/update/)
to add a new secret to your organization.
Provide the secret key with the `-k` or `--key` flag.
When prompted, enter and confirm the secret value.
```sh
# Syntax
influx secret update -k <secret-key>
# Example
influx secret update -k foo
```
## Add a secret using the InfluxDB API
Use the `PATCH` request method and the `/orgs/{orgID}/secrets` API endpoint to
add a new secret to your organization.
**Include the following:**
- Your [organization ID](/v2.0/organizations/view-orgs/#view-your-organization-id) in the request URL
- Your [authentication token](/v2.0/security/tokens/view-tokens/) in the `Authorization` header
- The secret key-value pair in the request body
<!-- -->
```sh
curl -XPATCH http://localhost:9999/api/v2/orgs/<org-id>/secrets \
-H 'Authorization: Token YOURAUTHTOKEN' \
-H 'Content-type: application/json' \
--data '{
"<secret-key>": "<secret-value>"
}'
```

45
content/v2.0/security/secrets/manage-secrets/delete.md Normal file
View File

@ -0,0 +1,45 @@
---
title: Delete secrets
description: Delete secrets using the `influx` CLI or the InfluxDB API.
v2.0/tags: [secrets, security]
menu:
v2_0:
parent: Manage secrets
weight: 304
---
Delete secrets using the `influx` command line interface (CLI) or the InfluxDB API.
## Delete a secret using the influx CLI
Use the [`influx secret delete` command](/v2.0/reference/influx/secret/delete/)
to delete a secret key-value pair from your organization.
Provide the secret key to delete with the `-k` or `--key` flag.
```sh
# Syntax
influx secret delete -k <secret-key>
# Example
influx secret delete -k foo
```
## Delete secrets using the InfluxDB API
Use the `POST` request method and the `orgs/{orgID}/secrets/delete` API endpoint
to delete one or more secrets.
**Include the following:**
- Your [organization ID](/v2.0/organizations/view-orgs/#view-your-organization-id) in the request URL
- Your [authentication token](/v2.0/security/tokens/view-tokens/) in the `Authorization` header
- An array of secret keys to delete in the request body
<!-- -->
```bash
curl -XGET http://localhost:9999/api/v2/orgs/<org-id>/secrets/delete \
--H 'Authorization: Token YOURAUTHTOKEN'
--data '{
"secrets": [
"<secret-key>"
]
}'
```

45
content/v2.0/security/secrets/manage-secrets/update.md Normal file
View File

@ -0,0 +1,45 @@
---
title: Update secrets
description: Update secrets using the `influx` CLI or the InfluxDB API.
v2.0/tags: [secrets, security]
menu:
v2_0:
parent: Manage secrets
weight: 303
---
Update secrets using the `influx` command line interface (CLI) or the InfluxDB API.
## Update a secret using the influx CLI
Use the [`influx secret update` command](/v2.0/reference/cli/influx/secret/update/)
to update a secret in your organization.
Provide the secret key to update with the `-k` or `--key` flag.
When prompted, enter and confirm the secret value.
```sh
# Syntax
influx secret update -k <secret-key>
# Example
influx secret update -k foo
```
## Update a secret using the InfluxDB API
Use the `PATCH` request method and the InfluxDB `/orgs/{orgID}/secrets` API endpoint
to update a secret in your organization.
**Include the following:**
- Your [organization ID](/v2.0/organizations/view-orgs/#view-your-organization-id) in the request URL
- Your [authentication token](/v2.0/security/tokens/view-tokens/) in the `Authorization` header
- The updated secret key-value pair in the request body
<!-- -->
```sh
curl -XPATCH http://localhost:9999/api/v2/orgs/<org-id>/secrets \
-H 'Authorization: Token YOURAUTHTOKEN' \
-H 'Content-type: application/json' \
--data '{
"<secret-key>": "<secret-value>"
}'
```

34
content/v2.0/security/secrets/manage-secrets/view.md Normal file
View File

@ -0,0 +1,34 @@
---
title: View secret keys
description: View secret keys using the `influx` CLI or the InfluxDB API.
v2.0/tags: [secrets, security]
menu:
v2_0:
parent: Manage secrets
weight: 302
---
View secret keys using the `influx` command line interface (CLI) or the InfluxDB API.
## View secret keys using the influx CLI
Use the [`influx secret find` command](/v2.0/reference/cli/influx/secret/find/)
to list your organization's secret keys.
```sh
influx secret find
```
## View secret keys using the InfluxDB API
Use the `GET` request method and the InfluxDB `/orgs/{orgID}/secrets` API endpoint
to view your organization's secrets keys.
**Include the following:**
- Your [organization ID](/v2.0/organizations/view-orgs/#view-your-organization-id) in the request URL
- Your [authentication token](/v2.0/security/tokens/view-tokens/) in the `Authorization` header
<!-- -->
```sh
curl -XGET http://localhost:9999/api/v2/orgs/<org-id>/secrets \
-H 'Authorization: Token YOURAUTHTOKEN'
```

14
content/v2.0/visualize-data/explore-metrics.md
View File

@ -30,13 +30,17 @@ See [Get started with Flux](/v2.0/query-data/get-started) to learn more about Fl
{{< nav-icon "data-explorer" >}} {{< nav-icon "data-explorer" >}}
2. Use the Flux builder in the bottom panel to select a bucket and filters such as measurement, field or tag. 2. Use the Flux builder in the bottom panel to create a Flux query:
Alternatively, click **Script Editor** to manually edit the query. - Select a bucket to define your data source.
- Edit your time range with the [time range option](/select-time-range/) in the dropdown menu.
- Add filters to narrow your data by selecting attributes or columns in the dropdown menu.
- Select **Group** from the **Filter** dropdown menu to group data into tables. For more about how grouping data in Flux works, see [Group data](/v2.0/query-data/guides/group-data/).
3. Alternatively, click **Script Editor** to manually edit the query.
To switch back to the query builder, click **Query Builder**. Note that your updates from the Script Editor will not be saved. To switch back to the query builder, click **Query Builder**. Note that your updates from the Script Editor will not be saved.
3. Use the **Functions** list to review the available Flux functions. 4. Use the **Functions** list to review the available Flux functions.
Click on a function from the list to add it to your query. Click on a function from the list to add it to your query.
4. Click **Submit** (or press `Control+Enter`) to run your query. You can then preview your graph in the above pane. 5. Click **Submit** (or press `Control+Enter`) to run your query. You can then preview your graph in the above pane.
5. To work on multiple queries at once, click the {{< icon "plus" >}} to add another tab. 6. To work on multiple queries at once, click the {{< icon "plus" >}} to add another tab.
* Click the eye icon on a tab to hide or show a query's visualization. * Click the eye icon on a tab to hide or show a query's visualization.
* Click on the name of the query in the tab to rename it. * Click on the name of the query in the tab to rename it.