feat(rdb): add support for log purging and certificate renew (#1994)

scaleway-bot · remyleone · web-flow · commit acd6e7782746 · 2021-10-21T18:01:51.000+02:00
Co-authored-by: Rémy Léone &lt;rleone@scaleway.com&gt;
diff --git a/cmd/scw/testdata/test-all-usage-rdb-acl-add-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-acl-add-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Add an ACL instance to a given instance.
+Add an additional ACL rule to a database instance.
 
 USAGE:
   scw rdb acl add [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-rdb-instance-renew-certificate-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-instance-renew-certificate-usage.golden
@@ -0,0 +1,19 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Renew the TLS certificate of an instance.
+
+USAGE:
+  scw rdb instance renew-certificate <instance-id ...> [arg=value ...]
+
+ARGS:
+  instance-id       UUID of the instance you want logs of
+  [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
+
+FLAGS:
+  -h, --help   help for renew-certificate
+
+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
diff --git a/cmd/scw/testdata/test-all-usage-rdb-instance-update-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-instance-update-usage.golden
@@ -6,13 +6,15 @@ USAGE:
   scw rdb instance update <instance-id ...> [arg=value ...]
 
 ARGS:
-  [backup-schedule-frequency]     In hours
-  [backup-schedule-retention]     In days
-  [is-backup-schedule-disabled]   Whether or not the backup schedule is disabled
-  [name]                          Name of the instance
-  instance-id                     UUID of the instance to update
-  [tags.{index}]                  Tags of a given instance
-  [region=fr-par]                 Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
+  [backup-schedule-frequency]          In hours
+  [backup-schedule-retention]          In days
+  [is-backup-schedule-disabled]        Whether or not the backup schedule is disabled
+  [name]                               Name of the instance
+  instance-id                          UUID of the instance to update
+  [tags.{index}]                       Tags of a given instance
+  [logs-policy.max-age-retention]      Max age of remote logs to keep on the database instance
+  [logs-policy.total-disk-retention]   Max disk size of remote logs to keep on the database instance
+  [region=fr-par]                      Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
   -h, --help   help for update
diff --git a/cmd/scw/testdata/test-all-usage-rdb-instance-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-instance-usage.golden
@@ -6,16 +6,17 @@ USAGE:
   scw rdb instance <command>
 
 AVAILABLE COMMANDS:
-  clone           Clone an instance
-  connect         Connect to an instance using locally installed CLI
-  create          Create an instance
-  delete          Delete an instance
-  get             Get an instance
-  get-certificate Get the TLS certificate of an instance
-  list            List instances
-  update          Update an instance
-  upgrade         Upgrade an instance to an higher instance type
-  wait            Wait for an instance to reach a stable state
+  clone             Clone an instance
+  connect           Connect to an instance using locally installed CLI
+  create            Create an instance
+  delete            Delete an instance
+  get               Get an instance
+  get-certificate   Get the TLS certificate of an instance
+  list              List instances
+  renew-certificate Renew the TLS certificate of an instance
+  update            Update an instance
+  upgrade           Upgrade an instance to an higher instance type
+  wait              Wait for an instance to reach a stable state
 
 FLAGS:
   -h, --help   help for instance
diff --git a/cmd/scw/testdata/test-all-usage-rdb-log-list-details-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-log-list-details-usage.golden
@@ -0,0 +1,19 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+List remote instances logs details.
+
+USAGE:
+  scw rdb log list-details [arg=value ...]
+
+ARGS:
+  instance-id       UUID of the instance you want logs of
+  [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
+
+FLAGS:
+  -h, --help   help for list-details
+
+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
diff --git a/cmd/scw/testdata/test-all-usage-rdb-log-purge-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-log-purge-usage.golden
@@ -0,0 +1,20 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Purge remote instances logs.
+
+USAGE:
+  scw rdb log purge [arg=value ...]
+
+ARGS:
+  instance-id       UUID of the instance you want logs of
+  [log-name]        Specific log name to purge
+  [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
+
+FLAGS:
+  -h, --help   help for purge
+
+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
diff --git a/cmd/scw/testdata/test-all-usage-rdb-log-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-log-usage.golden
@@ -6,9 +6,11 @@ USAGE:
   scw rdb log <command>
 
 AVAILABLE COMMANDS:
-  get         Get specific logs of a given instance
-  list        List available logs of a given instance
-  prepare     Prepare logs of a given instance
+  get          Get specific logs of a given instance
+  list         List available logs of a given instance
+  list-details List remote instances logs details
+  prepare      Prepare logs of a given instance
+  purge        Purge remote instances logs
 
 FLAGS:
   -h, --help   help for log
diff --git a/docs/commands/rdb.md b/docs/commands/rdb.md
@@ -30,13 +30,16 @@ Database RDB API
   - [Get an instance](#get-an-instance)
   - [Get the TLS certificate of an instance](#get-the-tls-certificate-of-an-instance)
   - [List instances](#list-instances)
+  - [Renew the TLS certificate of an instance](#renew-the-tls-certificate-of-an-instance)
   - [Update an instance](#update-an-instance)
   - [Upgrade an instance to an higher instance type](#upgrade-an-instance-to-an-higher-instance-type)
   - [Wait for an instance to reach a stable state](#wait-for-an-instance-to-reach-a-stable-state)
 - [Instance logs management commands](#instance-logs-management-commands)
   - [Get specific logs of a given instance](#get-specific-logs-of-a-given-instance)
   - [List available logs of a given instance](#list-available-logs-of-a-given-instance)
+  - [List remote instances logs details](#list-remote-instances-logs-details)
   - [Prepare logs of a given instance](#prepare-logs-of-a-given-instance)
+  - [Purge remote instances logs](#purge-remote-instances-logs)
 - [Node types management commands](#node-types-management-commands)
   - [List available node types](#list-available-node-types)
 - [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
 
 ### Add an ACL instance to a given instance
 
-Add an ACL instance to a given instance.
+Add an additional ACL rule to a database instance.
 
 **Usage:**
 
@@ -610,6 +613,26 @@ scw rdb instance list [arg=value ...]
 
 
 
+### Renew the TLS certificate of an instance
+
+Renew the TLS certificate of an instance.
+
+**Usage:**
+
+```
+scw rdb instance renew-certificate <instance-id ...> [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| instance-id | Required | UUID of the instance you want logs of |
+| 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 |
+
+
+
 ### Update an instance
 
 Update an instance.
@@ -631,6 +654,8 @@ scw rdb instance update <instance-id ...> [arg=value ...]
 | name |  | Name of the instance |
 | instance-id | Required | UUID of the instance to update |
 | tags.{index} |  | Tags of a given instance |
+| logs-policy.max-age-retention |  | Max age of remote logs to keep on the database instance |
+| logs-policy.total-disk-retention |  | Max disk size of remote logs to keep on the database instance |
 | 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 |
 
 
@@ -735,6 +760,26 @@ scw rdb log list [arg=value ...]
 
 
 
+### List remote instances logs details
+
+List remote instances logs details.
+
+**Usage:**
+
+```
+scw rdb log list-details [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| instance-id | Required | UUID of the instance you want logs of |
+| 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 |
+
+
+
 ### Prepare logs of a given instance
 
 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 ...]
 
 
 
+### Purge remote instances logs
+
+Purge remote instances logs.
+
+**Usage:**
+
+```
+scw rdb log purge [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| instance-id | Required | UUID of the instance you want logs of |
+| log-name |  | Specific log name to purge |
+| 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 |
+
+
+
 ## Node types management commands
 
 Node types powering your instance
diff --git a/internal/namespaces/rdb/v1/rdb_cli.go b/internal/namespaces/rdb/v1/rdb_cli.go
