Skip to content

Commit 0758f90

Browse files
joaopaletjoaopalet
authored
Add argus grafana single-sign-on commands (#228)
* Add argus grafana single-sign-on enable command * Add argus grafana single-sign-on disable command * Update docs * Register disable command and update docs * Improvements after review
1 parent bf75e9f commit 0758f90

File tree

12 files changed

+963
-98
lines changed

12 files changed

+963
-98
lines changed

‎docs/stackit_argus_grafana.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,5 @@ stackit argus grafana [flags]
3030

3131
* [stackit argus](./stackit_argus.md) - Provides functionality for Argus
3232
* [stackit argus grafana describe](./stackit_argus_grafana_describe.md) - Shows details of the Grafana configuration of an Argus instance
33+
* [stackit argus grafana single-sign-on](./stackit_argus_grafana_single-sign-on.md) - Enable or disable single sign-on for Grafana in Argus instances
3334

‎docs/stackit_argus_grafana_single-sign-on.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## stackit argus grafana single-sign-on
2+
3+
Enable or disable single sign-on for Grafana in Argus instances
4+
5+
### Synopsis
6+
7+
Enable or disable single sign-on for Grafana in Argus instances.
8+
When enabled for an instance, overwrites the generic OAuth2 authentication and configures STACKIT single sign-on for that instance.
9+
10+
```
11+
stackit argus grafana single-sign-on [flags]
12+
```
13+
14+
### Options
15+
16+
```
17+
-h, --help Help for "stackit argus grafana single-sign-on"
18+
```
19+
20+
### Options inherited from parent commands
21+
22+
```
23+
-y, --assume-yes If set, skips all confirmation prompts
24+
--async If set, runs the command asynchronously
25+
-o, --output-format string Output format, one of ["json" "pretty"]
26+
-p, --project-id string Project ID
27+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
28+
```
29+
30+
### SEE ALSO
31+
32+
* [stackit argus grafana](./stackit_argus_grafana.md) - Provides functionality for the Grafana configuration of Argus instances
33+
* [stackit argus grafana single-sign-on disable](./stackit_argus_grafana_single-sign-on_disable.md) - Disables single sign-on for Grafana on Argus instances
34+
* [stackit argus grafana single-sign-on enable](./stackit_argus_grafana_single-sign-on_enable.md) - Enables single sign-on for Grafana on Argus instances
35+

‎docs/stackit_argus_grafana_single-sign-on_disable.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## stackit argus grafana single-sign-on disable
2+
3+
Disables single sign-on for Grafana on Argus instances
4+
5+
### Synopsis
6+
7+
Disables single sign-on for Grafana on Argus instances.
8+
When disabled for an instance, the generic OAuth2 authentication is used for that instance.
9+
10+
```
11+
stackit argus grafana single-sign-on disable [flags]
12+
```
13+
14+
### Examples
15+
16+
```
17+
Disable single sign-on for Grafana on an Argus instance with ID "xxx"
18+
$ stackit argus grafana single-sign-on disable --instance-id xxx
19+
```
20+
21+
### Options
22+
23+
```
24+
-h, --help Help for "stackit argus grafana single-sign-on disable"
25+
--instance-id string Instance ID
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-y, --assume-yes If set, skips all confirmation prompts
32+
--async If set, runs the command asynchronously
33+
-o, --output-format string Output format, one of ["json" "pretty"]
34+
-p, --project-id string Project ID
35+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
36+
```
37+
38+
### SEE ALSO
39+
40+
* [stackit argus grafana single-sign-on](./stackit_argus_grafana_single-sign-on.md) - Enable or disable single sign-on for Grafana in Argus instances
41+

‎docs/stackit_argus_grafana_single-sign-on_enable.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## stackit argus grafana single-sign-on enable
2+
3+
Enables single sign-on for Grafana on Argus instances
4+
5+
### Synopsis
6+
7+
Enables single sign-on for Grafana on Argus instances.
8+
When enabled for an instance, overwrites the generic OAuth2 authentication and configures STACKIT single sign-on for that instance.
9+
10+
```
11+
stackit argus grafana single-sign-on enable [flags]
12+
```
13+
14+
### Examples
15+
16+
```
17+
Enable single sign-on for Grafana on an Argus instance with ID "xxx"
18+
$ stackit argus grafana single-sign-on enable --instance-id xxx
19+
```
20+
21+
### Options
22+
23+
```
24+
-h, --help Help for "stackit argus grafana single-sign-on enable"
25+
--instance-id string Instance ID
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-y, --assume-yes If set, skips all confirmation prompts
32+
--async If set, runs the command asynchronously
33+
-o, --output-format string Output format, one of ["json" "pretty"]
34+
-p, --project-id string Project ID
35+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
36+
```
37+
38+
### SEE ALSO
39+
40+
* [stackit argus grafana single-sign-on](./stackit_argus_grafana_single-sign-on.md) - Enable or disable single sign-on for Grafana in Argus instances
41+

‎internal/cmd/argus/grafana/grafana.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package grafana
22

33
import (
44
"github.com/stackitcloud/stackit-cli/internal/cmd/argus/grafana/describe"
5+
singlesignon "github.com/stackitcloud/stackit-cli/internal/cmd/argus/grafana/single-sign-on"
56
"github.com/stackitcloud/stackit-cli/internal/pkg/args"
67
"github.com/stackitcloud/stackit-cli/internal/pkg/print"
78
"github.com/stackitcloud/stackit-cli/internal/pkg/utils"
@@ -23,4 +24,5 @@ func NewCmd(p *print.Printer) *cobra.Command {
2324

2425
func addSubcommands(cmd *cobra.Command, p *print.Printer) {
2526
cmd.AddCommand(describe.NewCmd(p))
27+
cmd.AddCommand(singlesignon.NewCmd(p))
2628
}

‎internal/cmd/argus/grafana/single-sign-on/disable/disable.go‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
package disable
2+
3+
import (
4+
"context"
5+
"fmt"
6+
7+
"github.com/stackitcloud/stackit-cli/internal/pkg/args"
8+
"github.com/stackitcloud/stackit-cli/internal/pkg/errors"
9+
"github.com/stackitcloud/stackit-cli/internal/pkg/examples"
10+
"github.com/stackitcloud/stackit-cli/internal/pkg/flags"
11+
"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
12+
"github.com/stackitcloud/stackit-cli/internal/pkg/print"
13+
"github.com/stackitcloud/stackit-cli/internal/pkg/services/argus/client"
14+
argusUtils "github.com/stackitcloud/stackit-cli/internal/pkg/services/argus/utils"
15+
"github.com/stackitcloud/stackit-cli/internal/pkg/utils"
16+
17+
"github.com/spf13/cobra"
18+
"github.com/stackitcloud/stackit-sdk-go/services/argus"
19+
)
20+
21+
const (
22+
instanceIdFlag = "instance-id"
23+
)
24+
25+
type inputModel struct {
26+
*globalflags.GlobalFlagModel
27+
InstanceId string
28+
}
29+
30+
func NewCmd(p *print.Printer) *cobra.Command {
31+
cmd := &cobra.Command{
32+
Use: "disable",
33+
Short: "Disables single sign-on for Grafana on Argus instances",
34+
Long: fmt.Sprintf("%s\n%s",
35+
"Disables single sign-on for Grafana on Argus instances.",
36+
"When disabled for an instance, the generic OAuth2 authentication is used for that instance.",
37+
),
38+
Args: args.NoArgs,
39+
Example: examples.Build(
40+
examples.NewExample(
41+
`Disable single sign-on for Grafana on an Argus instance with ID "xxx"`,
42+
"$ stackit argus grafana single-sign-on disable --instance-id xxx"),
43+
),
44+
RunE: func(cmd *cobra.Command, args []string) error {
45+
ctx := context.Background()
46+
model, err := parseInput(cmd)
47+
if err != nil {
48+
return err
49+
}
50+
51+
// Configure API client
52+
apiClient, err := client.ConfigureClient(p)
53+
if err != nil {
54+
return err
55+
}
56+
57+
instanceLabel, err := argusUtils.GetInstanceName(ctx, apiClient, model.InstanceId, model.ProjectId)
58+
if err != nil || instanceLabel == "" {
59+
instanceLabel = model.InstanceId
60+
}
61+
62+
if !model.AssumeYes {
63+
prompt := fmt.Sprintf("Are you sure you want to disable single sign-on for instance %q?", instanceLabel)
64+
err = p.PromptForConfirmation(prompt)
65+
if err != nil {
66+
return err
67+
}
68+
}
69+
70+
// Call API
71+
req, err := buildRequest(ctx, model, apiClient)
72+
if err != nil {
73+
return fmt.Errorf("build request: %w", err)
74+
}
75+
_, err = req.Execute()
76+
if err != nil {
77+
return fmt.Errorf("disable single sign-on: %w", err)
78+
}
79+
80+
p.Info("Disabled single sign-on for instance %q\n", instanceLabel)
81+
return nil
82+
},
83+
}
84+
configureFlags(cmd)
85+
return cmd
86+
}
87+
88+
func configureFlags(cmd *cobra.Command) {
89+
cmd.Flags().Var(flags.UUIDFlag(), instanceIdFlag, "Instance ID")
90+
91+
err := flags.MarkFlagsRequired(cmd, instanceIdFlag)
92+
cobra.CheckErr(err)
93+
}
94+
95+
func parseInput(cmd *cobra.Command) (*inputModel, error) {
96+
globalFlags := globalflags.Parse(cmd)
97+
if globalFlags.ProjectId == "" {
98+
return nil, &errors.ProjectIdError{}
99+
}
100+
101+
return &inputModel{
102+
GlobalFlagModel: globalFlags,
103+
InstanceId: flags.FlagToStringValue(cmd, instanceIdFlag),
104+
}, nil
105+
}
106+
107+
func buildRequest(ctx context.Context, model *inputModel, apiClient argusUtils.ArgusClient) (argus.ApiUpdateGrafanaConfigsRequest, error) {
108+
req := apiClient.UpdateGrafanaConfigs(ctx, model.InstanceId, model.ProjectId)
109+
payload, err := argusUtils.GetPartialUpdateGrafanaConfigsPayload(ctx, apiClient, model.InstanceId, model.ProjectId, utils.Ptr(false), nil)
110+
if err != nil {
111+
return req, fmt.Errorf("build request payload: %w", err)
112+
}
113+
req = req.UpdateGrafanaConfigsPayload(*payload)
114+
return req, nil
115+
}

0 commit comments

Comments
 (0)