From d4a1b6f03046e60e7c551efd479b04add1eef326 Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Fri, 25 Mar 2022 11:49:06 +0000 Subject: [PATCH 1/2] feat: update generated cli --- ...all-usage-baremetal-bmc-start-usage.golden | 2 +- .../test-all-usage-baremetal-bmc-usage.golden | 4 ++-- .../test-all-usage-baremetal-usage.golden | 2 +- ...st-all-usage-rdb-read-replica-usage.golden | 15 +++++++++++++ .../testdata/test-all-usage-rdb-usage.golden | 21 ++++++++++--------- docs/commands/baremetal.md | 12 +++++------ docs/commands/rdb.md | 17 +++++++++++++++ go.mod | 2 +- go.sum | 4 ++-- .../namespaces/baremetal/v1/baremetal_cli.go | 8 +++---- .../test-create-server-simple-default.golden | 3 ++- ...-install-server-simple-all-ssh-keys.golden | 3 ++- .../test-install-server-simple-with-id.golden | 3 ++- internal/namespaces/rdb/v1/rdb_cli.go | 11 ++++++++++ 14 files changed, 77 insertions(+), 30 deletions(-) create mode 100644 cmd/scw/testdata/test-all-usage-rdb-read-replica-usage.golden diff --git a/cmd/scw/testdata/test-all-usage-baremetal-bmc-start-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-bmc-start-usage.golden index bd6528fad4..1c4c6fc621 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-bmc-start-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-bmc-start-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Unvailable - Start BMC (Baseboard Management Controller) access associated with the given ID. +Start BMC (Baseboard Management Controller) access associated with the given ID. The BMC (Baseboard Management Controller) access is available one hour after the installation of the server. USAGE: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-bmc-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-bmc-usage.golden index a5a6ce8d84..de90767332 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-bmc-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-bmc-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Unvailable - Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server. +Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server. For instance, your KVM-IP management console could be accessed with it. USAGE: @@ -8,7 +8,7 @@ USAGE: AVAILABLE COMMANDS: get Get BMC (Baseboard Management Controller) access for a given elastic metal server - start Unvailable - Start BMC (Baseboard Management Controller) access for a given elastic metal server + start Start BMC (Baseboard Management Controller) access for a given elastic metal server stop Stop BMC (Baseboard Management Controller) access for a given elastic metal server FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-usage.golden index 93d6133802..fd80fffdb6 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-usage.golden @@ -6,7 +6,7 @@ USAGE: scw baremetal AVAILABLE COMMANDS: - bmc Unvailable - Baseboard Management Controller (BMC) management commands + bmc Baseboard Management Controller (BMC) management commands os Operating System (OS) management commands server Server management commands diff --git a/cmd/scw/testdata/test-all-usage-rdb-read-replica-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-read-replica-usage.golden new file mode 100644 index 0000000000..d8dc15345a --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-rdb-read-replica-usage.golden @@ -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 diff --git a/cmd/scw/testdata/test-all-usage-rdb-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-usage.golden index bbf10bae91..bae8df2453 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-usage.golden @@ -6,16 +6,17 @@ USAGE: scw rdb 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 diff --git a/docs/commands/baremetal.md b/docs/commands/baremetal.md index d0ff5349a6..e48bce7c80 100644 --- a/docs/commands/baremetal.md +++ b/docs/commands/baremetal.md @@ -2,9 +2,9 @@ # Documentation for `scw baremetal` Elastic metal API -- [Unvailable - Baseboard Management Controller (BMC) management commands](#unvailable---baseboard-management-controller-(bmc)-management-commands) +- [Baseboard Management Controller (BMC) management commands](#baseboard-management-controller-(bmc)-management-commands) - [Get BMC (Baseboard Management Controller) access for a given elastic metal server](#get-bmc-(baseboard-management-controller)-access-for-a-given-elastic-metal-server) - - [Unvailable - Start BMC (Baseboard Management Controller) access for a given elastic metal server](#unvailable---start-bmc-(baseboard-management-controller)-access-for-a-given-elastic-metal-server) + - [Start BMC (Baseboard Management Controller) access for a given elastic metal server](#start-bmc-(baseboard-management-controller)-access-for-a-given-elastic-metal-server) - [Stop BMC (Baseboard Management Controller) access for a given elastic metal server](#stop-bmc-(baseboard-management-controller)-access-for-a-given-elastic-metal-server) - [Operating System (OS) management commands](#operating-system-(os)-management-commands) - [Get an OS with a given ID](#get-an-os-with-a-given-id) @@ -22,9 +22,9 @@ Elastic metal API - [Wait for a server to reach a stable state (delivery and installation)](#wait-for-a-server-to-reach-a-stable-state-(delivery-and-installation)) -## Unvailable - Baseboard Management Controller (BMC) management commands +## Baseboard Management Controller (BMC) management commands -Unvailable - Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server. +Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server. For instance, your KVM-IP management console could be accessed with it. @@ -49,9 +49,9 @@ scw baremetal bmc get [arg=value ...] -### Unvailable - Start BMC (Baseboard Management Controller) access for a given elastic metal server +### Start BMC (Baseboard Management Controller) access for a given elastic metal server -Unvailable - Start BMC (Baseboard Management Controller) access associated with the given ID. +Start BMC (Baseboard Management Controller) access associated with the given ID. The BMC (Baseboard Management Controller) access is available one hour after the installation of the server. diff --git a/docs/commands/rdb.md b/docs/commands/rdb.md index 17139518e8..5e799d9424 100644 --- a/docs/commands/rdb.md +++ b/docs/commands/rdb.md @@ -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) @@ -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 diff --git a/go.mod b/go.mod index 4dee4dd7d3..a2e1afddf5 100644 --- a/go.mod +++ b/go.mod @@ -17,7 +17,7 @@ require ( github.com/kubernetes-client/go-base v0.0.0-20190205182333-3d0e39759d98 github.com/mattn/go-colorable v0.1.12 github.com/mattn/go-isatty v0.0.14 - github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220223135819-4133d5122603 + github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220325110112-a8da26092f72 github.com/spf13/cobra v1.4.0 github.com/spf13/pflag v1.0.5 github.com/stretchr/testify v1.7.1 diff --git a/go.sum b/go.sum index 0d8e2154d9..21b9b60456 100644 --- a/go.sum +++ b/go.sum @@ -57,8 +57,8 @@ github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINE github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= -github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220223135819-4133d5122603 h1:ldNbElGuvDbei0cJVYmrYuUmQ4c7d1XCpfr9U0k3lGw= -github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220223135819-4133d5122603/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg= +github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220325110112-a8da26092f72 h1:pWmhgGVHNImWrErdC7ttqh2TH2ITnucGn5HngFXegxg= +github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220325110112-a8da26092f72/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg= github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ= github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= github.com/spf13/cobra v1.4.0 h1:y+wJpx64xcgO1V+RcnwW0LEHxTKRi2ZDPSBjWnrg88Q= diff --git a/internal/namespaces/baremetal/v1/baremetal_cli.go b/internal/namespaces/baremetal/v1/baremetal_cli.go index 27c3159d68..c69b3d9947 100644 --- a/internal/namespaces/baremetal/v1/baremetal_cli.go +++ b/internal/namespaces/baremetal/v1/baremetal_cli.go @@ -67,8 +67,8 @@ func baremetalOs() *core.Command { func baremetalBmc() *core.Command { return &core.Command{ - Short: `Unvailable - Baseboard Management Controller (BMC) management commands`, - Long: `Unvailable - Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server. + Short: `Baseboard Management Controller (BMC) management commands`, + Long: `Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server. For instance, your KVM-IP management console could be accessed with it. `, Namespace: "baremetal", @@ -623,8 +623,8 @@ func baremetalServerStop() *core.Command { func baremetalBmcStart() *core.Command { return &core.Command{ - Short: `Unvailable - Start BMC (Baseboard Management Controller) access for a given elastic metal server`, - Long: `Unvailable - Start BMC (Baseboard Management Controller) access associated with the given ID. + Short: `Start BMC (Baseboard Management Controller) access for a given elastic metal server`, + Long: `Start BMC (Baseboard Management Controller) access associated with the given ID. The BMC (Baseboard Management Controller) access is available one hour after the installation of the server. `, Namespace: "baremetal", diff --git a/internal/namespaces/baremetal/v1/testdata/test-create-server-simple-default.golden b/internal/namespaces/baremetal/v1/testdata/test-create-server-simple-default.golden index bde8170e28..fb3ecd3371 100644 --- a/internal/namespaces/baremetal/v1/testdata/test-create-server-simple-default.golden +++ b/internal/namespaces/baremetal/v1/testdata/test-create-server-simple-default.golden @@ -62,5 +62,6 @@ PingStatus down "zone": "nl-ams-1", "install": null, "ping_status": "ping_status_down", - "options": null + "options": null, + "rescue_server": null } diff --git a/internal/namespaces/baremetal/v1/testdata/test-install-server-simple-all-ssh-keys.golden b/internal/namespaces/baremetal/v1/testdata/test-install-server-simple-all-ssh-keys.golden index dc6e4df9ce..22b8016b08 100644 --- a/internal/namespaces/baremetal/v1/testdata/test-install-server-simple-all-ssh-keys.golden +++ b/internal/namespaces/baremetal/v1/testdata/test-install-server-simple-all-ssh-keys.golden @@ -87,5 +87,6 @@ PingStatus down "service_url": "" }, "ping_status": "ping_status_down", - "options": null + "options": null, + "rescue_server": null } diff --git a/internal/namespaces/baremetal/v1/testdata/test-install-server-simple-with-id.golden b/internal/namespaces/baremetal/v1/testdata/test-install-server-simple-with-id.golden index 059604c6fe..ed050ec081 100644 --- a/internal/namespaces/baremetal/v1/testdata/test-install-server-simple-with-id.golden +++ b/internal/namespaces/baremetal/v1/testdata/test-install-server-simple-with-id.golden @@ -79,5 +79,6 @@ PingStatus down "service_url": "" }, "ping_status": "ping_status_down", - "options": null + "options": null, + "rescue_server": null } diff --git a/internal/namespaces/rdb/v1/rdb_cli.go b/internal/namespaces/rdb/v1/rdb_cli.go index 9396cf2e11..a401699037 100644 --- a/internal/namespaces/rdb/v1/rdb_cli.go +++ b/internal/namespaces/rdb/v1/rdb_cli.go @@ -30,6 +30,7 @@ func GetGeneratedCommands() *core.Commands { rdbNodeType(), rdbLog(), rdbSnapshot(), + rdbReadReplica(), rdbEngineList(), rdbNodeTypeList(), rdbBackupList(), @@ -181,6 +182,16 @@ func rdbSnapshot() *core.Command { } } +func rdbReadReplica() *core.Command { + return &core.Command{ + Short: `Read replica management`, + Long: `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. +`, + Namespace: "rdb", + Resource: "read-replica", + } +} + func rdbEngineList() *core.Command { return &core.Command{ Short: `List available database engines`, From 8dc5b6e6d5580648038772b1557bc8c1d5b52095 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9my=20L=C3=A9one?= Date: Tue, 29 Mar 2022 14:28:33 +0200 Subject: [PATCH 2/2] Fix --- ...st-all-usage-rdb-read-replica-usage.golden | 15 ------------- .../testdata/test-all-usage-rdb-usage.golden | 21 +++++++++---------- docs/commands/rdb.md | 17 --------------- internal/namespaces/rdb/v1/rdb_cli.go | 11 ---------- 4 files changed, 10 insertions(+), 54 deletions(-) delete mode 100644 cmd/scw/testdata/test-all-usage-rdb-read-replica-usage.golden diff --git a/cmd/scw/testdata/test-all-usage-rdb-read-replica-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-read-replica-usage.golden deleted file mode 100644 index d8dc15345a..0000000000 --- a/cmd/scw/testdata/test-all-usage-rdb-read-replica-usage.golden +++ /dev/null @@ -1,15 +0,0 @@ -🎲🎲🎲 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 diff --git a/cmd/scw/testdata/test-all-usage-rdb-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-usage.golden index bae8df2453..bbf10bae91 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-usage.golden @@ -6,17 +6,16 @@ USAGE: scw rdb 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 - read-replica Read replica management - 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 + snapshot Block snapshot management + user User management commands FLAGS: -h, --help help for rdb diff --git a/docs/commands/rdb.md b/docs/commands/rdb.md index 5e799d9424..17139518e8 100644 --- a/docs/commands/rdb.md +++ b/docs/commands/rdb.md @@ -46,7 +46,6 @@ 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) @@ -925,22 +924,6 @@ 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 diff --git a/internal/namespaces/rdb/v1/rdb_cli.go b/internal/namespaces/rdb/v1/rdb_cli.go index a401699037..9396cf2e11 100644 --- a/internal/namespaces/rdb/v1/rdb_cli.go +++ b/internal/namespaces/rdb/v1/rdb_cli.go @@ -30,7 +30,6 @@ func GetGeneratedCommands() *core.Commands { rdbNodeType(), rdbLog(), rdbSnapshot(), - rdbReadReplica(), rdbEngineList(), rdbNodeTypeList(), rdbBackupList(), @@ -182,16 +181,6 @@ func rdbSnapshot() *core.Command { } } -func rdbReadReplica() *core.Command { - return &core.Command{ - Short: `Read replica management`, - Long: `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. -`, - Namespace: "rdb", - Resource: "read-replica", - } -} - func rdbEngineList() *core.Command { return &core.Command{ Short: `List available database engines`,