Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Update information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, `port`, `private_network` and `public_network` specifications are returned in the response.

USAGE:
scw redis endpoint update [arg=value ...]

ARGS:
endpoint-id
[private-network.id] UUID of the Private Network to connect to the Database Instance
[private-network.service-ips.{index}] Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node.
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)

FLAGS:
-h, --help help for update

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
-p, --profile string The config profile to use
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ AVAILABLE COMMANDS:
delete Delete an endpoint for a cluster
get Get an endpoint
set Set endpoints for a cluster
update Update an endpoint

FLAGS:
-h, --help help for endpoint
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create a Secret containing no versions.
You must sepcify the `region` to create a secret.

USAGE:
scw secret secret create [arg=value ...]

EXAMPLES:
Add a given Secret
scw secret secret create project-id=<your-project-id> name="foobar" description="bar"
Add a given secret
scw secret secret create name=foobar description="$(cat <path/to/your/secret>)"

ARGS:
[project-id] Project ID to use. If none is passed the default project ID will be used
[name] Name of the Secret
[tags.{index}] List of tags associated to this Secret
[description] Description of the Secret
[name] Name of the secret
[tags.{index}] List of the secret's tags
[description] Description of the secret
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete a Secret.
Delete a given secret specified by the `region` and `secret_id` parameters.

USAGE:
scw secret secret delete [arg=value ...]

EXAMPLES:
Delete a given Secret
Delete a given secret
scw secret secret delete secret-id=11111111-1111-1111-1111-111111111111

ARGS:
secret-id ID of the Secret
secret-id ID of the secret
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Get metadata of a Secret.
Retrieve the metadata of a secret specified by the `region` and the `secret_name` parameters.

USAGE:
scw secret secret get [arg=value ...]

ARGS:
secret-id ID of the Secret
secret-id ID of the secret
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List Secrets.
Retrieve the list of secrets created within an Organization and/or Project. You must specify either the `organization_id` or the `project_id` and the `region`.

USAGE:
scw secret secret list [arg=value ...]

ARGS:
[project-id] ID of a project to filter on (optional)
[name] Secret name to filter on (optional)
[project-id] Filter by Project ID (optional)
[name] Filter by secret name (optional)
[tags.{index}] List of tags to filter on (optional)
[order-by] (name_asc | name_desc | created_at_asc | created_at_desc | updated_at_asc | updated_at_desc)
[organization-id] ID of an organization to filter on (optional)
[organization-id] Filter by Organization ID (optional)
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Update metadata of a Secret.
Edit a secret's metadata such as name, tag(s) and description. The secret to update is specified by the `secret_id` and `region` parameters.

USAGE:
scw secret secret update [arg=value ...]

ARGS:
secret-id ID of the Secret
[name] New name of the Secret (optional)
[tags.{index}] New list of tags associated to this Secret (optional)
[description] Description of the Secret
secret-id ID of the secret
[name] Secret's updated name (optional)
[tags.{index}] Secret's updated list of tags (optional)
[description] Description of the secret
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
12 changes: 6 additions & 6 deletions cmd/scw/testdata/test-all-usage-secret-secret-usage.golden
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Logical container made up of zero or more immutable versions, that hold the sensitive data.
Secrets are logical containers made up of zero or more immutable versions, that contain sensitive data.

USAGE:
scw secret secret <command>

AVAILABLE COMMANDS:
create Create a Secret containing no versions
delete Delete a Secret
get Get metadata of a Secret
list List Secrets
update Update metadata of a Secret
create Create a secret
delete Delete a secret
get Get metadata using the secret's name
list List secrets
update Update metadata of a secret

FLAGS:
-h, --help help for secret
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-secret-usage.golden
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Secret API (beta).
Secret Manager API documentation.

USAGE:
scw secret <command>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Access a SecretVersion, returning the sensitive data.
Access sensitive data in a secret's version specified by the `region`, `secret_id` and `revision` parameters.

USAGE:
scw secret version access [arg=value ...]

ARGS:
secret-id ID of the Secret
revision Revision of the SecretVersion (may be a number or "latest")
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"
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create a SecretVersion.
Create a version of a given secret specified by the `region` and `secret_id` parameters.

USAGE:
scw secret version create [arg=value ...]

EXAMPLES:
Add a given Secret Version
scw secret version create name=foobar secret-id="<secret-id>" data=@<path/to/your/secret/file>

