Skip to content

Commit 89b3ed0

Browse files
GokceGKGokceGK
authored
add observability docs (#456)
1 parent 5637766 commit 89b3ed0

27 files changed

+1148
-0
lines changed

‎docs/stackit_observability.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## stackit observability
2+
3+
Provides functionality for Observability
4+
5+
### Synopsis
6+
7+
Provides functionality for Observability.
8+
9+
```
10+
stackit observability [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit observability"
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
-y, --assume-yes If set, skips all confirmation prompts
23+
--async If set, runs the command asynchronously
24+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
25+
-p, --project-id string Project ID
26+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
27+
```
28+
29+
### SEE ALSO
30+
31+
* [stackit](./stackit.md) - Manage STACKIT resources using the command line
32+
* [stackit observability credentials](./stackit_observability_credentials.md) - Provides functionality for Observability credentials
33+
* [stackit observability grafana](./stackit_observability_grafana.md) - Provides functionality for the Grafana configuration of Observability instances
34+
* [stackit observability instance](./stackit_observability_instance.md) - Provides functionality for Observability instances
35+
* [stackit observability plans](./stackit_observability_plans.md) - Lists all Observability service plans
36+
* [stackit observability scrape-config](./stackit_observability_scrape-config.md) - Provides functionality for scrape configurations in Observability
37+

‎docs/stackit_observability_credentials.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## stackit observability credentials
2+
3+
Provides functionality for Observability credentials
4+
5+
### Synopsis
6+
7+
Provides functionality for Observability credentials.
8+
9+
```
10+
stackit observability credentials [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit observability credentials"
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
-y, --assume-yes If set, skips all confirmation prompts
23+
--async If set, runs the command asynchronously
24+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
25+
-p, --project-id string Project ID
26+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
27+
```
28+
29+
### SEE ALSO
30+
31+
* [stackit observability](./stackit_observability.md) - Provides functionality for Observability
32+
* [stackit observability credentials create](./stackit_observability_credentials_create.md) - Creates credentials for an Observability instance.
33+
* [stackit observability credentials delete](./stackit_observability_credentials_delete.md) - Deletes credentials of an Observability instance
34+
* [stackit observability credentials list](./stackit_observability_credentials_list.md) - Lists the usernames of all credentials for an Observability instance
35+

‎docs/stackit_observability_credentials_create.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## stackit observability credentials create
2+
3+
Creates credentials for an Observability instance.
4+
5+
### Synopsis
6+
7+
Creates credentials (username and password) for an Observability instance.
8+
The credentials will be generated and included in the response. You won't be able to retrieve the password later.
9+
10+
```
11+
stackit observability credentials create [flags]
12+
```
13+
14+
### Examples
15+
16+
```
17+
Create credentials for Observability instance with ID "xxx"
18+
$ stackit observability credentials create --instance-id xxx
19+
```
20+
21+
### Options
22+
23+
```
24+
-h, --help Help for "stackit observability credentials create"
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" "none" "yaml"]
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 observability credentials](./stackit_observability_credentials.md) - Provides functionality for Observability credentials
41+

‎docs/stackit_observability_credentials_delete.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## stackit observability credentials delete
2+
3+
Deletes credentials of an Observability instance
4+
5+
### Synopsis
6+
7+
Deletes credentials of an Observability instance.
8+
9+
```
10+
stackit observability credentials delete USERNAME [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Delete credentials of username "xxx" for Observability instance with ID "yyy"
17+
$ stackit observability credentials delete xxx --instance-id yyy
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit observability credentials delete"
24+
--instance-id string Instance ID
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
-y, --assume-yes If set, skips all confirmation prompts
31+
--async If set, runs the command asynchronously
32+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
33+
-p, --project-id string Project ID
34+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
35+
```
36+
37+
### SEE ALSO
38+
39+
* [stackit observability credentials](./stackit_observability_credentials.md) - Provides functionality for Observability credentials
40+

‎docs/stackit_observability_credentials_list.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## stackit observability credentials list
2+
3+
Lists the usernames of all credentials for an Observability instance
4+
5+
### Synopsis
6+
7+
Lists the usernames of all credentials for an Observability instance.
8+
9+
```
10+
stackit observability credentials list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
List the usernames of all credentials for an Observability instance with ID "xxx"
17+
$ stackit observability credentials list --instance-id xxx
18+
19+
List the usernames of all credentials for an Observability instance in JSON format
20+
$ stackit observability credentials list --instance-id xxx --output-format json
21+
22+
List the usernames of up to 10 credentials for an Observability instance
23+
$ stackit observability credentials list --instance-id xxx --limit 10
24+
```
25+
26+
### Options
27+
28+
```
29+
-h, --help Help for "stackit observability credentials list"
30+
--instance-id string Instance ID
31+
--limit int Maximum number of entries to list
32+
```
33+
34+
### Options inherited from parent commands
35+
36+
```
37+
-y, --assume-yes If set, skips all confirmation prompts
38+
--async If set, runs the command asynchronously
39+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
40+
-p, --project-id string Project ID
41+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
42+
```
43+
44+
### SEE ALSO
45+
46+
* [stackit observability credentials](./stackit_observability_credentials.md) - Provides functionality for Observability credentials
47+

‎docs/stackit_observability_grafana.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## stackit observability grafana
2+
3+
Provides functionality for the Grafana configuration of Observability instances
4+
5+
### Synopsis
6+
7+
Provides functionality for the Grafana configuration of Observability instances.
8+
9+
```
10+
stackit observability grafana [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit observability grafana"
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
-y, --assume-yes If set, skips all confirmation prompts
23+
--async If set, runs the command asynchronously
24+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
25+
-p, --project-id string Project ID
26+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
27+
```
28+
29+
### SEE ALSO
30+
31+
* [stackit observability](./stackit_observability.md) - Provides functionality for Observability
32+
* [stackit observability grafana describe](./stackit_observability_grafana_describe.md) - Shows details of the Grafana configuration of an Observability instance
33+
* [stackit observability grafana public-read-access](./stackit_observability_grafana_public-read-access.md) - Enable or disable public read access for Grafana in Observability instances
34+
* [stackit observability grafana single-sign-on](./stackit_observability_grafana_single-sign-on.md) - Enable or disable single sign-on for Grafana in Observability instances
35+

‎docs/stackit_observability_grafana_describe.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
## stackit observability grafana describe
2+
3+
Shows details of the Grafana configuration of an Observability instance
4+
5+
### Synopsis
6+
7+
Shows details of the Grafana configuration of an Observability instance.
8+
The Grafana dashboard URL and initial credentials (admin user and password) will be shown in the "pretty" output format. These credentials are only valid for first login. Please change the password after first login. After changing, the initial password is no longer valid.
9+
The initial password is hidden by default, if you want to show it use the "--show-password" flag.
10+
11+
```
12+
stackit observability grafana describe INSTANCE_ID [flags]
13+
```
14+
15+
### Examples
16+
17+
```
18+
Get details of the Grafana configuration of an Observability instance with ID "xxx"
19+
$ stackit observability credentials describe xxx
20+
21+
Get details of the Grafana configuration of an Observability instance with ID "xxx" and show the initial admin password
22+
$ stackit observability credentials describe xxx --show-password
23+
24+
Get details of the Grafana configuration of an Observability instance with ID "xxx" in JSON format
25+
$ stackit observability credentials describe xxx --output-format json
26+
```
27+
28+
### Options
29+
30+
```
31+
-h, --help Help for "stackit observability grafana describe"
32+
-s, --show-password Show password in output
33+
```
34+
35+
### Options inherited from parent commands
36+
37+
```
38+
-y, --assume-yes If set, skips all confirmation prompts
39+
--async If set, runs the command asynchronously
40+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
41+
-p, --project-id string Project ID
42+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
43+
```
44+
45+
### SEE ALSO
46+
47+
* [stackit observability grafana](./stackit_observability_grafana.md) - Provides functionality for the Grafana configuration of Observability instances
48+

‎docs/stackit_observability_grafana_public-read-access.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## stackit observability grafana public-read-access
2+
3+
Enable or disable public read access for Grafana in Observability instances
4+
5+
### Synopsis
6+
7+
Enable or disable public read access for Grafana in Observability instances.
8+
When enabled, anyone can access the Grafana dashboards of the instance without logging in. Otherwise, a login is required.
9+
10+
```
11+
stackit observability grafana public-read-access [flags]
12+
```
13+
14+
### Options
15+
16+
```
17+
-h, --help Help for "stackit observability grafana public-read-access"
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" "none" "yaml"]
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 observability grafana](./stackit_observability_grafana.md) - Provides functionality for the Grafana configuration of Observability instances
33+
* [stackit observability grafana public-read-access disable](./stackit_observability_grafana_public-read-access_disable.md) - Disables public read access for Grafana on Observability instances
34+
* [stackit observability grafana public-read-access enable](./stackit_observability_grafana_public-read-access_enable.md) - Enables public read access for Grafana on Observability instances
35+

‎docs/stackit_observability_grafana_public-read-access_disable.md‎

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

0 commit comments

Comments
 (0)