Skip to content

Fix grafana describe examples #457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 23, 2024
Merged

Fix grafana describe examples #457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56c2fd6
fix grafana describe examples
GokceGK Aug 23, 2024
3984b56
update docs
GokceGK Aug 23, 2024
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
6 changes: 3 additions & 3 deletions docs/stackit_observability_grafana_describe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ stackit observability grafana describe INSTANCE_ID [flags]

```
Get details of the Grafana configuration of an Observability instance with ID "xxx"
$ stackit observability credentials describe xxx
$ stackit observability grafana describe xxx

Get details of the Grafana configuration of an Observability instance with ID "xxx" and show the initial admin password
$ stackit observability credentials describe xxx --show-password
$ stackit observability grafana describe xxx --show-password

Get details of the Grafana configuration of an Observability instance with ID "xxx" in JSON format
$ stackit observability credentials describe xxx --output-format json
$ stackit observability grafana describe xxx --output-format json
```

### Options
Expand Down
6 changes: 3 additions & 3 deletions internal/cmd/observability/grafana/describe/describe.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@ func NewCmd(p *print.Printer) *cobra.Command {
Example: examples.Build(
examples.NewExample(
`Get details of the Grafana configuration of an Observability instance with ID "xxx"`,
"$ stackit observability credentials describe xxx"),
"$ stackit observability grafana describe xxx"),
examples.NewExample(
`Get details of the Grafana configuration of an Observability instance with ID "xxx" and show the initial admin password`,
"$ stackit observability credentials describe xxx --show-password"),
"$ stackit observability grafana describe xxx --show-password"),
examples.NewExample(
`Get details of the Grafana configuration of an Observability instance with ID "xxx" in JSON format`,
"$ stackit observability credentials describe xxx --output-format json"),
"$ stackit observability grafana describe xxx --output-format json"),
),
RunE: func(cmd *cobra.Command, args []string) error {
ctx := context.Background()
Expand Down