Document `influx v1 auth` subcommands #1768

pierwill · 2020-11-05T19:09:34Z

Closes #1736.

Tests pass (no build errors)
Rebased/mergeable

kelseiv

If we haven't already, let's look at adding some task-based doc for these commands.

content/influxdb/v2.0/reference/cli/influx/v1/_index.md

content/influxdb/v2.0/reference/cli/influx/v1/auth/active.md

content/influxdb/v2.0/reference/cli/influx/v1/auth/create.md

pierwill · 2020-11-09T17:42:33Z

Changes forthcoming in influxdata/influxdb#19935.

content/influxdb/v2.0/reference/cli/influx/v1/_index.md

russorat

LGTM

stuartcarnie

This look great – I suggested a couple of minor edits

content/influxdb/v2.0/reference/cli/influx/v1/auth/create.md

content/influxdb/v2.0/reference/cli/influx/v1/auth/_index.md

kelseiv · 2020-11-10T00:14:50Z

content/influxdb/v2.0/reference/cli/influx/v1/auth/create.md

+| `-o` | `--org`           | The name of the organization                                                                         | string      | `$INFLUX_ORG`           |
+|      | `--org-id`        | The ID of the organization                                                                           | string      | `$INFLUX_ORG_ID`        |


are one or both of these required?

kelseiv · 2020-11-10T00:16:40Z

content/influxdb/v2.0/reference/cli/influx/v1/auth/create.md

+|      | `--org-id`        | The ID of the organization                                                                           | string      | `$INFLUX_ORG_ID`        |
+|      | `--read-bucket`   | The bucket ID                                                                                        | stringArray |                         |
+|      | `--skip-verify`   | Skip TLS certificate chain and host name verification                                                |             |                         |
+| `-t` | `--token`         | Authentication token                                                                                 | string      | `$INFLUX_TOKEN`         |


Is token "required"? Let's note if flags are required throughout

Thanks, @kelseiv. None of the --help outputs for these commands notes any required flags, far as I can tell. I'll looking into the code to see if I can make any headway here.

kelseiv · 2020-11-10T00:21:19Z

content/influxdb/v2.0/reference/cli/influx/v1/auth/delete.md

+| `-h` | `--help`          | Help for the `delete` command                                           |            |                         |
+|      | `--hide-headers`  | Hide the table headers (defaults `false`)                               |            | `$INFLUX_HIDE_HEADERS`  |
+|      | `--host`          | HTTP address of InfluxDB                                                | string     | `$INFLUX_HOST`          |
+| `-i` | `--id`            | The authorization ID (required)                                         | string     |                         |