ARGS:
secret-id ID of the Secret
secret-id ID of the secret
data Content of the secret version. Base64 is handled by the SDK (Support file loading with @/path/to/file)
[description] Description of the SecretVersion
[description] Description of the version
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Destroy a SecretVersion, permanently destroying the sensitive data.
Delete a secret's version and the sensitive data contained in it. Deleting a version is permanent and cannot be undone.

USAGE:
scw secret version delete [arg=value ...]

EXAMPLES:
Delete a given SecretVersion
Delete a given Secret Version
scw secret version delete secret-id=11111111-1111-1111-1111-111111111111 revision=1

ARGS:
secret-id ID of the Secret
revision Revision of the SecretVersion (may be a number or "latest")
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"
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Disable a SecretVersion.
Make a specific version inaccessible. You must specify the `region`, `secret_id` and `revision` parameters.

USAGE:
scw secret version disable [arg=value ...]

ARGS:
secret-id ID of the Secret
revision Revision of the SecretVersion (may be a number or "latest")
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"
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Enable a SecretVersion.
Make a specific version accessible. You must specify the `region`, `secret_id` and `revision` parameters.

USAGE:
scw secret version enable [arg=value ...]

ARGS:
secret-id ID of the Secret
revision Revision of the SecretVersion (may be a number or "latest")
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"
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Get metadata of a SecretVersion.
Retrieve the metadata of a secret's given version specified by the `region`, `secret_id` and `revision` parameters.

USAGE:
scw secret version get [arg=value ...]

ARGS:
secret-id ID of the Secret
revision Revision of the SecretVersion (may be a number or "latest")
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"
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List versions of a Secret, not returning any sensitive data.
Retrieve the list of a given secret's versions specified by the `secret_id` and `region` parameters.

USAGE:
scw secret version list [arg=value ...]

ARGS:
secret-id ID of the Secret
secret-id ID of the secret
[status.{index}] Filter results by status (unknown | enabled | disabled | destroyed)
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Update metadata of a SecretVersion.
Edit the metadata of a secret's given version, specified by the `region`, `secret_id` and `revision` parameters.

USAGE:
scw secret version update [arg=value ...]

ARGS:
secret-id ID of the Secret
revision Revision of the SecretVersion (may be a number or "latest")
[description] Description of the SecretVersion
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"
[description] Description of the version
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
18 changes: 9 additions & 9 deletions cmd/scw/testdata/test-all-usage-secret-version-usage.golden
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Immutable version of a Secret.
Versions store the sensitive data contained in your secrets (API keys, passwords, or certificates).

USAGE:
scw secret version <command>

AVAILABLE COMMANDS:
access Access a SecretVersion, returning the sensitive data
create Create a SecretVersion
delete Destroy a SecretVersion, permanently destroying the sensitive data
disable Disable a SecretVersion
enable Enable a SecretVersion
get Get metadata of a SecretVersion
list List versions of a Secret, not returning any sensitive data
update Update metadata of a SecretVersion
access Access a secret's version using the secret's ID
create Create a version
delete Delete a version
disable Disable a version
enable Enable a version
get Get metadata of a secret's version using the secret's ID
list List versions of a secret using the secret's ID
update Update metadata of a version

FLAGS:
-h, --help help for version
Expand Down
23 changes: 23 additions & 0 deletions docs/commands/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Managed Database for Redis™ API.
- [Delete an endpoint for a cluster](#delete-an-endpoint-for-a-cluster)
- [Get an endpoint](#get-an-endpoint)
- [Set endpoints for a cluster](#set-endpoints-for-a-cluster)
- [Update an endpoint](#update-an-endpoint)
- [Node Types management commands](#node-types-management-commands)
- [List available node types](#list-available-node-types)
- [Settings management commands](#settings-management-commands)
Expand Down Expand Up @@ -427,6 +428,28 @@ scw redis endpoint set [arg=value ...]



### Update an endpoint

Update information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, `port`, `private_network` and `public_network` specifications are returned in the response.

**Usage:**

```
scw redis endpoint update [arg=value ...]
```


**Args:**

| Name | | Description |
|------|---|-------------|
| endpoint-id | Required | |
| private-network.id | | UUID of the Private Network to connect to the Database Instance |
| private-network.service-ips.{index} | | Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node. |
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config |



## Node Types management commands

Nodes are the compute units that make up your Redis™ Database Instance. Different node types are available with varying amounts of RAM and vCPU.
Expand Down
Loading