Skip to content

Commit

Permalink
feat: update generated cli
Browse files Browse the repository at this point in the history
  • Loading branch information
scaleway-bot committed Jun 22, 2022
1 parent 691bf24 commit 92e0121
Show file tree
Hide file tree
Showing 30 changed files with 1,761 additions and 80 deletions.
15 changes: 15 additions & 0 deletions cmd/scw/testdata/test-all-usage-rdb-read-replica-usage.golden
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
A read replica is a live copy of the main database instance only available for reading. Read replica allows you to scale your database instance for read-heavy database workloads. Read replicas can also be used for Business Intelligence workloads.

USAGE:
scw rdb read-replica

FLAGS:
-h, --help help for read-replica

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
21 changes: 11 additions & 10 deletions cmd/scw/testdata/test-all-usage-rdb-usage.golden
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,17 @@ USAGE:
scw rdb <command>

AVAILABLE COMMANDS:
acl Access Control List (ACL) management commands
backup Backup management commands
database Database management commands
engine Database engines commands
instance Instance management commands
log Instance logs management commands
node-type Node types management commands
privilege User privileges management commands
snapshot Block snapshot management
user User management commands
acl Access Control List (ACL) management commands
backup Backup management commands
database Database management commands
engine Database engines commands
instance Instance management commands
log Instance logs management commands
node-type Node types management commands
privilege User privileges management commands
read-replica Read replica management
snapshot Block snapshot management
user User management commands

FLAGS:
-h, --help help for rdb
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-redis-acl-add-usage.golden
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ARGS:
cluster-id UUID of the cluster you want to add acl rules to
[acl-rules.{index}.ip] IPv4 network address of the rule
[acl-rules.{index}.description] Description of the rule
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for add
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
acl-id UUID of the acl rule you want to delete
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for delete
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-redis-acl-get-usage.golden
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
acl-id UUID of the acl rule you want to get
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for get
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-redis-acl-set-usage.golden
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ARGS:
cluster-id UUID of the cluster where the ACL rules has to be set
[acl-rules.{index}.ip] IPv4 network address of the rule
[acl-rules.{index}.description] Description of the rule
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for set
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ ARGS:
[tls-enabled] Whether or not TLS is enabled
[cluster-settings.{index}.value] Value of the setting
[cluster-settings.{index}.name] Name of the setting
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
cluster-id UUID of the cluster to delete
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for delete
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
cluster-id UUID of the cluster
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for get-certificate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
cluster-id UUID of the cluster
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for get
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ARGS:
[name] Name of the clusters to filter upon
[order-by] Criteria to use when ordering cluster listing (created_at_asc | created_at_desc | name_asc | name_desc)
[project-id] Project ID to list the cluster of
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for list
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ARGS:
[start-date] Start date to gather metrics from
[end-date] End date to gather metrics from
[metric-name] Name of the metric to gather
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for metrics
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ARGS:
[node-type] Type of node to use for the cluster
[cluster-size] Number of nodes for the cluster
cluster-id UUID of the cluster to update
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for migrate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
cluster-id UUID of the cluster
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for renew-certificate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ARGS:
[user-name] Name of the cluster user
[password] Password of the cluster user
cluster-id UUID of the cluster to update
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for update
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ARGS:
cluster-id UUID of the cluster you want to add endpoints to
[endpoints.{index}.private-network.id] UUID of the private network to be connected to the cluster
[endpoints.{index}.private-network.service-ips.{index}] Endpoint IPv4 adress with a CIDR notation. You must provide at least one IPv4 per node. Check documentation about IP and subnet limitation.
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for add
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
endpoint-id
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for delete
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
endpoint-id
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for get
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ARGS:
cluster-id UUID of the cluster where the endpoints has to be set
[endpoints.{index}.private-network.id] UUID of the private network to be connected to the cluster
[endpoints.{index}.private-network.service-ips.{index}] Endpoint IPv4 adress with a CIDR notation. You must provide at least one IPv4 per node. Check documentation about IP and subnet limitation.
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for set
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
[include-disabled-types] Whether or not to include disabled types
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for list
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ARGS:
cluster-id UUID of the cluster you want to add settings to
[settings.{index}.value] Value of the setting
[settings.{index}.name] Name of the setting
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for add
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ USAGE:
ARGS:
cluster-id UUID of the cluster where the settings has to be set
[settings-name] Setting name to delete
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for delete
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ARGS:
cluster-id UUID of the cluster where the settings has to be set
[settings.{index}.value] Value of the setting
[settings.{index}.name] Name of the setting
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for set
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ARGS:
[include-beta] Whether or not to include beta Redis versions
[include-deprecated] Whether or not to include deprecated Redis versions
[version-name] List Redis versions that match a given name pattern
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2)
[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)

FLAGS:
-h, --help help for list
Expand Down
17 changes: 17 additions & 0 deletions docs/commands/rdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ Database RDB API
- [User privileges management commands](#user-privileges-management-commands)
- [List privileges of a given user for a given database on a given instance](#list-privileges-of-a-given-user-for-a-given-database-on-a-given-instance)
- [Set privileges of a given user for a given database on a given instance](#set-privileges-of-a-given-user-for-a-given-database-on-a-given-instance)
- [Read replica management](#read-replica-management)
- [Block snapshot management](#block-snapshot-management)
- [Create an instance snapshot](#create-an-instance-snapshot)
- [Delete an instance snapshot](#delete-an-instance-snapshot)
Expand Down Expand Up @@ -924,6 +925,22 @@ scw rdb privilege set [arg=value ...]



## Read replica management

A read replica is a live copy of the main database instance only available for reading. Read replica allows you to scale your database instance for read-heavy database workloads. Read replicas can also be used for Business Intelligence workloads.


A read replica is a live copy of the main database instance only available for reading. Read replica allows you to scale your database instance for read-heavy database workloads. Read replicas can also be used for Business Intelligence workloads.


**Usage:**

```
scw rdb read-replica
```



## Block snapshot management

Create, restore and manage block snapshot
Expand Down
Loading

0 comments on commit 92e0121

Please sign in to comment.