Is the authorization ID different than the token referred to in influx auth create (...didn't see an auth ID over there)? If not the token, how can folks find this ID?

Yes, the auth ID is the "parent" of a token. An authorization has a set of data associated with it (name, description, token). The reason the influx auth create command doesn't have an --id flag is because the auth doesn't exist yet and InfluxDB assigns the ID upon creation.

kelseiv · 2020-11-10T00:22:29Z

content/influxdb/v2.0/reference/cli/influx/v1/auth/create.md

+influxdb/v2.0/tags: [authorization]
+---
+
+The `influx v1 auth create` command creates a legacy authorization with the [InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/).


Can you create an "all access" token with this command? If yes, which flags need to be set for that?

kelseiv · 2020-11-10T00:29:55Z

content/influxdb/v2.0/reference/cli/influx/v1/auth/delete.md

+## Flags
+| Flag |                   | Description                                                             | Input type | {{< cli/mapped >}}      |
+|:-----|:------------------|:------------------------------------------------------------------------|:----------:|:------------------------|
+| `-c` | `--active-config` | Config name to use for command                                          | string     | `$INFLUX_ACTIVE_CONFIG` |


Does this delete the active config profile?

No, this flag is a way to override which influx config to use with this specific command. The command will delete an authorization token.

kelseiv · 2020-11-10T00:32:39Z

content/influxdb/v2.0/reference/cli/influx/v1/auth/list.md

+## Flags
+| Flag |                   | Description                                                             | Input type | {{< cli/mapped >}}      |
+|:-----|:------------------|:------------------------------------------------------------------------|:----------:|:------------------------|
+| `-c` | `--active-config` | Config name to use for command                                          | string     | `$INFLUX_ACTIVE_CONFIG` |


Does this list all authorizations for the specified active configuration?

See comment above, which I believe applies here.

Adds the new `influx v1` command, and documents the following `v1 auth` commands: `create`, `delete`, `list`, `set-active`, `set-inactive`, and `set-password`.

pierwill · 2020-11-11T17:59:52Z

Closing. Will create a new PR with same content.

pierwill marked this pull request as draft November 5, 2020 19:09

pierwill changed the title ~~Document influx v1 subcommands~~ Document influx v1 auth subcommands Nov 6, 2020

pierwill force-pushed the v1-subcommands branch 2 times, most recently from 9779566 to 481c4ef Compare November 6, 2020 21:36

pierwill marked this pull request as ready for review November 6, 2020 21:36

pierwill requested a review from kelseiv November 6, 2020 21:37

kelseiv reviewed Nov 6, 2020

View reviewed changes

pierwill requested review from russorat and stuartcarnie November 6, 2020 22:14

pierwill force-pushed the v1-subcommands branch from 43e90f1 to 66d8aca Compare November 6, 2020 23:32

pierwill force-pushed the v1-subcommands branch from b842cdf to ad248e0 Compare November 9, 2020 19:41

pierwill linked an issue Nov 9, 2020 that may be closed by this pull request

Add new "influx v1" commands #1736

Closed

pierwill requested a review from kelseiv November 9, 2020 20:55

russorat reviewed Nov 9, 2020

View reviewed changes

content/influxdb/v2.0/reference/cli/influx/v1/_index.md Outdated Show resolved Hide resolved

russorat approved these changes Nov 9, 2020

View reviewed changes

stuartcarnie requested changes Nov 9, 2020

View reviewed changes

content/influxdb/v2.0/reference/cli/influx/v1/auth/create.md Outdated Show resolved Hide resolved

content/influxdb/v2.0/reference/cli/influx/v1/auth/create.md Outdated Show resolved Hide resolved

pierwill force-pushed the v1-subcommands branch from 98bd89b to 3d8e801 Compare November 9, 2020 23:46

pierwill commented Nov 9, 2020

View reviewed changes

content/influxdb/v2.0/reference/cli/influx/v1/auth/_index.md Outdated Show resolved Hide resolved

kelseiv reviewed Nov 10, 2020

View reviewed changes

Document influx v1 auth commands

8afa502

Adds the new `influx v1` command, and documents the following `v1 auth` commands: `create`, `delete`, `list`, `set-active`, `set-inactive`, and `set-password`.

pierwill force-pushed the v1-subcommands branch from 076e2b1 to 8afa502 Compare November 11, 2020 00:05

pierwill changed the base branch from separate-cloud to master November 11, 2020 17:50

pierwill changed the base branch from master to separate-cloud November 11, 2020 17:51

noramullen1 changed the base branch from separate-cloud to master November 11, 2020 17:55

noramullen1 changed the base branch from master to separate-cloud November 11, 2020 17:56

pierwill changed the base branch from separate-cloud to master November 11, 2020 17:57

pierwill changed the base branch from master to separate-cloud November 11, 2020 17:59

pierwill closed this Nov 11, 2020

pierwill mentioned this pull request Nov 11, 2020

Document v1 auth subcommands #1808

Merged

2 tasks

pierwill deleted the v1-subcommands branch November 11, 2020 22:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document `influx v1 auth` subcommands #1768

Document `influx v1 auth` subcommands #1768

pierwill commented Nov 5, 2020 •

edited

Loading

kelseiv left a comment

pierwill commented Nov 9, 2020

russorat left a comment

stuartcarnie left a comment

kelseiv Nov 10, 2020

kelseiv Nov 10, 2020

pierwill Nov 10, 2020

kelseiv Nov 10, 2020

sanderson Nov 10, 2020

kelseiv Nov 10, 2020

kelseiv Nov 10, 2020

sanderson Nov 10, 2020

kelseiv Nov 10, 2020

pierwill Nov 10, 2020

pierwill commented Nov 11, 2020

		\| `-o` \| `--org` \| The name of the organization \| string \| `$INFLUX_ORG` \|
		\| \| `--org-id` \| The ID of the organization \| string \| `$INFLUX_ORG_ID` \|

Document influx v1 auth subcommands #1768

Document influx v1 auth subcommands #1768

Conversation

pierwill commented Nov 5, 2020 • edited Loading

kelseiv left a comment

Choose a reason for hiding this comment

pierwill commented Nov 9, 2020

russorat left a comment

Choose a reason for hiding this comment

stuartcarnie left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pierwill commented Nov 11, 2020

Document `influx v1 auth` subcommands #1768

Document `influx v1 auth` subcommands #1768

pierwill commented Nov 5, 2020 •

edited

Loading