Skip to content

Commit 31a3494

Browse files
committed
Fix
1 parent 2b48f7b commit 31a3494

11 files changed

+153
-1206
lines changed

cmd/scw/testdata/test-all-usage-rdb-acl-add-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Add an ACL instance to a given instance.
3+
Add an additional ACL rule to a database instance.
44

55
USAGE:
66
scw rdb acl add [arg=value ...]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Renew the TLS certificate of an instance.
4+
5+
USAGE:
6+
scw rdb instance renew-certificate <instance-id ...> [arg=value ...]
7+
8+
ARGS:
9+
instance-id UUID of the instance you want logs of
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
11+
12+
FLAGS:
13+
-h, --help help for renew-certificate
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use

cmd/scw/testdata/test-all-usage-rdb-instance-update-usage.golden

+9-7
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ USAGE:
66
scw rdb instance update <instance-id ...> [arg=value ...]
77

88
ARGS:
9-
[backup-schedule-frequency] In hours
10-
[backup-schedule-retention] In days
11-
[is-backup-schedule-disabled] Whether or not the backup schedule is disabled
12-
[name] Name of the instance
13-
instance-id UUID of the instance to update
14-
[tags.{index}] Tags of a given instance
15-
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
9+
[backup-schedule-frequency] In hours
10+
[backup-schedule-retention] In days
11+
[is-backup-schedule-disabled] Whether or not the backup schedule is disabled
12+
[name] Name of the instance
13+
instance-id UUID of the instance to update
14+
[tags.{index}] Tags of a given instance
15+
[logs-policy.max-age-retention] Max age of remote logs to keep on the database instance
16+
[logs-policy.total-disk-retention] Max disk size of remote logs to keep on the database instance
17+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1618

1719
FLAGS:
1820
-h, --help help for update

cmd/scw/testdata/test-all-usage-rdb-instance-usage.golden

+11-10
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,17 @@ USAGE:
66
scw rdb instance <command>
77

88
AVAILABLE COMMANDS:
9-
clone Clone an instance
10-
connect Connect to an instance using locally installed CLI
11-
create Create an instance
12-
delete Delete an instance
13-
get Get an instance
14-
get-certificate Get the TLS certificate of an instance
15-
list List instances
16-
update Update an instance
17-
upgrade Upgrade an instance to an higher instance type
18-
wait Wait for an instance to reach a stable state
9+
clone Clone an instance
10+
connect Connect to an instance using locally installed CLI
11+
create Create an instance
12+
delete Delete an instance
13+
get Get an instance
14+
get-certificate Get the TLS certificate of an instance
15+
list List instances
16+
renew-certificate Renew the TLS certificate of an instance
17+
update Update an instance
18+
upgrade Upgrade an instance to an higher instance type
19+
wait Wait for an instance to reach a stable state
1920

2021
FLAGS:
2122
-h, --help help for instance
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
List remote instances logs details.
4+
5+
USAGE:
6+
scw rdb log list-details [arg=value ...]
7+
8+
ARGS:
9+
instance-id UUID of the instance you want logs of
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
11+
12+
FLAGS:
13+
-h, --help help for list-details
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Purge remote instances logs.
4+
5+
USAGE:
6+
scw rdb log purge [arg=value ...]
7+
8+
ARGS:
9+
instance-id UUID of the instance you want logs of
10+
[log-name] Specific log name to purge
11+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
12+
13+
FLAGS:
14+
-h, --help help for purge
15+
16+
GLOBAL FLAGS:
17+
-c, --config string The path to the config file
18+
-D, --debug Enable debug mode
19+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
20+
-p, --profile string The config profile to use

cmd/scw/testdata/test-all-usage-rdb-log-usage.golden

+5-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ USAGE:
66
scw rdb log <command>
77

88
AVAILABLE COMMANDS:
9-
get Get specific logs of a given instance
10-
list List available logs of a given instance
11-
prepare Prepare logs of a given instance
9+
get Get specific logs of a given instance
10+
list List available logs of a given instance
11+
list-details List remote instances logs details
12+
prepare Prepare logs of a given instance
13+
purge Purge remote instances logs
1214

