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 ffe55ec988..fc4517bca5 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,5 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Create a Grafana user Create a Grafana user to connect to your Cockpit's Grafana. Upon creation, your user password displays only once, so make sure that you save it. Each Grafana user is associated with a role: viewer or editor. A viewer can only view dashboards, whereas an editor can create and edit dashboards. Note that the `admin` username is not available for creation. 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 c1df30158c..c009b97f99 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,5 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Delete a 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. USAGE: 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 11a7c4a796..ded8d34cdf 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,5 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +List Grafana users List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order. USAGE: 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 559f3269b6..97c06cf29b 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,5 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Reset a Grafana user 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. A new password regenerates and only displays once. Make sure that you save it. 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 a1904024bb..05c688cced 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 - delete Delete a Grafana user - list List Grafana users - reset-password Reset a Grafana user password + create (Deprecated) EOL 2026-01-20 + delete (Deprecated) EOL 2026-01-20 + list (Deprecated) EOL 2026-01-20 + reset-password (Deprecated) EOL 2026-01-20 FLAGS: -h, --help help for grafana-user diff --git a/cmd/scw/testdata/test-all-usage-cockpit-plan-get-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-plan-get-usage.golden index 475fac6c06..345fa8770b 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-plan-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-plan-get-usage.golden @@ -1,7 +1,7 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ Retrieve a pricing plan for the given Project, specified by the ID of the Project. -Deprecated: retention is now managed at the data source level. +Deprecated due to retention now being managed at the data source level. USAGE: scw cockpit plan get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-plan-list-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-plan-list-usage.golden index 4e3e1e9a83..c0396e48e3 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-plan-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-plan-list-usage.golden @@ -1,7 +1,7 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ Retrieve a list of available pricing plan types. -Deprecated: retention is now managed at the data source level. +Deprecated due to retention now being managed at the data source level. USAGE: scw cockpit plan list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-cockpit-plan-select-usage.golden b/cmd/scw/testdata/test-all-usage-cockpit-plan-select-usage.golden index e484a115c4..97cb672db3 100644 --- a/cmd/scw/testdata/test-all-usage-cockpit-plan-select-usage.golden +++ b/cmd/scw/testdata/test-all-usage-cockpit-plan-select-usage.golden @@ -1,7 +1,7 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply. -Deprecated: retention is now managed at the data source level. +Deprecated due to retention now being managed at the data source level. USAGE: scw cockpit plan select [arg=value ...] diff --git a/docs/commands/cockpit.md b/docs/commands/cockpit.md index dfc432734c..afe9d36879 100644 --- a/docs/commands/cockpit.md +++ b/docs/commands/cockpit.md @@ -20,10 +20,10 @@ This API allows you to manage your Scaleway Cockpit, for storing and visualizing - [Get your Cockpit's Grafana](#get-your-cockpit's-grafana) - [Synchronize Grafana data sources](#synchronize-grafana-data-sources) - [Grafana user management commands](#grafana-user-management-commands) - - [Create a Grafana user](#create-a-grafana-user) - - [Delete a Grafana user](#delete-a-grafana-user) - - [List Grafana users](#list-grafana-users) - - [Reset a Grafana user password](#reset-a-grafana-user-password) + - [(Deprecated) EOL 2026-01-20](#(deprecated)-eol-2026-01-20) + - [(Deprecated) EOL 2026-01-20](#(deprecated)-eol-2026-01-20) + - [(Deprecated) EOL 2026-01-20](#(deprecated)-eol-2026-01-20) + - [(Deprecated) EOL 2026-01-20](#(deprecated)-eol-2026-01-20) - [Managed alerts management commands](#managed-alerts-management-commands) - [Pricing plans management commands](#pricing-plans-management-commands) - [Get current plan](#get-current-plan) @@ -342,8 +342,9 @@ scw cockpit grafana sync-data-sources [arg=value ...] Grafana user management commands. -### Create a Grafana user +### (Deprecated) EOL 2026-01-20 +Create a Grafana user Create a Grafana user to connect to your Cockpit's Grafana. Upon creation, your user password displays only once, so make sure that you save it. Each Grafana user is associated with a role: viewer or editor. A viewer can only view dashboards, whereas an editor can create and edit dashboards. Note that the `admin` username is not available for creation. @@ -364,8 +365,9 @@ scw cockpit grafana-user create [arg=value ...] -### Delete a Grafana user +### (Deprecated) EOL 2026-01-20 +Delete a 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. **Usage:** @@ -384,8 +386,9 @@ scw cockpit grafana-user delete [arg=value ...] -### List Grafana users +### (Deprecated) EOL 2026-01-20 +List Grafana users List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order. **Usage:** @@ -404,8 +407,9 @@ scw cockpit grafana-user list [arg=value ...] -### Reset a Grafana user password +### (Deprecated) EOL 2026-01-20 +Reset a Grafana user 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. A new password regenerates and only displays once. Make sure that you save it. @@ -447,7 +451,7 @@ Pricing plans management commands. ### Get current plan Retrieve a pricing plan for the given Project, specified by the ID of the Project. -Deprecated: retention is now managed at the data source level. +Deprecated due to retention now being managed at the data source level. **Usage:** @@ -467,7 +471,7 @@ scw cockpit plan get [arg=value ...] ### List plan types Retrieve a list of available pricing plan types. -Deprecated: retention is now managed at the data source level. +Deprecated due to retention now being managed at the data source level. **Usage:** @@ -487,7 +491,7 @@ scw cockpit plan list [arg=value ...] ### Apply a pricing plan Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply. -Deprecated: retention is now managed at the data source level. +Deprecated due to retention now being managed at the data source level. **Usage:** diff --git a/internal/namespaces/cockpit/v1/cockpit_cli.go b/internal/namespaces/cockpit/v1/cockpit_cli.go index 14399e8118..96070a0a42 100644 --- a/internal/namespaces/cockpit/v1/cockpit_cli.go +++ b/internal/namespaces/cockpit/v1/cockpit_cli.go @@ -225,13 +225,14 @@ func cockpitGrafanaSyncDataSources() *core.Command { func cockpitGrafanaUserCreate() *core.Command { return &core.Command{ - Short: `Create a Grafana user`, - Long: `Create a Grafana user to connect to your Cockpit's Grafana. Upon creation, your user password displays only once, so make sure that you save it. + Short: `(Deprecated) EOL 2026-01-20`, + Long: `Create a Grafana user +Create a Grafana user to connect to your Cockpit's Grafana. Upon creation, your user password displays only once, so make sure that you save it. Each Grafana user is associated with a role: viewer or editor. A viewer can only view dashboards, whereas an editor can create and edit dashboards. Note that the ` + "`" + `admin` + "`" + ` username is not available for creation.`, Namespace: "cockpit", Resource: "grafana-user", Verb: "create", - // Deprecated: false, + // Deprecated: true, ArgsType: reflect.TypeOf(cockpit.GlobalAPICreateGrafanaUserRequest{}), ArgSpecs: core.ArgSpecs{ core.ProjectIDArgSpec(), @@ -268,12 +269,13 @@ Each Grafana user is associated with a role: viewer or editor. A viewer can only func cockpitGrafanaUserList() *core.Command { return &core.Command{ - Short: `List Grafana users`, - Long: `List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order.`, + Short: `(Deprecated) EOL 2026-01-20`, + Long: `List Grafana users +List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order.`, Namespace: "cockpit", Resource: "grafana-user", Verb: "list", - // Deprecated: false, + // Deprecated: true, ArgsType: reflect.TypeOf(cockpit.GlobalAPIListGrafanaUsersRequest{}), ArgSpecs: core.ArgSpecs{ { @@ -307,12 +309,13 @@ func cockpitGrafanaUserList() *core.Command { func cockpitGrafanaUserDelete() *core.Command { return &core.Command{ - Short: `Delete a 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.`, + Short: `(Deprecated) EOL 2026-01-20`, + Long: `Delete a 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.`, Namespace: "cockpit", Resource: "grafana-user", Verb: "delete", - // Deprecated: false, + // Deprecated: true, ArgsType: reflect.TypeOf(cockpit.GlobalAPIDeleteGrafanaUserRequest{}), ArgSpecs: core.ArgSpecs{ core.ProjectIDArgSpec(), @@ -344,13 +347,14 @@ func cockpitGrafanaUserDelete() *core.Command { func cockpitGrafanaUserResetPassword() *core.Command { return &core.Command{ - Short: `Reset a Grafana user password`, - 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. + Short: `(Deprecated) EOL 2026-01-20`, + Long: `Reset a Grafana user 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. A new password regenerates and only displays once. Make sure that you save it.`, Namespace: "cockpit", Resource: "grafana-user", Verb: "reset-password", - // Deprecated: false, + // Deprecated: true, ArgsType: reflect.TypeOf(cockpit.GlobalAPIResetGrafanaUserPasswordRequest{}), ArgSpecs: core.ArgSpecs{ core.ProjectIDArgSpec(), @@ -442,7 +446,7 @@ func cockpitPlanList() *core.Command { return &core.Command{ Short: `List plan types`, Long: `Retrieve a list of available pricing plan types. -Deprecated: retention is now managed at the data source level.`, +Deprecated due to retention now being managed at the data source level.`, Namespace: "cockpit", Resource: "plan", Verb: "list", @@ -480,7 +484,7 @@ func cockpitPlanSelect() *core.Command { return &core.Command{ Short: `Apply a pricing plan`, Long: `Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply. -Deprecated: retention is now managed at the data source level.`, +Deprecated due to retention now being managed at the data source level.`, Namespace: "cockpit", Resource: "plan", Verb: "select", @@ -517,7 +521,7 @@ func cockpitPlanGet() *core.Command { return &core.Command{ Short: `Get current plan`, Long: `Retrieve a pricing plan for the given Project, specified by the ID of the Project. -Deprecated: retention is now managed at the data source level.`, +Deprecated due to retention now being managed at the data source level.`, Namespace: "cockpit", Resource: "plan", Verb: "get",