From 493fc76890bc14c1d3221503c3e888adb101233d Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Thu, 9 Jul 2020 15:13:25 +0000 Subject: [PATCH] feat: update generated cli --- ...all-usage-account-ssh-key-add-usage.golden | 2 +- ...all-usage-account-ssh-key-get-usage.golden | 2 +- ...ll-usage-account-ssh-key-list-usage.golden | 2 +- ...-usage-account-ssh-key-remove-usage.golden | 2 +- ...-usage-account-ssh-key-update-usage.golden | 2 +- ...est-all-usage-account-ssh-key-usage.golden | 12 +-- .../test-all-usage-account-usage.golden | 4 +- ...st-all-usage-baremetal-os-get-usage.golden | 2 +- .../test-all-usage-baremetal-os-usage.golden | 6 +- ...usage-baremetal-server-create-usage.golden | 2 +- ...l-usage-baremetal-server-list-usage.golden | 2 +- ...st-all-usage-baremetal-server-usage.golden | 20 ++--- .../test-all-usage-baremetal-usage.golden | 4 +- ...l-usage-instance-image-create-usage.golden | 2 +- ...test-all-usage-instance-image-usage.golden | 8 +- ...-all-usage-instance-ip-create-usage.golden | 2 +- ...st-all-usage-instance-ip-list-usage.golden | 2 +- ...-all-usage-instance-ip-update-usage.golden | 2 +- .../test-all-usage-instance-ip-usage.golden | 10 +-- ...sage-instance-placement-group-usage.golden | 6 +- ...nstance-security-group-create-usage.golden | 2 +- ...nstance-security-group-delete-usage.golden | 2 +- ...usage-instance-security-group-usage.golden | 6 +- ...ll-usage-instance-server-list-usage.golden | 2 +- ...-usage-instance-server-update-usage.golden | 2 +- ...est-all-usage-instance-server-usage.golden | 6 +- ...sage-instance-snapshot-create-usage.golden | 2 +- ...t-all-usage-instance-snapshot-usage.golden | 6 +- .../test-all-usage-instance-usage.golden | 20 ++--- ...-usage-instance-volume-create-usage.golden | 2 +- ...est-all-usage-instance-volume-usage.golden | 8 +- .../testdata/test-all-usage-k8s-usage.golden | 10 +-- ...t-all-usage-marketplace-image-usage.golden | 2 +- .../test-all-usage-marketplace-usage.golden | 2 +- .../test-all-usage-rdb-acl-usage.golden | 2 +- ...est-all-usage-rdb-certificate-usage.golden | 2 +- .../test-all-usage-rdb-log-usage.golden | 2 +- .../testdata/test-all-usage-rdb-usage.golden | 31 +++---- ...test-all-usage-registry-image-usage.golden | 2 +- ...-all-usage-registry-namespace-usage.golden | 1 + .../test-all-usage-registry-tag-usage.golden | 2 +- .../test-all-usage-registry-usage.golden | 8 +- cmd/scw/testdata/test-main-usage-usage.golden | 6 +- .../account/v2alpha1/account_cli.go | 26 +++--- .../namespaces/baremetal/v1/baremetal_cli.go | 36 ++++---- .../namespaces/instance/v1/instance_cli.go | 90 +++++++++---------- internal/namespaces/k8s/v1/k8s_cli.go | 10 +-- .../marketplace/v1/marketplace_cli.go | 4 +- internal/namespaces/rdb/v1/rdb_cli.go | 37 +++----- .../namespaces/registry/v1/registry_cli.go | 15 ++-- 50 files changed, 212 insertions(+), 228 deletions(-) diff --git a/cmd/scw/testdata/test-all-usage-account-ssh-key-add-usage.golden b/cmd/scw/testdata/test-all-usage-account-ssh-key-add-usage.golden index 9a17f3e78f..9e45186ddb 100644 --- a/cmd/scw/testdata/test-all-usage-account-ssh-key-add-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-ssh-key-add-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Add a SSH key to your Scaleway account. +Add a SSH key to your organization. USAGE: scw account ssh-key add [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-account-ssh-key-get-usage.golden b/cmd/scw/testdata/test-all-usage-account-ssh-key-get-usage.golden index 4fc77e604c..5242471c05 100644 --- a/cmd/scw/testdata/test-all-usage-account-ssh-key-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-ssh-key-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get SSH key details. +Get a SSH key from your organization. USAGE: scw account ssh-key get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-account-ssh-key-list-usage.golden b/cmd/scw/testdata/test-all-usage-account-ssh-key-list-usage.golden index a1c140e23f..3e0c50ef67 100644 --- a/cmd/scw/testdata/test-all-usage-account-ssh-key-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-ssh-key-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List all SSH keys. +List all SSH keys of your organization. USAGE: scw account ssh-key list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-account-ssh-key-remove-usage.golden b/cmd/scw/testdata/test-all-usage-account-ssh-key-remove-usage.golden index 2a439db7bc..03c955f967 100644 --- a/cmd/scw/testdata/test-all-usage-account-ssh-key-remove-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-ssh-key-remove-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Remove a SSH key from your Scaleway account. +Remove a SSH key from your organization. USAGE: scw account ssh-key remove [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-account-ssh-key-update-usage.golden b/cmd/scw/testdata/test-all-usage-account-ssh-key-update-usage.golden index 312ad34353..b7509ed493 100644 --- a/cmd/scw/testdata/test-all-usage-account-ssh-key-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-ssh-key-update-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update an SSH key. +Update a SSH key on your organization. USAGE: scw account ssh-key update [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-account-ssh-key-usage.golden b/cmd/scw/testdata/test-all-usage-account-ssh-key-usage.golden index 5663b77689..2fc8c59375 100644 --- a/cmd/scw/testdata/test-all-usage-account-ssh-key-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-ssh-key-usage.golden @@ -1,17 +1,17 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Manage your Scaleway SSH keys. +SSH keys management commands. USAGE: scw account ssh-key AVAILABLE COMMANDS: - add Add a SSH key to your Scaleway account - get Get SSH key details + add Add a SSH key to your organization + get Get a SSH key from your organization init Initialize SSH key - list List all SSH keys - remove Remove a SSH key from your Scaleway account - update Update an SSH key + list List all SSH keys of your organization + remove Remove a SSH key from your organization + update Update a SSH key on your organization FLAGS: -h, --help help for ssh-key diff --git a/cmd/scw/testdata/test-all-usage-account-usage.golden b/cmd/scw/testdata/test-all-usage-account-usage.golden index 00d38eb6d0..adc62e0ea3 100644 --- a/cmd/scw/testdata/test-all-usage-account-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -This API allows to manage your scaleway account +Account API USAGE: scw account AVAILABLE COMMANDS: - ssh-key Manage your Scaleway SSH keys + ssh-key SSH keys management commands FLAGS: -h, --help help for account diff --git a/cmd/scw/testdata/test-all-usage-baremetal-os-get-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-os-get-usage.golden index 62b8a7c07e..2382b91c52 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-os-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-os-get-usage.golden @@ -10,7 +10,7 @@ EXAMPLES: scw baremetal os get ARGS: - os-id ID of the researched OS + os-id ID of the OS [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-os-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-os-usage.golden index 4de0f2a928..955d8fcdfb 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-os-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-os-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -An Operating System (OS) is the underlying software installed on your server. +An Operating System (OS) is the underlying software installed on your server USAGE: scw baremetal os AVAILABLE COMMANDS: - get Get OS - list List OS + get Get an OS with a given ID + list List all available OS that can be install on a baremetal server FLAGS: -h, --help help for os diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-create-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-create-usage.golden index 16ff666ff7..e2ae738a46 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-server-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-server-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a new server. Once the server is created, you probably want to install an OS. +Create a new baremetal server. Once the server is created, you probably want to install an OS. USAGE: scw baremetal server create [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-list-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-list-usage.golden index 03faab437f..a627379bd8 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-server-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-server-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List all created servers. +List baremetal servers. USAGE: scw baremetal server list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-usage.golden index 781b7ed941..c8c7119ce1 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-server-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-server-usage.golden @@ -1,20 +1,20 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -A server is a denomination of a type of instances provided by Scaleway. +A server is a denomination of a type of instances provided by Scaleway USAGE: scw baremetal server AVAILABLE COMMANDS: - create Create server - delete Delete server - get Get server - install Install server - list List servers - reboot Reboot server - start Start server - stop Stop server - update Update server + create Create a baremetal server + delete Delete a baremetal server + get Get a specific baremetal server + install Install a baremetal server + list List baremetal servers + reboot Reboot a baremetal server + start Start a baremetal server + stop Stop a baremetal server + update Update a baremetal server wait Wait for a server to reach a stable state (delivery and installation) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-usage.golden index 7befdc80b4..a4dca512bb 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-usage.golden @@ -6,8 +6,8 @@ USAGE: scw baremetal AVAILABLE COMMANDS: - os An Operating System (OS) is the underlying software installed on your server - server A server is a denomination of a type of instances provided by Scaleway + os Operating System (OS) management commands + server Server management commands FLAGS: -h, --help help for baremetal diff --git a/cmd/scw/testdata/test-all-usage-instance-image-create-usage.golden b/cmd/scw/testdata/test-all-usage-instance-image-create-usage.golden index 25f42f1629..1b7d8b5f12 100644 --- a/cmd/scw/testdata/test-all-usage-instance-image-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-image-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create image. +Create an instance image. USAGE: scw instance image create [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-instance-image-usage.golden b/cmd/scw/testdata/test-all-usage-instance-image-usage.golden index 71ebb78473..29113a7f0e 100644 --- a/cmd/scw/testdata/test-all-usage-instance-image-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-image-usage.golden @@ -9,10 +9,10 @@ USAGE: scw instance image AVAILABLE COMMANDS: - create Create image - delete Delete image - get Get image - list List images + create Create an instance image + delete Delete an instance image + get Get an instance image + list List instance images wait Wait for image to reach a stable state FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-instance-ip-create-usage.golden b/cmd/scw/testdata/test-all-usage-instance-ip-create-usage.golden index 678c17e172..241579b589 100644 --- a/cmd/scw/testdata/test-all-usage-instance-ip-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-ip-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Reserve an IP. +Reserve a flexible IP. USAGE: scw instance ip create [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-instance-ip-list-usage.golden b/cmd/scw/testdata/test-all-usage-instance-ip-list-usage.golden index fe5b3d6d7d..43052025f2 100644 --- a/cmd/scw/testdata/test-all-usage-instance-ip-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-ip-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List IPs. +List all flexible IPs. USAGE: scw instance ip list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-instance-ip-update-usage.golden b/cmd/scw/testdata/test-all-usage-instance-ip-update-usage.golden index f98bc21517..268b88bf78 100644 --- a/cmd/scw/testdata/test-all-usage-instance-ip-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-ip-update-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update IP. +Update a flexible IP. USAGE: scw instance ip update [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-instance-ip-usage.golden b/cmd/scw/testdata/test-all-usage-instance-ip-usage.golden index e4d5e7aca5..93e46f992a 100644 --- a/cmd/scw/testdata/test-all-usage-instance-ip-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-ip-usage.golden @@ -9,11 +9,11 @@ USAGE: scw instance ip AVAILABLE COMMANDS: - create Reserve an IP - delete Delete IP - get Get IP - list List IPs - update Update IP + create Reserve a flexible IP + delete Delete a flexible IP + get Get a flexible IP + list List all flexible IPs + update Update a flexible IP FLAGS: -h, --help help for ip diff --git a/cmd/scw/testdata/test-all-usage-instance-placement-group-usage.golden b/cmd/scw/testdata/test-all-usage-instance-placement-group-usage.golden index 57bab0f5a0..c16e76f7fe 100644 --- a/cmd/scw/testdata/test-all-usage-instance-placement-group-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-placement-group-usage.golden @@ -23,11 +23,11 @@ USAGE: scw instance placement-group AVAILABLE COMMANDS: - create Create placement group + create Create a placement group delete Delete the given placement group - get Get placement group + get Get a placement group list List placement groups - update Update placement group + update Update a placement group FLAGS: -h, --help help for placement-group diff --git a/cmd/scw/testdata/test-all-usage-instance-security-group-create-usage.golden b/cmd/scw/testdata/test-all-usage-instance-security-group-create-usage.golden index 8820c83bf9..497c3c4c7b 100644 --- a/cmd/scw/testdata/test-all-usage-instance-security-group-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-security-group-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create security group. +Create a security group. USAGE: scw instance security-group create [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-instance-security-group-delete-usage.golden b/cmd/scw/testdata/test-all-usage-instance-security-group-delete-usage.golden index 90c18a6573..64bd76c7ec 100644 --- a/cmd/scw/testdata/test-all-usage-instance-security-group-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-security-group-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete security group. +Delete a security group. USAGE: scw instance security-group delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-instance-security-group-usage.golden b/cmd/scw/testdata/test-all-usage-instance-security-group-usage.golden index c4894769b1..b036e3256f 100644 --- a/cmd/scw/testdata/test-all-usage-instance-security-group-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-security-group-usage.golden @@ -11,9 +11,9 @@ USAGE: AVAILABLE COMMANDS: clear Remove all rules of a security group - create Create security group - delete Delete security group - get Get security group + create Create a security group + delete Delete a security group + get Get a security group list List security groups update Update security group diff --git a/cmd/scw/testdata/test-all-usage-instance-server-list-usage.golden b/cmd/scw/testdata/test-all-usage-instance-server-list-usage.golden index 480264b9e9..98630eb824 100644 --- a/cmd/scw/testdata/test-all-usage-instance-server-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-server-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List servers. +List all servers. USAGE: scw instance server list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-instance-server-update-usage.golden b/cmd/scw/testdata/test-all-usage-instance-server-update-usage.golden index 7b0daa57aa..0bd0c5cce7 100644 --- a/cmd/scw/testdata/test-all-usage-instance-server-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-server-update-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update server. +Update a server. USAGE: scw instance server update [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-instance-server-usage.golden b/cmd/scw/testdata/test-all-usage-instance-server-usage.golden index 33a98e5e41..5e47ff8b99 100644 --- a/cmd/scw/testdata/test-all-usage-instance-server-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-server-usage.golden @@ -37,15 +37,15 @@ AVAILABLE COMMANDS: create Create server delete Delete server detach-volume Detach a volume from its server - get Get server - list List servers + get Get a server + list List all servers reboot Reboot server ssh SSH into a server standby Put server in standby mode start Power on server stop Power off server terminate Terminate server - update Update server + update Update a server wait Wait for server to reach a stable state FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-instance-snapshot-create-usage.golden b/cmd/scw/testdata/test-all-usage-instance-snapshot-create-usage.golden index 9b7cacd326..d45084f3a7 100644 --- a/cmd/scw/testdata/test-all-usage-instance-snapshot-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-snapshot-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create snapshot. +Create a snapshot from a given volume. USAGE: scw instance snapshot create [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-instance-snapshot-usage.golden b/cmd/scw/testdata/test-all-usage-instance-snapshot-usage.golden index 16b0f89aa9..80c1c7345b 100644 --- a/cmd/scw/testdata/test-all-usage-instance-snapshot-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-snapshot-usage.golden @@ -16,9 +16,9 @@ USAGE: scw instance snapshot AVAILABLE COMMANDS: - create Create snapshot - delete Delete snapshot - get Get snapshot + create Create a snapshot from a given volume + delete Delete a snapshot + get Get a snapshot list List snapshots wait Wait for snapshot to reach a stable state diff --git a/cmd/scw/testdata/test-all-usage-instance-usage.golden b/cmd/scw/testdata/test-all-usage-instance-usage.golden index 72967c26d7..2659d9960e 100644 --- a/cmd/scw/testdata/test-all-usage-instance-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-usage.golden @@ -6,16 +6,16 @@ USAGE: scw instance AVAILABLE COMMANDS: - image An image is a backup of an instance - ip A flexible IP address is an IP address which holden independently of any server - placement-group A placement group allows to express a preference regarding the physical position of a group of instances - security-group A security group is a set of firewall rules on a set of instances - server A server is a denomination of a type of instances provided by Scaleway - server-type A server type is a representation of an instance type available in a given zone - snapshot A snapshot contains the data of a specific volume at a particular point in time - user-data User data is a key value store API you can use to provide data from and to your server without authentication - volume A volume is used to store data inside an instance - volume-type A volume type is a representation of a volume type available in a given zone + image Image management commands + ip IP management commands + placement-group Placement group management commands + security-group Security group management commands + server Server management commands + server-type Server type management commands + snapshot Snapshot management commands + user-data User data management commands + volume Volume management commands + volume-type Volume type management commands FLAGS: -h, --help help for instance diff --git a/cmd/scw/testdata/test-all-usage-instance-volume-create-usage.golden b/cmd/scw/testdata/test-all-usage-instance-volume-create-usage.golden index 38afc71196..e0779af49e 100644 --- a/cmd/scw/testdata/test-all-usage-instance-volume-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-volume-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create volume. +Create a volume. USAGE: scw instance volume create [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-instance-volume-usage.golden b/cmd/scw/testdata/test-all-usage-instance-volume-usage.golden index 64623c3c8a..c6afe1c2b3 100644 --- a/cmd/scw/testdata/test-all-usage-instance-volume-usage.golden +++ b/cmd/scw/testdata/test-all-usage-instance-volume-usage.golden @@ -35,11 +35,11 @@ USAGE: scw instance volume AVAILABLE COMMANDS: - create Create volume - delete Delete volume - get Get volume + create Create a volume + delete Delete a volume + get Get a volume list List volumes - update Update volume + update Update a volume FLAGS: -h, --help help for volume diff --git a/cmd/scw/testdata/test-all-usage-k8s-usage.golden b/cmd/scw/testdata/test-all-usage-k8s-usage.golden index ee5c93e05b..f310bcc6ca 100644 --- a/cmd/scw/testdata/test-all-usage-k8s-usage.golden +++ b/cmd/scw/testdata/test-all-usage-k8s-usage.golden @@ -1,16 +1,16 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -This API allows you to manage your Kapsule clusters +Kapsule API USAGE: scw k8s AVAILABLE COMMANDS: - cluster A cluster is a Kubernetes Kapsule cluster + cluster Kapsule cluster management commands kubeconfig Manage your Kubernetes Kapsule cluster's kubeconfig files - node A node is the representation of a Scaleway instance in a cluster - pool A pool is a virtual group of nodes in a cluster - version A version is a Kubernetes version + node Kapsule node management commands + pool Kapsule pool management commands + version Available Kubernetes version commands FLAGS: -h, --help help for k8s diff --git a/cmd/scw/testdata/test-all-usage-marketplace-image-usage.golden b/cmd/scw/testdata/test-all-usage-marketplace-image-usage.golden index f6ecc3c804..ac96885b8f 100644 --- a/cmd/scw/testdata/test-all-usage-marketplace-image-usage.golden +++ b/cmd/scw/testdata/test-all-usage-marketplace-image-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Marketplace images can be used when creating an instance. +Marketplace images management commands. USAGE: scw marketplace image diff --git a/cmd/scw/testdata/test-all-usage-marketplace-usage.golden b/cmd/scw/testdata/test-all-usage-marketplace-usage.golden index 1b29c34a60..602dfc44a6 100644 --- a/cmd/scw/testdata/test-all-usage-marketplace-usage.golden +++ b/cmd/scw/testdata/test-all-usage-marketplace-usage.golden @@ -6,7 +6,7 @@ USAGE: scw marketplace AVAILABLE COMMANDS: - image Marketplace images can be used when creating an instance + image Marketplace images management commands FLAGS: -h, --help help for marketplace diff --git a/cmd/scw/testdata/test-all-usage-rdb-acl-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-acl-usage.golden index fc41cf90d2..74915ea407 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-acl-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-acl-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Network Access Control List allows to control network in and out traffic by setting up ACL rules. ACL rules could be created, edited, deleted +Network Access Control List allows to control network in and out traffic by setting up ACL rules. USAGE: scw rdb acl diff --git a/cmd/scw/testdata/test-all-usage-rdb-certificate-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-certificate-usage.golden index 41fbb749ec..c59d84abc6 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-certificate-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-certificate-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -TLS certificate used by your instance. +Instance TLS certificate management commands. USAGE: scw rdb certificate diff --git a/cmd/scw/testdata/test-all-usage-rdb-log-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-log-usage.golden index 38d57eacbe..b7714e9c7a 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-log-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-log-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Logs generated by your instance. +Instance logs management commands. USAGE: scw rdb log diff --git a/cmd/scw/testdata/test-all-usage-rdb-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-usage.golden index e3a162872c..59a0b050f2 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-usage.golden @@ -6,26 +6,17 @@ USAGE: scw rdb AVAILABLE COMMANDS: - acl Network Access Control List allows to control network in and out traffic by setting up ACL rules - - backup Backups are extracted data of your database at a given time - - certificate TLS certificate used by your instance - database Manage logical databases on your instance - - engine Software that stores and retrieves data from a database - - instance A Database Instance is composed of one or more Nodes, depending of the is_ha_cluster setting - - log Logs generated by your instance - node-type Node types powering your instance - - privilege Define some privileges to a user on a specific database - - settings Instance Settings are tunables of Database Engines - - user Manage users on your instance - + acl Access Control List (ACL) management commands + backup Backup management commands + certificate Instance TLS certificate 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 + settings Settings management commands + user User management commands FLAGS: -h, --help help for rdb diff --git a/cmd/scw/testdata/test-all-usage-registry-image-usage.golden b/cmd/scw/testdata/test-all-usage-registry-image-usage.golden index eccc392976..4171c4aa6d 100644 --- a/cmd/scw/testdata/test-all-usage-registry-image-usage.golden +++ b/cmd/scw/testdata/test-all-usage-registry-image-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -An image represents a docker image. +An image represents a container image. The visibility of an image can be public (everyone can pull it), private (only your organization can pull it) or inherit from the namespace visibility (default) It can be changed with an update on the image via the registry API. diff --git a/cmd/scw/testdata/test-all-usage-registry-namespace-usage.golden b/cmd/scw/testdata/test-all-usage-registry-namespace-usage.golden index 4353502807..b7fd14bb51 100644 --- a/cmd/scw/testdata/test-all-usage-registry-namespace-usage.golden +++ b/cmd/scw/testdata/test-all-usage-registry-namespace-usage.golden @@ -1,5 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +A namespace is for images what a folder is for files To use our services, the first step is to create a namespace. diff --git a/cmd/scw/testdata/test-all-usage-registry-tag-usage.golden b/cmd/scw/testdata/test-all-usage-registry-tag-usage.golden index cd4ac813ad..5844aa7d3d 100644 --- a/cmd/scw/testdata/test-all-usage-registry-tag-usage.golden +++ b/cmd/scw/testdata/test-all-usage-registry-tag-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -A tag represents a docker tag of an image. +A tag represents a container tag of an image. USAGE: scw registry tag diff --git a/cmd/scw/testdata/test-all-usage-registry-usage.golden b/cmd/scw/testdata/test-all-usage-registry-usage.golden index b58297dc29..ba982295ae 100644 --- a/cmd/scw/testdata/test-all-usage-registry-usage.golden +++ b/cmd/scw/testdata/test-all-usage-registry-usage.golden @@ -1,17 +1,17 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Docker registry API +Container registry API USAGE: scw registry AVAILABLE COMMANDS: - image An image represents a container image + image Image management commands install-docker-helper Install a local Docker credential helper login Login to a registry logout Logout of a registry - namespace A namespace is for images what a folder is for files - tag A tag represents a container tag of an image + namespace Namespace management commands + tag Tag management commands FLAGS: -h, --help help for registry diff --git a/cmd/scw/testdata/test-main-usage-usage.golden b/cmd/scw/testdata/test-main-usage-usage.golden index b7c846749b..962e3a3548 100644 --- a/cmd/scw/testdata/test-main-usage-usage.golden +++ b/cmd/scw/testdata/test-main-usage-usage.golden @@ -4,18 +4,18 @@ USAGE: scw AVAILABLE COMMANDS: - account This API allows to manage your scaleway account + account Account API baremetal Baremetal API config Config file management feedback Send feedback to the Scaleway CLI Team! info Get info about current settings init Initialize the config instance Instance API - k8s This API allows you to manage your Kapsule clusters + k8s Kapsule API marketplace Marketplace API object Object-storage utils rdb Database RDB API - registry Docker registry API + registry Container registry API version Display cli version help Help about any command diff --git a/internal/namespaces/account/v2alpha1/account_cli.go b/internal/namespaces/account/v2alpha1/account_cli.go index 1eed50794c..fc4ab21cfb 100644 --- a/internal/namespaces/account/v2alpha1/account_cli.go +++ b/internal/namespaces/account/v2alpha1/account_cli.go @@ -30,7 +30,7 @@ func GetGeneratedCommands() *core.Commands { } func accountRoot() *core.Command { return &core.Command{ - Short: `This API allows to manage your scaleway account`, + Short: `Account API`, Long: ``, Namespace: "account", } @@ -38,8 +38,8 @@ func accountRoot() *core.Command { func accountSSHKey() *core.Command { return &core.Command{ - Short: `Manage your Scaleway SSH keys`, - Long: `Manage your Scaleway SSH keys.`, + Short: `SSH keys management commands`, + Long: `SSH keys management commands.`, Namespace: "account", Resource: "ssh-key", } @@ -47,8 +47,8 @@ func accountSSHKey() *core.Command { func accountSSHKeyList() *core.Command { return &core.Command{ - Short: `List all SSH keys`, - Long: `List all SSH keys.`, + Short: `List all SSH keys of your organization`, + Long: `List all SSH keys of your organization.`, Namespace: "account", Resource: "ssh-key", Verb: "list", @@ -119,8 +119,8 @@ func accountSSHKeyList() *core.Command { func accountSSHKeyAdd() *core.Command { return &core.Command{ - Short: `Add a SSH key to your Scaleway account`, - Long: `Add a SSH key to your Scaleway account.`, + Short: `Add a SSH key to your organization`, + Long: `Add a SSH key to your organization.`, Namespace: "account", Resource: "ssh-key", Verb: "add", @@ -175,8 +175,8 @@ func accountSSHKeyAdd() *core.Command { func accountSSHKeyGet() *core.Command { return &core.Command{ - Short: `Get SSH key details`, - Long: `Get SSH key details.`, + Short: `Get a SSH key from your organization`, + Long: `Get a SSH key from your organization.`, Namespace: "account", Resource: "ssh-key", Verb: "get", @@ -202,8 +202,8 @@ func accountSSHKeyGet() *core.Command { func accountSSHKeyUpdate() *core.Command { return &core.Command{ - Short: `Update an SSH key`, - Long: `Update an SSH key.`, + Short: `Update a SSH key on your organization`, + Long: `Update a SSH key on your organization.`, Namespace: "account", Resource: "ssh-key", Verb: "update", @@ -233,8 +233,8 @@ func accountSSHKeyUpdate() *core.Command { func accountSSHKeyRemove() *core.Command { return &core.Command{ - Short: `Remove a SSH key from your Scaleway account`, - Long: `Remove a SSH key from your Scaleway account.`, + Short: `Remove a SSH key from your organization`, + Long: `Remove a SSH key from your organization.`, Namespace: "account", Resource: "ssh-key", Verb: "remove", diff --git a/internal/namespaces/baremetal/v1/baremetal_cli.go b/internal/namespaces/baremetal/v1/baremetal_cli.go index 8a2cbaf3d0..2533a5dedc 100644 --- a/internal/namespaces/baremetal/v1/baremetal_cli.go +++ b/internal/namespaces/baremetal/v1/baremetal_cli.go @@ -45,8 +45,8 @@ func baremetalRoot() *core.Command { func baremetalServer() *core.Command { return &core.Command{ - Short: `A server is a denomination of a type of instances provided by Scaleway`, - Long: `A server is a denomination of a type of instances provided by Scaleway.`, + Short: `Server management commands`, + Long: `A server is a denomination of a type of instances provided by Scaleway`, Namespace: "baremetal", Resource: "server", } @@ -54,8 +54,8 @@ func baremetalServer() *core.Command { func baremetalOs() *core.Command { return &core.Command{ - Short: `An Operating System (OS) is the underlying software installed on your server`, - Long: `An Operating System (OS) is the underlying software installed on your server.`, + Short: `Operating System (OS) management commands`, + Long: `An Operating System (OS) is the underlying software installed on your server`, Namespace: "baremetal", Resource: "os", } @@ -63,8 +63,8 @@ func baremetalOs() *core.Command { func baremetalServerList() *core.Command { return &core.Command{ - Short: `List servers`, - Long: `List all created servers.`, + Short: `List baremetal servers`, + Long: `List baremetal servers.`, Namespace: "baremetal", Resource: "server", Verb: "list", @@ -126,7 +126,7 @@ func baremetalServerList() *core.Command { func baremetalServerGet() *core.Command { return &core.Command{ - Short: `Get server`, + Short: `Get a specific baremetal server`, Long: `Get the server associated with the given ID.`, Namespace: "baremetal", Resource: "server", @@ -160,8 +160,8 @@ func baremetalServerGet() *core.Command { func baremetalServerCreate() *core.Command { return &core.Command{ - Short: `Create server`, - Long: `Create a new server. Once the server is created, you probably want to install an OS.`, + Short: `Create a baremetal server`, + Long: `Create a new baremetal server. Once the server is created, you probably want to install an OS.`, Namespace: "baremetal", Resource: "server", Verb: "create", @@ -213,7 +213,7 @@ func baremetalServerCreate() *core.Command { func baremetalServerUpdate() *core.Command { return &core.Command{ - Short: `Update server`, + Short: `Update a baremetal server`, Long: `Update the server associated with the given ID.`, Namespace: "baremetal", Resource: "server", @@ -259,7 +259,7 @@ func baremetalServerUpdate() *core.Command { func baremetalServerInstall() *core.Command { return &core.Command{ - Short: `Install server`, + Short: `Install a baremetal server`, Long: `Install an OS on the server associated with the given ID.`, Namespace: "baremetal", Resource: "server", @@ -325,7 +325,7 @@ func baremetalServerInstall() *core.Command { func baremetalServerDelete() *core.Command { return &core.Command{ - Short: `Delete server`, + Short: `Delete a baremetal server`, Long: `Delete the server associated with the given ID.`, Namespace: "baremetal", Resource: "server", @@ -359,7 +359,7 @@ func baremetalServerDelete() *core.Command { func baremetalServerReboot() *core.Command { return &core.Command{ - Short: `Reboot server`, + Short: `Reboot a baremetal server`, Long: `Reboot the server associated with the given ID, use boot param to reboot in rescue.`, Namespace: "baremetal", Resource: "server", @@ -404,7 +404,7 @@ func baremetalServerReboot() *core.Command { func baremetalServerStart() *core.Command { return &core.Command{ - Short: `Start server`, + Short: `Start a baremetal server`, Long: `Start the server associated with the given ID.`, Namespace: "baremetal", Resource: "server", @@ -438,7 +438,7 @@ func baremetalServerStart() *core.Command { func baremetalServerStop() *core.Command { return &core.Command{ - Short: `Stop server`, + Short: `Stop a baremetal server`, Long: `Stop the server associated with the given ID.`, Namespace: "baremetal", Resource: "server", @@ -472,7 +472,7 @@ func baremetalServerStop() *core.Command { func baremetalOsList() *core.Command { return &core.Command{ - Short: `List OS`, + Short: `List all available OS that can be install on a baremetal server`, Long: `List all available OS that can be install on a baremetal server.`, Namespace: "baremetal", Resource: "os", @@ -504,7 +504,7 @@ func baremetalOsList() *core.Command { func baremetalOsGet() *core.Command { return &core.Command{ - Short: `Get OS`, + Short: `Get an OS with a given ID`, Long: `Return specific OS for the given ID.`, Namespace: "baremetal", Resource: "os", @@ -513,7 +513,7 @@ func baremetalOsGet() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "os-id", - Short: `ID of the researched OS`, + Short: `ID of the OS`, Required: true, Positional: true, }, diff --git a/internal/namespaces/instance/v1/instance_cli.go b/internal/namespaces/instance/v1/instance_cli.go index 96246a59a9..9ffb4e5487 100644 --- a/internal/namespaces/instance/v1/instance_cli.go +++ b/internal/namespaces/instance/v1/instance_cli.go @@ -78,7 +78,7 @@ func instanceRoot() *core.Command { func instanceImage() *core.Command { return &core.Command{ - Short: `An image is a backup of an instance`, + Short: `Image management commands`, Long: `Images are backups of your instances. You can reuse that image to restore your data or create a series of instances with a predefined configuration. @@ -91,7 +91,7 @@ An image is a complete backup of your server including all volumes. func instanceIP() *core.Command { return &core.Command{ - Short: `A flexible IP address is an IP address which holden independently of any server`, + Short: `IP management commands`, Long: `A flexible IP address is an IP address which you hold independently of any server. You can attach it to any of your servers and do live migration of the IP address between your servers. @@ -104,7 +104,7 @@ Be aware that attaching a flexible IP address to a server will remove the previo func instancePlacementGroup() *core.Command { return &core.Command{ - Short: `A placement group allows to express a preference regarding the physical position of a group of instances`, + Short: `Placement group management commands`, Long: `Placement groups allow the user to express a preference regarding the physical position of a group of instances. It'll let the user choose to either group instances on the same physical hardware for @@ -131,7 +131,7 @@ The ` + "`" + `policy_mode` + "`" + ` is set by default to ` + "`" + `optional` func instanceSecurityGroup() *core.Command { return &core.Command{ - Short: `A security group is a set of firewall rules on a set of instances`, + Short: `Security group management commands`, Long: `A security group is a set of firewall rules on a set of instances. Security groups enable to create rules that either drop or allow incoming traffic from certain ports of your instances. @@ -145,7 +145,7 @@ As a contrary, you have to switch in a stateless mode to define explicitly allow func instanceServer() *core.Command { return &core.Command{ - Short: `A server is a denomination of a type of instances provided by Scaleway`, + Short: `Server management commands`, Long: `Server types are denomination of the different instances we provide. Scaleway offers **Virtual Cloud** and **dedicated GPU** instances. @@ -180,7 +180,7 @@ For more information, refer to [GPU Instances](https://www.scaleway.com/en/gpu-i func instanceServerType() *core.Command { return &core.Command{ - Short: `A server type is a representation of an instance type available in a given zone`, + Short: `Server type management commands`, Long: `Server types will answer with all instance types available in a given zone. Each of these types will contains all the features of the instance (CPU, RAM, Storage) with their associated pricing. `, @@ -191,7 +191,7 @@ Each of these types will contains all the features of the instance (CPU, RAM, St func instanceVolumeType() *core.Command { return &core.Command{ - Short: `A volume type is a representation of a volume type available in a given zone`, + Short: `Volume type management commands`, Long: `Volume types will answer with all volume types available in a given zone. Each of these types will contains all the capabilities and constraints of the volume (min size, max size, snapshot). `, @@ -202,7 +202,7 @@ Each of these types will contains all the capabilities and constraints of the vo func instanceSnapshot() *core.Command { return &core.Command{ - Short: `A snapshot contains the data of a specific volume at a particular point in time`, + Short: `Snapshot management commands`, Long: `Snapshots contain the data of a specific volume at a particular point in time. The data can include the instance's operating system, configuration information or files stored on the volume. @@ -222,7 +222,7 @@ snapshots will be available starting 2020. func instanceUserData() *core.Command { return &core.Command{ - Short: `User data is a key value store API you can use to provide data from and to your server without authentication`, + Short: `User data management commands`, Long: `User data is a key value store API you can use to provide data from and to your server without authentication. As an example of use, Scaleway images contain the script scw-generate-ssh-keys which generates SSH server’s host keys then stores their fingerprints as user data under the key β€œssh-host-fingerprints”. @@ -242,7 +242,7 @@ There are two endpoints to access user data: func instanceVolume() *core.Command { return &core.Command{ - Short: `A volume is used to store data inside an instance`, + Short: `Volume management commands`, Long: `A volume is where you store your data inside your instance. It appears as a block device on Linux that you can use to create a filesystem and mount it. @@ -345,8 +345,8 @@ func instanceVolumeTypeList() *core.Command { func instanceServerList() *core.Command { return &core.Command{ - Short: `List servers`, - Long: `List servers.`, + Short: `List all servers`, + Long: `List all servers.`, Namespace: "instance", Resource: "server", Verb: "list", @@ -432,7 +432,7 @@ func instanceServerList() *core.Command { func instanceServerGet() *core.Command { return &core.Command{ - Short: `Get server`, + Short: `Get a server`, Long: `Get the details of a specified Server.`, Namespace: "instance", Resource: "server", @@ -465,8 +465,8 @@ func instanceServerGet() *core.Command { func instanceServerUpdate() *core.Command { return &core.Command{ - Short: `Update server`, - Long: `Update server.`, + Short: `Update a server`, + Long: `Update a server.`, Namespace: "instance", Resource: "server", Verb: "update", @@ -761,7 +761,7 @@ func instanceUserDataGet() *core.Command { func instanceImageList() *core.Command { return &core.Command{ - Short: `List images`, + Short: `List instance images`, Long: `List all images available in an account.`, Namespace: "instance", Resource: "image", @@ -819,7 +819,7 @@ func instanceImageList() *core.Command { func instanceImageGet() *core.Command { return &core.Command{ - Short: `Get image`, + Short: `Get an instance image`, Long: `Get details of an image with the given ID.`, Namespace: "instance", Resource: "image", @@ -856,8 +856,8 @@ func instanceImageGet() *core.Command { func instanceImageCreate() *core.Command { return &core.Command{ - Short: `Create image`, - Long: `Create image.`, + Short: `Create an instance image`, + Long: `Create an instance image.`, Namespace: "instance", Resource: "image", Verb: "create", @@ -948,7 +948,7 @@ func instanceImageCreate() *core.Command { func instanceImageDelete() *core.Command { return &core.Command{ - Short: `Delete image`, + Short: `Delete an instance image`, Long: `Delete the image with the given ID.`, Namespace: "instance", Resource: "image", @@ -1037,8 +1037,8 @@ func instanceSnapshotList() *core.Command { func instanceSnapshotCreate() *core.Command { return &core.Command{ - Short: `Create snapshot`, - Long: `Create snapshot.`, + Short: `Create a snapshot from a given volume`, + Long: `Create a snapshot from a given volume.`, Namespace: "instance", Resource: "snapshot", Verb: "create", @@ -1087,7 +1087,7 @@ func instanceSnapshotCreate() *core.Command { func instanceSnapshotGet() *core.Command { return &core.Command{ - Short: `Get snapshot`, + Short: `Get a snapshot`, Long: `Get details of a snapshot with the given ID.`, Namespace: "instance", Resource: "snapshot", @@ -1124,7 +1124,7 @@ func instanceSnapshotGet() *core.Command { func instanceSnapshotDelete() *core.Command { return &core.Command{ - Short: `Delete snapshot`, + Short: `Delete a snapshot`, Long: `Delete the snapshot with the given ID.`, Namespace: "instance", Resource: "snapshot", @@ -1269,8 +1269,8 @@ func instanceVolumeList() *core.Command { func instanceVolumeCreate() *core.Command { return &core.Command{ - Short: `Create volume`, - Long: `Create volume.`, + Short: `Create a volume`, + Long: `Create a volume.`, Namespace: "instance", Resource: "volume", Verb: "create", @@ -1332,7 +1332,7 @@ func instanceVolumeCreate() *core.Command { func instanceVolumeGet() *core.Command { return &core.Command{ - Short: `Get volume`, + Short: `Get a volume`, Long: `Get details of a volume with the given ID.`, Namespace: "instance", Resource: "volume", @@ -1365,7 +1365,7 @@ func instanceVolumeGet() *core.Command { func instanceVolumeUpdate() *core.Command { return &core.Command{ - Short: `Update volume`, + Short: `Update a volume`, Long: `Replace name and/or size properties of given ID volume with the given value(s). Any volume name can be changed while, for now, only ` + "`" + `b_ssd` + "`" + ` volume growing is supported.`, Namespace: "instance", Resource: "volume", @@ -1419,7 +1419,7 @@ func instanceVolumeUpdate() *core.Command { func instanceVolumeDelete() *core.Command { return &core.Command{ - Short: `Delete volume`, + Short: `Delete a volume`, Long: `Delete the volume with the given ID.`, Namespace: "instance", Resource: "volume", @@ -1502,8 +1502,8 @@ func instanceSecurityGroupList() *core.Command { func instanceSecurityGroupCreate() *core.Command { return &core.Command{ - Short: `Create security group`, - Long: `Create security group.`, + Short: `Create a security group`, + Long: `Create a security group.`, Namespace: "instance", Resource: "security-group", Verb: "create", @@ -1590,7 +1590,7 @@ func instanceSecurityGroupCreate() *core.Command { func instanceSecurityGroupGet() *core.Command { return &core.Command{ - Short: `Get security group`, + Short: `Get a security group`, Long: `Get the details of a Security Group with the given ID.`, Namespace: "instance", Resource: "security-group", @@ -1623,8 +1623,8 @@ func instanceSecurityGroupGet() *core.Command { func instanceSecurityGroupDelete() *core.Command { return &core.Command{ - Short: `Delete security group`, - Long: `Delete security group.`, + Short: `Delete a security group`, + Long: `Delete a security group.`, Namespace: "instance", Resource: "security-group", Verb: "delete", @@ -1710,7 +1710,7 @@ func instancePlacementGroupList() *core.Command { func instancePlacementGroupCreate() *core.Command { return &core.Command{ - Short: `Create placement group`, + Short: `Create a placement group`, Long: `Create a new placement group.`, Namespace: "instance", Resource: "placement-group", @@ -1778,7 +1778,7 @@ func instancePlacementGroupCreate() *core.Command { func instancePlacementGroupGet() *core.Command { return &core.Command{ - Short: `Get placement group`, + Short: `Get a placement group`, Long: `Get the given placement group.`, Namespace: "instance", Resource: "placement-group", @@ -1811,7 +1811,7 @@ func instancePlacementGroupGet() *core.Command { func instancePlacementGroupUpdate() *core.Command { return &core.Command{ - Short: `Update placement group`, + Short: `Update a placement group`, Long: `Update one or more parameter of the given placement group.`, Namespace: "instance", Resource: "placement-group", @@ -1914,8 +1914,8 @@ func instancePlacementGroupDelete() *core.Command { func instanceIPList() *core.Command { return &core.Command{ - Short: `List IPs`, - Long: `List IPs.`, + Short: `List all flexible IPs`, + Long: `List all flexible IPs.`, Namespace: "instance", Resource: "ip", Verb: "list", @@ -1994,8 +1994,8 @@ func instanceIPList() *core.Command { func instanceIPCreate() *core.Command { return &core.Command{ - Short: `Reserve an IP`, - Long: `Reserve an IP.`, + Short: `Reserve a flexible IP`, + Long: `Reserve a flexible IP.`, Namespace: "instance", Resource: "ip", Verb: "create", @@ -2049,7 +2049,7 @@ func instanceIPCreate() *core.Command { func instanceIPGet() *core.Command { return &core.Command{ - Short: `Get IP`, + Short: `Get a flexible IP`, Long: `Get details of an IP with the given ID or address.`, Namespace: "instance", Resource: "ip", @@ -2091,8 +2091,8 @@ func instanceIPGet() *core.Command { func instanceIPUpdate() *core.Command { return &core.Command{ - Short: `Update IP`, - Long: `Update IP.`, + Short: `Update a flexible IP`, + Long: `Update a flexible IP.`, Namespace: "instance", Resource: "ip", Verb: "update", @@ -2145,7 +2145,7 @@ func instanceIPUpdate() *core.Command { func instanceIPDelete() *core.Command { return &core.Command{ - Short: `Delete IP`, + Short: `Delete a flexible IP`, Long: `Delete the IP with the given ID.`, Namespace: "instance", Resource: "ip", diff --git a/internal/namespaces/k8s/v1/k8s_cli.go b/internal/namespaces/k8s/v1/k8s_cli.go index f364e1e4a3..616c0c6196 100644 --- a/internal/namespaces/k8s/v1/k8s_cli.go +++ b/internal/namespaces/k8s/v1/k8s_cli.go @@ -48,7 +48,7 @@ func GetGeneratedCommands() *core.Commands { } func k8sRoot() *core.Command { return &core.Command{ - Short: `This API allows you to manage your Kapsule clusters`, + Short: `Kapsule API`, Long: ``, Namespace: "k8s", } @@ -56,7 +56,7 @@ func k8sRoot() *core.Command { func k8sCluster() *core.Command { return &core.Command{ - Short: `A cluster is a Kubernetes Kapsule cluster`, + Short: `Kapsule cluster management commands`, Long: `A cluster is a fully managed Kubernetes cluster. It is composed of different pools, each pool containing the same kind of nodes. @@ -68,7 +68,7 @@ It is composed of different pools, each pool containing the same kind of nodes. func k8sPool() *core.Command { return &core.Command{ - Short: `A pool is a virtual group of nodes in a cluster`, + Short: `Kapsule pool management commands`, Long: `A pool is a set of identical Nodes. A pool has a name, a size (its current number of nodes), nodes number limits (min, max) and a Scaleway instance type. Changing those limits increases/decreases the size of a pool. Thus, when autoscaling is enabled, the pool will grow or shrink inside those limits, depending on its load. A "default pool" is automatically created with every cluster. @@ -80,7 +80,7 @@ A "default pool" is automatically created with every cluster. func k8sNode() *core.Command { return &core.Command{ - Short: `A node is the representation of a Scaleway instance in a cluster`, + Short: `Kapsule node management commands`, Long: `A node (short for worker node) is an abstraction for a Scaleway Instance. It is part of a pool and is instantiated by Scaleway, making Kubernetes software installed and configured automatically on it. Please note that Kubernetes nodes cannot be accessed with ssh. @@ -92,7 +92,7 @@ Please note that Kubernetes nodes cannot be accessed with ssh. func k8sVersion() *core.Command { return &core.Command{ - Short: `A version is a Kubernetes version`, + Short: `Available Kubernetes version commands`, Long: `A version is a vanilla Kubernetes version like ` + "`" + `x.y.z` + "`" + `. It is composed of a major version x, a minor version y and a patch version z. Scaleway's managed Kubernetes, Kapsule, will at least support the last patch version for the last three minor release. diff --git a/internal/namespaces/marketplace/v1/marketplace_cli.go b/internal/namespaces/marketplace/v1/marketplace_cli.go index ef9294f19f..ddeab10d9b 100644 --- a/internal/namespaces/marketplace/v1/marketplace_cli.go +++ b/internal/namespaces/marketplace/v1/marketplace_cli.go @@ -35,8 +35,8 @@ func marketplaceRoot() *core.Command { func marketplaceImage() *core.Command { return &core.Command{ - Short: `Marketplace images can be used when creating an instance`, - Long: `Marketplace images can be used when creating an instance.`, + Short: `Marketplace images management commands`, + Long: `Marketplace images management commands.`, Namespace: "marketplace", Resource: "image", } diff --git a/internal/namespaces/rdb/v1/rdb_cli.go b/internal/namespaces/rdb/v1/rdb_cli.go index 61b00b322f..e9d423d788 100644 --- a/internal/namespaces/rdb/v1/rdb_cli.go +++ b/internal/namespaces/rdb/v1/rdb_cli.go @@ -77,8 +77,7 @@ func rdbRoot() *core.Command { func rdbBackup() *core.Command { return &core.Command{ - Short: `Backups are extracted data of your database at a given time -`, + Short: `Backup management commands`, Long: `Save and restore backups of your database instance. `, Namespace: "rdb", @@ -88,8 +87,7 @@ func rdbBackup() *core.Command { func rdbEngine() *core.Command { return &core.Command{ - Short: `Software that stores and retrieves data from a database -`, + Short: `Database engines commands`, Long: `Software that stores and retrieves data from a database. Each database engine has a name and versions. `, Namespace: "rdb", @@ -99,8 +97,7 @@ func rdbEngine() *core.Command { func rdbInstance() *core.Command { return &core.Command{ - Short: `A Database Instance is composed of one or more Nodes, depending of the is_ha_cluster setting -`, + Short: `Instance management commands`, Long: `A Database Instance is composed of one or more Nodes, depending of the is_ha_cluster setting. Autohealing is enabled by default for HA clusters. Database automated backup is enabled by default in order to prevent data loss. `, Namespace: "rdb", @@ -110,9 +107,8 @@ func rdbInstance() *core.Command { func rdbACL() *core.Command { return &core.Command{ - Short: `Network Access Control List allows to control network in and out traffic by setting up ACL rules -`, - Long: `Network Access Control List allows to control network in and out traffic by setting up ACL rules. ACL rules could be created, edited, deleted + Short: `Access Control List (ACL) management commands`, + Long: `Network Access Control List allows to control network in and out traffic by setting up ACL rules. `, Namespace: "rdb", Resource: "acl", @@ -121,8 +117,7 @@ func rdbACL() *core.Command { func rdbSettings() *core.Command { return &core.Command{ - Short: `Instance Settings are tunables of Database Engines -`, + Short: `Settings management commands`, Long: `Instance Settings are tunables of Database Engines. Available settings depend on the database engine and its version. `, Namespace: "rdb", @@ -132,8 +127,7 @@ func rdbSettings() *core.Command { func rdbPrivilege() *core.Command { return &core.Command{ - Short: `Define some privileges to a user on a specific database -`, + Short: `User privileges management commands`, Long: `Define some privileges to a user on a specific database. `, Namespace: "rdb", @@ -143,8 +137,7 @@ func rdbPrivilege() *core.Command { func rdbUser() *core.Command { return &core.Command{ - Short: `Manage users on your instance -`, + Short: `User management commands`, Long: `Manage users on your instance `, Namespace: "rdb", @@ -154,8 +147,7 @@ func rdbUser() *core.Command { func rdbDatabase() *core.Command { return &core.Command{ - Short: `Manage logical databases on your instance -`, + Short: `Database management commands`, Long: `Manage logical databases on your instance `, Namespace: "rdb", @@ -165,8 +157,7 @@ func rdbDatabase() *core.Command { func rdbNodeType() *core.Command { return &core.Command{ - Short: `Node types powering your instance -`, + Short: `Node types management commands`, Long: `Node types powering your instance `, Namespace: "rdb", @@ -176,8 +167,8 @@ func rdbNodeType() *core.Command { func rdbLog() *core.Command { return &core.Command{ - Short: `Logs generated by your instance`, - Long: `Logs generated by your instance.`, + Short: `Instance logs management commands`, + Long: `Instance logs management commands.`, Namespace: "rdb", Resource: "log", } @@ -185,8 +176,8 @@ func rdbLog() *core.Command { func rdbCertificate() *core.Command { return &core.Command{ - Short: `TLS certificate used by your instance`, - Long: `TLS certificate used by your instance.`, + Short: `Instance TLS certificate management commands`, + Long: `Instance TLS certificate management commands.`, Namespace: "rdb", Resource: "certificate", } diff --git a/internal/namespaces/registry/v1/registry_cli.go b/internal/namespaces/registry/v1/registry_cli.go index 5af2b59849..bd9068e4c9 100644 --- a/internal/namespaces/registry/v1/registry_cli.go +++ b/internal/namespaces/registry/v1/registry_cli.go @@ -39,7 +39,7 @@ func GetGeneratedCommands() *core.Commands { } func registryRoot() *core.Command { return &core.Command{ - Short: `Docker registry API`, + Short: `Container registry API`, Long: ``, Namespace: "registry", } @@ -47,8 +47,9 @@ func registryRoot() *core.Command { func registryNamespace() *core.Command { return &core.Command{ - Short: `A namespace is for images what a folder is for files`, - Long: ` + Short: `Namespace management commands`, + Long: `A namespace is for images what a folder is for files + To use our services, the first step is to create a namespace. A namespace is for images what a folder is for files. Every push or pull must mention the namespace : @@ -65,8 +66,8 @@ A namespace can be either public or private (default), which determines who can func registryImage() *core.Command { return &core.Command{ - Short: `An image represents a container image`, - Long: `An image represents a docker image. + Short: `Image management commands`, + Long: `An image represents a container image. The visibility of an image can be public (everyone can pull it), private (only your organization can pull it) or inherit from the namespace visibility (default) It can be changed with an update on the image via the registry API. @@ -78,8 +79,8 @@ It can be changed with an update on the image via the registry API. func registryTag() *core.Command { return &core.Command{ - Short: `A tag represents a container tag of an image`, - Long: `A tag represents a docker tag of an image. + Short: `Tag management commands`, + Long: `A tag represents a container tag of an image. `, Namespace: "registry", Resource: "tag",