From 0aad63e714a2ecc3f414662a9e2453f2118da3f9 Mon Sep 17 00:00:00 2001 From: Scaleway Bot Date: Thu, 11 Jan 2024 17:19:45 +0100 Subject: [PATCH] docs(cockpit): rework wording (#3590) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: LeΓ―la MARABESE --- ...l-usage-cockpit-alert-disable-usage.golden | 2 +- ...ll-usage-cockpit-alert-enable-usage.golden | 2 +- ...-all-usage-cockpit-alert-test-usage.golden | 2 +- .../test-all-usage-cockpit-alert-usage.golden | 6 +- ...sage-cockpit-cockpit-activate-usage.golden | 2 +- ...ge-cockpit-cockpit-deactivate-usage.golden | 2 +- ...all-usage-cockpit-cockpit-get-usage.golden | 2 +- ...est-all-usage-cockpit-cockpit-usage.golden | 6 +- ...-usage-cockpit-contact-create-usage.golden | 2 +- ...-usage-cockpit-contact-delete-usage.golden | 2 +- ...ll-usage-cockpit-contact-list-usage.golden | 2 +- ...est-all-usage-cockpit-contact-usage.golden | 6 +- ...e-cockpit-grafana-user-create-usage.golden | 2 +- ...e-cockpit-grafana-user-delete-usage.golden | 2 +- ...age-cockpit-grafana-user-list-usage.golden | 2 +- ...t-grafana-user-reset-password-usage.golden | 2 +- ...ll-usage-cockpit-grafana-user-usage.golden | 8 +- ...ll-usage-cockpit-token-create-usage.golden | 2 +- ...ll-usage-cockpit-token-delete-usage.golden | 2 +- ...t-all-usage-cockpit-token-get-usage.golden | 2 +- ...-all-usage-cockpit-token-list-usage.golden | 2 +- .../test-all-usage-cockpit-token-usage.golden | 8 +- ...-jobs-definition-start-usage.cassette.yaml | 37 +++++++ ...all-usage-jobs-run-get-usage.cassette.yaml | 37 +++++++ docs/commands/cockpit.md | 102 +++++++++--------- go.mod | 2 +- go.sum | 4 +- .../namespaces/cockpit/v1beta1/cockpit_cli.go | 68 ++++++------ 28 files changed, 196 insertions(+), 122 deletions(-) create mode 100644 cmd/scw/testdata/test-all-usage-jobs-definition-start-usage.cassette.yaml create mode 100644 cmd/scw/testdata/test-all-usage-jobs-run-get-usage.cassette.yaml diff --git a/cmd/scw/testdata/test-all-usage-cockpit-alert-disable-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-alert-disable-usage.golden index d7c033425d..035846e2fa 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-alert-disable-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-alert-disable-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Disable the sending of managed alerts for the specified Project's Cockpit. +Disable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to. USAGE: scw cockpit alert disable [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-alert-enable-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-alert-enable-usage.golden index 5af63f6912..da4babb924 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-alert-enable-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-alert-enable-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Enable the sending of managed alerts for the specified Project's Cockpit. +Enable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to. USAGE: scw cockpit alert enable [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-alert-test-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-alert-test-usage.golden index 4f0e3af27b..a8f837f109 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-alert-test-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-alert-test-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Trigger a test alert to all of the Cockpit's receivers. +Send a test alert to make sure your contact points get notified when an actual alert is triggered. USAGE: scw cockpit alert test [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-alert-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-alert-usage.golden index 7f553a8881..ef26b32918 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-alert-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-alert-usage.golden @@ -6,9 +6,9 @@ USAGE: scw cockpit alert AVAILABLE COMMANDS: - disable Disable the sending of managed alerts for the specified Project's Cockpit - enable Enable the sending of managed alerts for the specified Project's Cockpit - test Trigger a test alert to all of the Cockpit's receivers + disable Disable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to + enable Enable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to + test Send a test alert to make sure your contact points get notified when an actual alert is triggered FLAGS: -h, --help help for alert diff --git a/cmd/scw/testdata/test-all-usage-cockpit-cockpit-activate-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-cockpit-activate-usage.golden index 6b0dacb327..ccb8f11ceb 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-cockpit-activate-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-cockpit-activate-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Activate the Cockpit of the specified Project ID. +Activate the Cockpit of a given Project specified by the Project ID. USAGE: scw cockpit cockpit activate [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-cockpit-deactivate-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-cockpit-deactivate-usage.golden index 8876eb8a75..870b40d79c 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-cockpit-deactivate-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-cockpit-deactivate-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Deactivate the Cockpit of the specified Project ID. +Deactivate the Cockpit of a given Project specified by the Project ID. USAGE: scw cockpit cockpit deactivate [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-cockpit-get-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-cockpit-get-usage.golden index 03e2996249..f594812d1e 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-cockpit-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-cockpit-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Retrieve the Cockpit of the specified Project ID. +Retrieve the Cockpit of a given Project specified by the Project ID. USAGE: scw cockpit cockpit get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-cockpit-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-cockpit-usage.golden index 72e0a44af6..389faeb643 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-cockpit-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-cockpit-usage.golden @@ -6,9 +6,9 @@ USAGE: scw cockpit cockpit AVAILABLE COMMANDS: - activate Activate the Cockpit of the specified Project ID - deactivate Deactivate the Cockpit of the specified Project ID - get Retrieve the Cockpit of the specified Project ID + activate Activate the Cockpit of a given Project specified by the Project ID + deactivate Deactivate the Cockpit of a given Project specified by the Project ID + get Retrieve the Cockpit of a given Project specified by the Project ID WORKFLOW COMMANDS: wait Wait for a cockpit to reach a stable state (installation) diff --git a/cmd/scw/testdata/test-all-usage-cockpit-contact-create-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-contact-create-usage.golden index dc26a8c76a..399be720f4 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-contact-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-contact-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a contact point to receive alerts for the default receiver. +Create a contact point associated with the default receiver, to receive alerts. USAGE: scw cockpit contact create [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-contact-delete-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-contact-delete-usage.golden index 09febb4b42..fa7703118f 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-contact-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-contact-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a contact point for the default receiver. +Delete a contact point associated with the default receiver. USAGE: scw cockpit contact delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-contact-list-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-contact-list-usage.golden index 6b8e9b2373..53022702d8 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-contact-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-contact-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a list of contact points for the Cockpit associated with the specified Project ID. +Get a list of contact points created for a given Cockpit, specified by the ID of the Project the Cockpit belongs to. USAGE: scw cockpit contact list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-contact-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-contact-usage.golden index 21afd94acd..6928f7b4ea 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-contact-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-contact-usage.golden @@ -6,9 +6,9 @@ USAGE: scw cockpit contact AVAILABLE COMMANDS: - create Create a contact point to receive alerts for the default receiver - delete Delete a contact point for the default receiver - list Get a list of contact points for the Cockpit associated with the specified Project ID + create Create a contact point associated with the default receiver, to receive alerts + delete Delete a contact point associated with the default receiver + list Get a list of contact points created for a given Cockpit, specified by the ID of the Project the Cockpit belongs to FLAGS: -h, --help help for contact diff --git a/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-create-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-create-usage.golden index 74de80e844..6a859ea6e4 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a Grafana user for your Cockpit's Grafana instance. Make sure you save the automatically-generated password and the Grafana user ID. +Create a Grafana user for your Cockpit's Grafana. Make sure you save the automatically-generated password and the Grafana user ID. USAGE: scw cockpit grafana-user create [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-delete-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-delete-usage.golden index 69cc8aaea3..c1df30158c 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a Grafana user from a Grafana instance, specified by the Cockpit's Project ID and the Grafana user ID. +Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user. USAGE: scw cockpit grafana-user delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-list-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-list-usage.golden index 9ea10b485b..4ff4274a72 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a list of Grafana users who are able to connect to the Cockpit's Grafana instance. +Get a list of all Grafana users created in your Cockpit's Grafana. USAGE: scw cockpit grafana-user list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-reset-password-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-reset-password-usage.golden index 60d6c20561..7bbf9f0a0e 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-reset-password-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-reset-password-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Reset a Grafana user's password specified by the Cockpit's Project ID and the Grafana user ID. +Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user. USAGE: scw cockpit grafana-user reset-password [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-usage.golden index 0d9232112f..00a06604e9 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-grafana-user-usage.golden @@ -6,10 +6,10 @@ USAGE: scw cockpit grafana-user AVAILABLE COMMANDS: - create Create a Grafana user for your Cockpit's Grafana instance. Make sure you save the automatically-generated password and the Grafana user ID - delete Delete a Grafana user from a Grafana instance, specified by the Cockpit's Project ID and the Grafana user ID - list Get a list of Grafana users who are able to connect to the Cockpit's Grafana instance - reset-password Reset a Grafana user's password specified by the Cockpit's Project ID and the Grafana user ID + create Create a Grafana user for your Cockpit's Grafana. Make sure you save the automatically-generated password and the Grafana user ID + delete Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user + list Get a list of all Grafana users created in your Cockpit's Grafana + reset-password Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user FLAGS: -h, --help help for grafana-user diff --git a/cmd/scw/testdata/test-all-usage-cockpit-token-create-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-token-create-usage.golden index 944d8e74ef..ffea92c587 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-token-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-token-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a token associated with the specified Project ID. +Create a token in a given Project specified by the Project ID. USAGE: scw cockpit token create [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-token-delete-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-token-delete-usage.golden index b3e451ad5c..d7a0de47c2 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-token-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-token-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete the token associated with the specified token ID. +Delete a given token specified by the token ID. USAGE: scw cockpit token delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-token-get-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-token-get-usage.golden index 5d79860134..05a69566f0 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-token-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-token-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Retrieve the token associated with the specified token ID. +Retrieve a given token specified by the token ID. USAGE: scw cockpit token get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-token-list-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-token-list-usage.golden index a31a95c55a..ce11285840 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-token-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-token-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a list of tokens associated with the specified Project ID. +Get a list of tokens in a given Project specified by the Project ID. USAGE: scw cockpit token list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-token-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-token-usage.golden index fc9137424c..8635cbd776 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-token-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-token-usage.golden @@ -6,10 +6,10 @@ USAGE: scw cockpit token AVAILABLE COMMANDS: - create Create a token associated with the specified Project ID - delete Delete the token associated with the specified token ID - get Retrieve the token associated with the specified token ID - list Get a list of tokens associated with the specified Project ID + create Create a token in a given Project specified by the Project ID + delete Delete a given token specified by the token ID + get Retrieve a given token specified by the token ID + list Get a list of tokens in a given Project specified by the Project ID FLAGS: -h, --help help for token diff --git a/cmd/scw/testdata/test-all-usage-jobs-definition-start-usage.cassette.yaml b/cmd/scw/testdata/test-all-usage-jobs-definition-start-usage.cassette.yaml new file mode 100644 index 0000000000..73fc84c412 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-jobs-definition-start-usage.cassette.yaml @@ -0,0 +1,37 @@ +--- +version: 1 +interactions: +- request: + body: '{"access_key":"SCWHJNSK2028RFV4SE6K","secret_key":null,"description":"lmarabese + IAM API key","created_at":"2023-02-07T12:50:30.653520Z","updated_at":"2023-02-07T12:50:30.653520Z","expires_at":null,"default_project_id":"fa1e3217-dc80-42ac-85c3-3f034b78b552","editable":true,"creation_ip":"51.159.46.153","user_id":"77e7fa85-f305-4ea2-afea-09571a039336"}' + form: {} + headers: + User-Agent: + - scaleway-sdk-go/v1.0.0-beta.7+dev (go1.21.6; linux; amd64) cli-e2e-test + url: https://api.scaleway.com/iam/v1alpha1/api-keys/SCWXXXXXXXXXXXXXXXXX + method: GET + response: + body: '{"access_key":"SCWHJNSK2028RFV4SE6K","secret_key":null,"description":"lmarabese + IAM API key","created_at":"2023-02-07T12:50:30.653520Z","updated_at":"2023-02-07T12:50:30.653520Z","expires_at":null,"default_project_id":"fa1e3217-dc80-42ac-85c3-3f034b78b552","editable":true,"creation_ip":"51.159.46.153","user_id":"77e7fa85-f305-4ea2-afea-09571a039336"}' + headers: + Content-Length: + - "352" + Content-Security-Policy: + - default-src 'none'; frame-ancestors 'none' + Content-Type: + - application/json + Date: + - Thu, 11 Jan 2024 16:07:21 GMT + Server: + - Scaleway API-Gateway + Strict-Transport-Security: + - max-age=63072000 + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - DENY + X-Request-Id: + - e89d9b60-76dc-4821-b7ac-c58b88b6c0b2 + status: 200 OK + code: 200 + duration: "" diff --git a/cmd/scw/testdata/test-all-usage-jobs-run-get-usage.cassette.yaml b/cmd/scw/testdata/test-all-usage-jobs-run-get-usage.cassette.yaml new file mode 100644 index 0000000000..18124e249f --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-jobs-run-get-usage.cassette.yaml @@ -0,0 +1,37 @@ +--- +version: 1 +interactions: +- request: + body: '{"access_key":"SCWHJNSK2028RFV4SE6K","secret_key":null,"description":"lmarabese + IAM API key","created_at":"2023-02-07T12:50:30.653520Z","updated_at":"2023-02-07T12:50:30.653520Z","expires_at":null,"default_project_id":"fa1e3217-dc80-42ac-85c3-3f034b78b552","editable":true,"creation_ip":"51.159.46.153","user_id":"77e7fa85-f305-4ea2-afea-09571a039336"}' + form: {} + headers: + User-Agent: + - scaleway-sdk-go/v1.0.0-beta.7+dev (go1.21.6; linux; amd64) cli-e2e-test + url: https://api.scaleway.com/iam/v1alpha1/api-keys/SCWXXXXXXXXXXXXXXXXX + method: GET + response: + body: '{"access_key":"SCWHJNSK2028RFV4SE6K","secret_key":null,"description":"lmarabese + IAM API key","created_at":"2023-02-07T12:50:30.653520Z","updated_at":"2023-02-07T12:50:30.653520Z","expires_at":null,"default_project_id":"fa1e3217-dc80-42ac-85c3-3f034b78b552","editable":true,"creation_ip":"51.159.46.153","user_id":"77e7fa85-f305-4ea2-afea-09571a039336"}' + headers: + Content-Length: + - "352" + Content-Security-Policy: + - default-src 'none'; frame-ancestors 'none' + Content-Type: + - application/json + Date: + - Thu, 11 Jan 2024 16:07:21 GMT + Server: + - Scaleway API-Gateway + Strict-Transport-Security: + - max-age=63072000 + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - DENY + X-Request-Id: + - ef5df827-b60d-42a6-a815-dd89bf6df4b6 + status: 200 OK + code: 200 + duration: "" diff --git a/docs/commands/cockpit.md b/docs/commands/cockpit.md index 265c4838b7..cb13030112 100644 --- a/docs/commands/cockpit.md +++ b/docs/commands/cockpit.md @@ -3,33 +3,33 @@ Cockpit API. - [Managed alerts management commands](#managed-alerts-management-commands) - - [Disable the sending of managed alerts for the specified Project's Cockpit](#disable-the-sending-of-managed-alerts-for-the-specified-project's-cockpit) - - [Enable the sending of managed alerts for the specified Project's Cockpit](#enable-the-sending-of-managed-alerts-for-the-specified-project's-cockpit) - - [Trigger a test alert to all of the Cockpit's receivers](#trigger-a-test-alert-to-all-of-the-cockpit's-receivers) + - [Disable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to](#disable-the-sending-of-managed-alerts-for-a-given-cockpit,-specified-by-the-id-of-the-project-the-cockpit-belongs-to) + - [Enable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to](#enable-the-sending-of-managed-alerts-for-a-given-cockpit,-specified-by-the-id-of-the-project-the-cockpit-belongs-to) + - [Send a test alert to make sure your contact points get notified when an actual alert is triggered](#send-a-test-alert-to-make-sure-your-contact-points-get-notified-when-an-actual-alert-is-triggered) - [Cockpit management commands](#cockpit-management-commands) - - [Activate the Cockpit of the specified Project ID](#activate-the-cockpit-of-the-specified-project-id) - - [Deactivate the Cockpit of the specified Project ID](#deactivate-the-cockpit-of-the-specified-project-id) - - [Retrieve the Cockpit of the specified Project ID](#retrieve-the-cockpit-of-the-specified-project-id) + - [Activate the Cockpit of a given Project specified by the Project ID](#activate-the-cockpit-of-a-given-project-specified-by-the-project-id) + - [Deactivate the Cockpit of a given Project specified by the Project ID](#deactivate-the-cockpit-of-a-given-project-specified-by-the-project-id) + - [Retrieve the Cockpit of a given Project specified by the Project ID](#retrieve-the-cockpit-of-a-given-project-specified-by-the-project-id) - [Wait for a cockpit to reach a stable state (installation)](#wait-for-a-cockpit-to-reach-a-stable-state-(installation)) - [Contacts management commands](#contacts-management-commands) - - [Create a contact point to receive alerts for the default receiver](#create-a-contact-point-to-receive-alerts-for-the-default-receiver) - - [Delete a contact point for the default receiver](#delete-a-contact-point-for-the-default-receiver) - - [Get a list of contact points for the Cockpit associated with the specified Project ID](#get-a-list-of-contact-points-for-the-cockpit-associated-with-the-specified-project-id) + - [Create a contact point associated with the default receiver, to receive alerts](#create-a-contact-point-associated-with-the-default-receiver,-to-receive-alerts) + - [Delete a contact point associated with the default receiver](#delete-a-contact-point-associated-with-the-default-receiver) + - [Get a list of contact points created for a given Cockpit, specified by the ID of the Project the Cockpit belongs to](#get-a-list-of-contact-points-created-for-a-given-cockpit,-specified-by-the-id-of-the-project-the-cockpit-belongs-to) - [Datasource management commands](#datasource-management-commands) - [Grafana user management commands](#grafana-user-management-commands) - - [Create a Grafana user for your Cockpit's Grafana instance. Make sure you save the automatically-generated password and the Grafana user ID](#create-a-grafana-user-for-your-cockpit's-grafana-instance.-make-sure-you-save-the-automatically-generated-password-and-the-grafana-user-id) - - [Delete a Grafana user from a Grafana instance, specified by the Cockpit's Project ID and the Grafana user ID](#delete-a-grafana-user-from-a-grafana-instance,-specified-by-the-cockpit's-project-id-and-the-grafana-user-id) - - [Get a list of Grafana users who are able to connect to the Cockpit's Grafana instance](#get-a-list-of-grafana-users-who-are-able-to-connect-to-the-cockpit's-grafana-instance) - - [Reset a Grafana user's password specified by the Cockpit's Project ID and the Grafana user ID](#reset-a-grafana-user's-password-specified-by-the-cockpit's-project-id-and-the-grafana-user-id) + - [Create a Grafana user for your Cockpit's Grafana. Make sure you save the automatically-generated password and the Grafana user ID](#create-a-grafana-user-for-your-cockpit's-grafana.-make-sure-you-save-the-automatically-generated-password-and-the-grafana-user-id) + - [Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user](#delete-a-grafana-user-from-your-cockpit's-grafana,-specified-by-the-id-of-the-project-the-cockpit-belongs-to,-and-the-id-of-the-grafana-user) + - [Get a list of all Grafana users created in your Cockpit's Grafana](#get-a-list-of-all-grafana-users-created-in-your-cockpit's-grafana) + - [Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user](#reset-the-password-of-a-grafana-user,-specified-by-the-id-of-the-project-the-cockpit-belongs-to,-and-the-id-of-the-grafana-user) - [Pricing plans management commands](#pricing-plans-management-commands) - [Get a list of all pricing plans available](#get-a-list-of-all-pricing-plans-available) - [Select your chosen pricing plan for your Cockpit, specifying the Cockpit's Project ID and the pricing plan's ID in the request](#select-your-chosen-pricing-plan-for-your-cockpit,-specifying-the-cockpit's-project-id-and-the-pricing-plan's-id-in-the-request) - [Product dashboards management commands](#product-dashboards-management-commands) - [Token management commands](#token-management-commands) - - [Create a token associated with the specified Project ID](#create-a-token-associated-with-the-specified-project-id) - - [Delete the token associated with the specified token ID](#delete-the-token-associated-with-the-specified-token-id) - - [Retrieve the token associated with the specified token ID](#retrieve-the-token-associated-with-the-specified-token-id) - - [Get a list of tokens associated with the specified Project ID](#get-a-list-of-tokens-associated-with-the-specified-project-id) + - [Create a token in a given Project specified by the Project ID](#create-a-token-in-a-given-project-specified-by-the-project-id) + - [Delete a given token specified by the token ID](#delete-a-given-token-specified-by-the-token-id) + - [Retrieve a given token specified by the token ID](#retrieve-a-given-token-specified-by-the-token-id) + - [Get a list of tokens in a given Project specified by the Project ID](#get-a-list-of-tokens-in-a-given-project-specified-by-the-project-id) ## Managed alerts management commands @@ -37,9 +37,9 @@ Cockpit API. Managed alerts management commands. -### Disable the sending of managed alerts for the specified Project's Cockpit +### Disable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to -Disable the sending of managed alerts for the specified Project's Cockpit. +Disable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to. **Usage:** @@ -56,9 +56,9 @@ scw cockpit alert disable [arg=value ...] -### Enable the sending of managed alerts for the specified Project's Cockpit +### Enable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to -Enable the sending of managed alerts for the specified Project's Cockpit. +Enable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to. **Usage:** @@ -75,9 +75,9 @@ scw cockpit alert enable [arg=value ...] -### Trigger a test alert to all of the Cockpit's receivers +### Send a test alert to make sure your contact points get notified when an actual alert is triggered -Trigger a test alert to all of the Cockpit's receivers. +Send a test alert to make sure your contact points get notified when an actual alert is triggered. **Usage:** @@ -99,9 +99,9 @@ scw cockpit alert test [arg=value ...] Cockpit management commands. -### Activate the Cockpit of the specified Project ID +### Activate the Cockpit of a given Project specified by the Project ID -Activate the Cockpit of the specified Project ID. +Activate the Cockpit of a given Project specified by the Project ID. **Usage:** @@ -118,9 +118,9 @@ scw cockpit cockpit activate [arg=value ...] -### Deactivate the Cockpit of the specified Project ID +### Deactivate the Cockpit of a given Project specified by the Project ID -Deactivate the Cockpit of the specified Project ID. +Deactivate the Cockpit of a given Project specified by the Project ID. **Usage:** @@ -137,9 +137,9 @@ scw cockpit cockpit deactivate [arg=value ...] -### Retrieve the Cockpit of the specified Project ID +### Retrieve the Cockpit of a given Project specified by the Project ID -Retrieve the Cockpit of the specified Project ID. +Retrieve the Cockpit of a given Project specified by the Project ID. **Usage:** @@ -191,9 +191,9 @@ scw cockpit cockpit wait 11111111-1111-1111-1111-111111111111 Contacts management commands. -### Create a contact point to receive alerts for the default receiver +### Create a contact point associated with the default receiver, to receive alerts -Create a contact point to receive alerts for the default receiver. +Create a contact point associated with the default receiver, to receive alerts. **Usage:** @@ -211,9 +211,9 @@ scw cockpit contact create [arg=value ...] -### Delete a contact point for the default receiver +### Delete a contact point associated with the default receiver -Delete a contact point for the default receiver. +Delete a contact point associated with the default receiver. **Usage:** @@ -231,9 +231,9 @@ scw cockpit contact delete [arg=value ...] -### Get a list of contact points for the Cockpit associated with the specified Project ID +### Get a list of contact points created for a given Cockpit, specified by the ID of the Project the Cockpit belongs to -Get a list of contact points for the Cockpit associated with the specified Project ID. +Get a list of contact points created for a given Cockpit, specified by the ID of the Project the Cockpit belongs to. **Usage:** @@ -269,9 +269,9 @@ scw cockpit datasource Grafana user management commands. -### Create a Grafana user for your Cockpit's Grafana instance. Make sure you save the automatically-generated password and the Grafana user ID +### Create a Grafana user for your Cockpit's Grafana. Make sure you save the automatically-generated password and the Grafana user ID -Create a Grafana user for your Cockpit's Grafana instance. Make sure you save the automatically-generated password and the Grafana user ID. +Create a Grafana user for your Cockpit's Grafana. Make sure you save the automatically-generated password and the Grafana user ID. **Usage:** @@ -290,9 +290,9 @@ scw cockpit grafana-user create [arg=value ...] -### Delete a Grafana user from a Grafana instance, specified by the Cockpit's Project ID and the Grafana user ID +### Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user -Delete a Grafana user from a Grafana instance, specified by the Cockpit's Project ID and the Grafana user ID. +Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user. **Usage:** @@ -310,9 +310,9 @@ scw cockpit grafana-user delete [arg=value ...] -### Get a list of Grafana users who are able to connect to the Cockpit's Grafana instance +### Get a list of all Grafana users created in your Cockpit's Grafana -Get a list of Grafana users who are able to connect to the Cockpit's Grafana instance. +Get a list of all Grafana users created in your Cockpit's Grafana. **Usage:** @@ -330,9 +330,9 @@ scw cockpit grafana-user list [arg=value ...] -### Reset a Grafana user's password specified by the Cockpit's Project ID and the Grafana user ID +### Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user -Reset a Grafana user's password specified by the Cockpit's Project ID and the Grafana user ID. +Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user. **Usage:** @@ -413,9 +413,9 @@ scw cockpit product-dashboards Token management commands. -### Create a token associated with the specified Project ID +### Create a token in a given Project specified by the Project ID -Create a token associated with the specified Project ID. +Create a token in a given Project specified by the Project ID. **Usage:** @@ -442,9 +442,9 @@ scw cockpit token create [arg=value ...] -### Delete the token associated with the specified token ID +### Delete a given token specified by the token ID -Delete the token associated with the specified token ID. +Delete a given token specified by the token ID. **Usage:** @@ -461,9 +461,9 @@ scw cockpit token delete [arg=value ...] -### Retrieve the token associated with the specified token ID +### Retrieve a given token specified by the token ID -Retrieve the token associated with the specified token ID. +Retrieve a given token specified by the token ID. **Usage:** @@ -480,9 +480,9 @@ scw cockpit token get [arg=value ...] -### Get a list of tokens associated with the specified Project ID +### Get a list of tokens in a given Project specified by the Project ID -Get a list of tokens associated with the specified Project ID. +Get a list of tokens in a given Project specified by the Project ID. **Usage:** diff --git a/go.mod b/go.mod index 3f8f309c6c..ee96710cc8 100644 --- a/go.mod +++ b/go.mod @@ -24,7 +24,7 @@ require ( github.com/moby/buildkit v0.11.6 github.com/opencontainers/go-digest v1.0.0 github.com/pkg/errors v0.9.1 - github.com/scaleway/scaleway-sdk-go v1.0.0-beta.22.0.20240110152434-2ad226218920 + github.com/scaleway/scaleway-sdk-go v1.0.0-beta.22.0.20240110172941-b5715e645681 github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966 github.com/spf13/cobra v1.8.0 github.com/spf13/pflag v1.0.5 diff --git a/go.sum b/go.sum index 10098846ba..621483e908 100644 --- a/go.sum +++ b/go.sum @@ -387,8 +387,8 @@ github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDN github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI= github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs= -github.com/scaleway/scaleway-sdk-go v1.0.0-beta.22.0.20240110152434-2ad226218920 h1:08EifjxmLwsnBAlf8hoHDxbXyIqHeFr3NGM3C0eC3mw= -github.com/scaleway/scaleway-sdk-go v1.0.0-beta.22.0.20240110152434-2ad226218920/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg= +github.com/scaleway/scaleway-sdk-go v1.0.0-beta.22.0.20240110172941-b5715e645681 h1:UnOBITvoa/BU18lDVmO+B6Iu2VFm6QvsdaGcQ0QmZCU= +github.com/scaleway/scaleway-sdk-go v1.0.0-beta.22.0.20240110172941-b5715e645681/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg= github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8= github.com/secure-systems-lab/go-securesystemslib v0.4.0 h1:b23VGrQhTA8cN2CbBw7/FulN9fTtqYUdS5+Oxzt+DUE= github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo= diff --git a/internal/namespaces/cockpit/v1beta1/cockpit_cli.go b/internal/namespaces/cockpit/v1beta1/cockpit_cli.go index 04a1cf589c..e7dbcdbad1 100644 --- a/internal/namespaces/cockpit/v1beta1/cockpit_cli.go +++ b/internal/namespaces/cockpit/v1beta1/cockpit_cli.go @@ -131,8 +131,8 @@ func cockpitProductDashboards() *core.Command { func cockpitCockpitActivate() *core.Command { return &core.Command{ - Short: `Activate the Cockpit of the specified Project ID`, - Long: `Activate the Cockpit of the specified Project ID.`, + Short: `Activate the Cockpit of a given Project specified by the Project ID`, + Long: `Activate the Cockpit of a given Project specified by the Project ID.`, Namespace: "cockpit", Resource: "cockpit", Verb: "activate", @@ -154,8 +154,8 @@ func cockpitCockpitActivate() *core.Command { func cockpitCockpitGet() *core.Command { return &core.Command{ - Short: `Retrieve the Cockpit of the specified Project ID`, - Long: `Retrieve the Cockpit of the specified Project ID.`, + Short: `Retrieve the Cockpit of a given Project specified by the Project ID`, + Long: `Retrieve the Cockpit of a given Project specified by the Project ID.`, Namespace: "cockpit", Resource: "cockpit", Verb: "get", @@ -177,8 +177,8 @@ func cockpitCockpitGet() *core.Command { func cockpitCockpitDeactivate() *core.Command { return &core.Command{ - Short: `Deactivate the Cockpit of the specified Project ID`, - Long: `Deactivate the Cockpit of the specified Project ID.`, + Short: `Deactivate the Cockpit of a given Project specified by the Project ID`, + Long: `Deactivate the Cockpit of a given Project specified by the Project ID.`, Namespace: "cockpit", Resource: "cockpit", Verb: "deactivate", @@ -200,8 +200,8 @@ func cockpitCockpitDeactivate() *core.Command { func cockpitTokenCreate() *core.Command { return &core.Command{ - Short: `Create a token associated with the specified Project ID`, - Long: `Create a token associated with the specified Project ID.`, + Short: `Create a token in a given Project specified by the Project ID`, + Long: `Create a token in a given Project specified by the Project ID.`, Namespace: "cockpit", Resource: "token", Verb: "create", @@ -294,8 +294,8 @@ func cockpitTokenCreate() *core.Command { func cockpitTokenList() *core.Command { return &core.Command{ - Short: `Get a list of tokens associated with the specified Project ID`, - Long: `Get a list of tokens associated with the specified Project ID.`, + Short: `Get a list of tokens in a given Project specified by the Project ID`, + Long: `Get a list of tokens in a given Project specified by the Project ID.`, Namespace: "cockpit", Resource: "token", Verb: "list", @@ -330,8 +330,8 @@ func cockpitTokenList() *core.Command { func cockpitTokenGet() *core.Command { return &core.Command{ - Short: `Retrieve the token associated with the specified token ID`, - Long: `Retrieve the token associated with the specified token ID.`, + Short: `Retrieve a given token specified by the token ID`, + Long: `Retrieve a given token specified by the token ID.`, Namespace: "cockpit", Resource: "token", Verb: "get", @@ -359,8 +359,8 @@ func cockpitTokenGet() *core.Command { func cockpitTokenDelete() *core.Command { return &core.Command{ - Short: `Delete the token associated with the specified token ID`, - Long: `Delete the token associated with the specified token ID.`, + Short: `Delete a given token specified by the token ID`, + Long: `Delete a given token specified by the token ID.`, Namespace: "cockpit", Resource: "token", Verb: "delete", @@ -394,8 +394,8 @@ func cockpitTokenDelete() *core.Command { func cockpitContactCreate() *core.Command { return &core.Command{ - Short: `Create a contact point to receive alerts for the default receiver`, - Long: `Create a contact point to receive alerts for the default receiver.`, + Short: `Create a contact point associated with the default receiver, to receive alerts`, + Long: `Create a contact point associated with the default receiver, to receive alerts.`, Namespace: "cockpit", Resource: "contact", Verb: "create", @@ -423,8 +423,8 @@ func cockpitContactCreate() *core.Command { func cockpitContactList() *core.Command { return &core.Command{ - Short: `Get a list of contact points for the Cockpit associated with the specified Project ID`, - Long: `Get a list of contact points for the Cockpit associated with the specified Project ID.`, + Short: `Get a list of contact points created for a given Cockpit, specified by the ID of the Project the Cockpit belongs to`, + Long: `Get a list of contact points created for a given Cockpit, specified by the ID of the Project the Cockpit belongs to.`, Namespace: "cockpit", Resource: "contact", Verb: "list", @@ -451,8 +451,8 @@ func cockpitContactList() *core.Command { func cockpitContactDelete() *core.Command { return &core.Command{ - Short: `Delete a contact point for the default receiver`, - Long: `Delete a contact point for the default receiver.`, + Short: `Delete a contact point associated with the default receiver`, + Long: `Delete a contact point associated with the default receiver.`, Namespace: "cockpit", Resource: "contact", Verb: "delete", @@ -486,8 +486,8 @@ func cockpitContactDelete() *core.Command { func cockpitAlertEnable() *core.Command { return &core.Command{ - Short: `Enable the sending of managed alerts for the specified Project's Cockpit`, - Long: `Enable the sending of managed alerts for the specified Project's Cockpit.`, + Short: `Enable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to`, + Long: `Enable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to.`, Namespace: "cockpit", Resource: "alert", Verb: "enable", @@ -515,8 +515,8 @@ func cockpitAlertEnable() *core.Command { func cockpitAlertDisable() *core.Command { return &core.Command{ - Short: `Disable the sending of managed alerts for the specified Project's Cockpit`, - Long: `Disable the sending of managed alerts for the specified Project's Cockpit.`, + Short: `Disable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to`, + Long: `Disable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to.`, Namespace: "cockpit", Resource: "alert", Verb: "disable", @@ -544,8 +544,8 @@ func cockpitAlertDisable() *core.Command { func cockpitAlertTest() *core.Command { return &core.Command{ - Short: `Trigger a test alert to all of the Cockpit's receivers`, - Long: `Trigger a test alert to all of the Cockpit's receivers.`, + Short: `Send a test alert to make sure your contact points get notified when an actual alert is triggered`, + Long: `Send a test alert to make sure your contact points get notified when an actual alert is triggered.`, Namespace: "cockpit", Resource: "alert", Verb: "test", @@ -573,8 +573,8 @@ func cockpitAlertTest() *core.Command { func cockpitGrafanaUserCreate() *core.Command { return &core.Command{ - Short: `Create a Grafana user for your Cockpit's Grafana instance. Make sure you save the automatically-generated password and the Grafana user ID`, - Long: `Create a Grafana user for your Cockpit's Grafana instance. Make sure you save the automatically-generated password and the Grafana user ID.`, + Short: `Create a Grafana user for your Cockpit's Grafana. Make sure you save the automatically-generated password and the Grafana user ID`, + Long: `Create a Grafana user for your Cockpit's Grafana. Make sure you save the automatically-generated password and the Grafana user ID.`, Namespace: "cockpit", Resource: "grafana-user", Verb: "create", @@ -611,8 +611,8 @@ func cockpitGrafanaUserCreate() *core.Command { func cockpitGrafanaUserList() *core.Command { return &core.Command{ - Short: `Get a list of Grafana users who are able to connect to the Cockpit's Grafana instance`, - Long: `Get a list of Grafana users who are able to connect to the Cockpit's Grafana instance.`, + Short: `Get a list of all Grafana users created in your Cockpit's Grafana`, + Long: `Get a list of all Grafana users created in your Cockpit's Grafana.`, Namespace: "cockpit", Resource: "grafana-user", Verb: "list", @@ -646,8 +646,8 @@ func cockpitGrafanaUserList() *core.Command { func cockpitGrafanaUserDelete() *core.Command { return &core.Command{ - Short: `Delete a Grafana user from a Grafana instance, specified by the Cockpit's Project ID and the Grafana user ID`, - Long: `Delete a Grafana user from a Grafana instance, specified by the Cockpit's Project ID and the Grafana user ID.`, + Short: `Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user`, + Long: `Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.`, Namespace: "cockpit", Resource: "grafana-user", Verb: "delete", @@ -682,8 +682,8 @@ func cockpitGrafanaUserDelete() *core.Command { func cockpitGrafanaUserResetPassword() *core.Command { return &core.Command{ - Short: `Reset a Grafana user's password specified by the Cockpit's Project ID and the Grafana user ID`, - Long: `Reset a Grafana user's password specified by the Cockpit's Project ID and the Grafana user ID.`, + Short: `Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user`, + Long: `Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.`, Namespace: "cockpit", Resource: "grafana-user", Verb: "reset-password",