Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ USAGE:
scw cockpit grafana-user <command>

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
Expand Down
Original file line number Diff line number Diff line change
@@ -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 ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -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 ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -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 ...]
Expand Down
26 changes: 15 additions & 11 deletions docs/commands/cockpit.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.

Expand All @@ -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:**
Expand All @@ -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:**
Expand All @@ -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.

Expand Down Expand Up @@ -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:**

Expand All @@ -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:**

Expand All @@ -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:**

Expand Down
34 changes: 19 additions & 15 deletions internal/namespaces/cockpit/v1/cockpit_cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -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(),
Expand Down Expand Up @@ -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{
{
Expand Down Expand Up @@ -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(),
Expand Down Expand Up @@ -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(),
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
Loading