1315
FLAGS:
1416
-h, --help help for log

docs/commands/rdb.md

+67-1
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,16 @@ Database RDB API
3030
- [Get an instance](#get-an-instance)
3131
- [Get the TLS certificate of an instance](#get-the-tls-certificate-of-an-instance)
3232
- [List instances](#list-instances)
33+
- [Renew the TLS certificate of an instance](#renew-the-tls-certificate-of-an-instance)
3334
- [Update an instance](#update-an-instance)
3435
- [Upgrade an instance to an higher instance type](#upgrade-an-instance-to-an-higher-instance-type)
3536
- [Wait for an instance to reach a stable state](#wait-for-an-instance-to-reach-a-stable-state)
3637
- [Instance logs management commands](#instance-logs-management-commands)
3738
- [Get specific logs of a given instance](#get-specific-logs-of-a-given-instance)
3839
- [List available logs of a given instance](#list-available-logs-of-a-given-instance)
40+
- [List remote instances logs details](#list-remote-instances-logs-details)
3941
- [Prepare logs of a given instance](#prepare-logs-of-a-given-instance)
42+
- [Purge remote instances logs](#purge-remote-instances-logs)
4043
- [Node types management commands](#node-types-management-commands)
4144
- [List available node types](#list-available-node-types)
4245
- [User privileges management commands](#user-privileges-management-commands)
@@ -64,7 +67,7 @@ Network Access Control List allows to control network in and out traffic by sett
6467

6568
### Add an ACL instance to a given instance
6669

67-
Add an ACL instance to a given instance.
70+
Add an additional ACL rule to a database instance.
6871

6972
**Usage:**
7073

@@ -610,6 +613,26 @@ scw rdb instance list [arg=value ...]
610613

611614

612615

616+
### Renew the TLS certificate of an instance
617+
618+
Renew the TLS certificate of an instance.
619+
620+
**Usage:**
621+
622+
```
623+
scw rdb instance renew-certificate <instance-id ...> [arg=value ...]
624+
```
625+
626+
627+
**Args:**
628+
629+
| Name | | Description |
630+
|------|---|-------------|
631+
| instance-id | Required | UUID of the instance you want logs of |
632+
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
633+
634+
635+
613636
### Update an instance
614637

615638
Update an instance.
@@ -631,6 +654,8 @@ scw rdb instance update <instance-id ...> [arg=value ...]
631654
| name | | Name of the instance |
632655
| instance-id | Required | UUID of the instance to update |
633656
| tags.{index} | | Tags of a given instance |
657+
| logs-policy.max-age-retention | | Max age of remote logs to keep on the database instance |
658+
| logs-policy.total-disk-retention | | Max disk size of remote logs to keep on the database instance |
634659
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
635660

636661

@@ -735,6 +760,26 @@ scw rdb log list [arg=value ...]
735760

736761

737762

763+
### List remote instances logs details
764+
765+
List remote instances logs details.
766+
767+
**Usage:**
768+
769+
```
770+
scw rdb log list-details [arg=value ...]
771+
```
772+
773+
774+
**Args:**
775+
776+
| Name | | Description |
777+
|------|---|-------------|
778+
| instance-id | Required | UUID of the instance you want logs of |
779+
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
780+
781+
782+
738783
### Prepare logs of a given instance
739784

740785
Prepare your instance logs. Logs will be grouped on a minimum interval of a day.
@@ -757,6 +802,27 @@ scw rdb log prepare [arg=value ...]
757802

758803

759804

805+
### Purge remote instances logs
806+
807+
Purge remote instances logs.
808+
809+
**Usage:**
810+
811+
```
812+
scw rdb log purge [arg=value ...]
813+
```
814+
815+
816+
**Args:**
817+
818+
| Name | | Description |
819+
|------|---|-------------|
820+
| instance-id | Required | UUID of the instance you want logs of |
821+
| log-name | | Specific log name to purge |
822+
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
823+
824+
825+
760826
## Node types management commands
761827

762828
Node types powering your instance

0 commit comments

Comments
 (0)