Skip to content

docs(secret-manager): update description #2997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 4, 2023
Merged

docs(secret-manager): update description #2997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-secret-version-access-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
secret-id ID of the secret
revision Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"
revision Version number
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-secret-version-delete-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ EXAMPLES:

ARGS:
secret-id ID of the secret
revision Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"
revision Version number
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-secret-version-disable-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
secret-id ID of the secret
revision Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"
revision Version number
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-secret-version-enable-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
secret-id ID of the secret
revision Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"
revision Version number
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-secret-version-get-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
secret-id ID of the secret
revision Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"
revision Version number
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-secret-version-update-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
secret-id ID of the secret
revision Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"
revision Version number
[description] Description of the version
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

Expand Down
14 changes: 6 additions & 8 deletions docs/commands/secret.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ Secret Manager API documentation.
Secrets are logical containers made up of zero or more immutable versions, that contain sensitive data.



### Create a secret

You must sepcify the `region` to create a secret.
Expand Down Expand Up @@ -160,7 +159,6 @@ scw secret secret update [arg=value ...]
Versions store the sensitive data contained in your secrets (API keys, passwords, or certificates).



### Access a secret's version using the secret's ID

Access sensitive data in a secret's version specified by the `region`, `secret_id` and `revision` parameters.
Expand All @@ -177,7 +175,7 @@ scw secret version access [arg=value ...]
| Name | | Description |
|------|---|-------------|
| secret-id | Required | ID of the secret |
| revision | Required | Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest" |
| revision | Required | Version number |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |


Expand Down Expand Up @@ -226,7 +224,7 @@ scw secret version delete [arg=value ...]
| Name | | Description |
|------|---|-------------|
| secret-id | Required | ID of the secret |
| revision | Required | Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest" |
| revision | Required | Version number |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |


Expand Down Expand Up @@ -257,7 +255,7 @@ scw secret version disable [arg=value ...]
| Name | | Description |
|------|---|-------------|
| secret-id | Required | ID of the secret |
| revision | Required | Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest" |
| revision | Required | Version number |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |


Expand All @@ -278,7 +276,7 @@ scw secret version enable [arg=value ...]
| Name | | Description |
|------|---|-------------|
| secret-id | Required | ID of the secret |
| revision | Required | Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest" |
| revision | Required | Version number |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |


Expand All @@ -299,7 +297,7 @@ scw secret version get [arg=value ...]
| Name | | Description |
|------|---|-------------|
| secret-id | Required | ID of the secret |
| revision | Required | Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest" |
| revision | Required | Version number |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |


Expand Down Expand Up @@ -341,7 +339,7 @@ scw secret version update [arg=value ...]
| Name | | Description |
|------|---|-------------|
| secret-id | Required | ID of the secret |
| revision | Required | Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest" |
| revision | Required | Version number |
| description | | Description of the version |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |

Expand Down
22 changes: 10 additions & 12 deletions internal/namespaces/secret/v1alpha1/secret_cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,17 @@ func secretRoot() *core.Command {

func secretSecret() *core.Command {
return &core.Command{
Short: `Secret management commands`,
Long: `Secrets are logical containers made up of zero or more immutable versions, that contain sensitive data.
`,
Short: `Secret management commands`,
Long: `Secrets are logical containers made up of zero or more immutable versions, that contain sensitive data.`,
Namespace: "secret",
Resource: "secret",
}
}

func secretVersion() *core.Command {
return &core.Command{
Short: `Secret Version management commands`,
Long: `Versions store the sensitive data contained in your secrets (API keys, passwords, or certificates).
`,
Short: `Secret Version management commands`,
Long: `Versions store the sensitive data contained in your secrets (API keys, passwords, or certificates).`,
Namespace: "secret",
Resource: "version",
}
Expand Down Expand Up @@ -411,7 +409,7 @@ func secretVersionGet() *core.Command {
},
{
Name: "revision",
Short: `Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"`,
Short: `Version number`,
Required: true,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -448,7 +446,7 @@ func secretVersionUpdate() *core.Command {
},
{
Name: "revision",
Short: `Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"`,
Short: `Version number`,
Required: true,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -539,7 +537,7 @@ func secretVersionDelete() *core.Command {
},
{
Name: "revision",
Short: `Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"`,
Short: `Version number`,
Required: true,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -582,7 +580,7 @@ func secretVersionEnable() *core.Command {
},
{
Name: "revision",
Short: `Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"`,
Short: `Version number`,
Required: true,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -619,7 +617,7 @@ func secretVersionDisable() *core.Command {
},
{
Name: "revision",
Short: `Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"`,
Short: `Version number`,
Required: true,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -656,7 +654,7 @@ func secretVersionAccess() *core.Command {
},
{
Name: "revision",
Short: `Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"`,
Short: `Version number`,
Required: true,
Deprecated: false,
Positional: false,
Expand Down