Skip to content

Add observability docs #456

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.

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 1 commit into from
Aug 22, 2024
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
37 changes: 37 additions & 0 deletions docs/stackit_observability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## stackit observability

Provides functionality for Observability

### Synopsis

Provides functionality for Observability.

```
stackit observability [flags]
```

### Options

```
-h, --help Help for "stackit observability"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [stackit observability credentials](./stackit_observability_credentials.md) - Provides functionality for Observability credentials
* [stackit observability grafana](./stackit_observability_grafana.md) - Provides functionality for the Grafana configuration of Observability instances
* [stackit observability instance](./stackit_observability_instance.md) - Provides functionality for Observability instances
* [stackit observability plans](./stackit_observability_plans.md) - Lists all Observability service plans
* [stackit observability scrape-config](./stackit_observability_scrape-config.md) - Provides functionality for scrape configurations in Observability

35 changes: 35 additions & 0 deletions docs/stackit_observability_credentials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## stackit observability credentials

Provides functionality for Observability credentials

### Synopsis

Provides functionality for Observability credentials.

```
stackit observability credentials [flags]
```

### Options

```
-h, --help Help for "stackit observability credentials"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit observability](./stackit_observability.md) - Provides functionality for Observability
* [stackit observability credentials create](./stackit_observability_credentials_create.md) - Creates credentials for an Observability instance.
* [stackit observability credentials delete](./stackit_observability_credentials_delete.md) - Deletes credentials of an Observability instance
* [stackit observability credentials list](./stackit_observability_credentials_list.md) - Lists the usernames of all credentials for an Observability instance

41 changes: 41 additions & 0 deletions docs/stackit_observability_credentials_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## stackit observability credentials create

Creates credentials for an Observability instance.

### Synopsis

Creates credentials (username and password) for an Observability instance.
The credentials will be generated and included in the response. You won't be able to retrieve the password later.

```
stackit observability credentials create [flags]
```

### Examples

```
Create credentials for Observability instance with ID "xxx"
$ stackit observability credentials create --instance-id xxx
```

### Options

```
-h, --help Help for "stackit observability credentials create"
--instance-id string Instance ID
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit observability credentials](./stackit_observability_credentials.md) - Provides functionality for Observability credentials

40 changes: 40 additions & 0 deletions docs/stackit_observability_credentials_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## stackit observability credentials delete

Deletes credentials of an Observability instance

### Synopsis

Deletes credentials of an Observability instance.

```
stackit observability credentials delete USERNAME [flags]
```

### Examples

```
Delete credentials of username "xxx" for Observability instance with ID "yyy"
$ stackit observability credentials delete xxx --instance-id yyy
```

### Options

```
-h, --help Help for "stackit observability credentials delete"
--instance-id string Instance ID
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit observability credentials](./stackit_observability_credentials.md) - Provides functionality for Observability credentials

47 changes: 47 additions & 0 deletions docs/stackit_observability_credentials_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## stackit observability credentials list

Lists the usernames of all credentials for an Observability instance

### Synopsis

Lists the usernames of all credentials for an Observability instance.

```
stackit observability credentials list [flags]
```

### Examples

```
List the usernames of all credentials for an Observability instance with ID "xxx"
$ stackit observability credentials list --instance-id xxx

List the usernames of all credentials for an Observability instance in JSON format
$ stackit observability credentials list --instance-id xxx --output-format json

List the usernames of up to 10 credentials for an Observability instance
$ stackit observability credentials list --instance-id xxx --limit 10
```

### Options

```
-h, --help Help for "stackit observability credentials list"
--instance-id string Instance ID
--limit int Maximum number of entries to list
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit observability credentials](./stackit_observability_credentials.md) - Provides functionality for Observability credentials

35 changes: 35 additions & 0 deletions docs/stackit_observability_grafana.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## stackit observability grafana

Provides functionality for the Grafana configuration of Observability instances

### Synopsis

Provides functionality for the Grafana configuration of Observability instances.

```
stackit observability grafana [flags]
```

### Options

```
-h, --help Help for "stackit observability grafana"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit observability](./stackit_observability.md) - Provides functionality for Observability
* [stackit observability grafana describe](./stackit_observability_grafana_describe.md) - Shows details of the Grafana configuration of an Observability instance
* [stackit observability grafana public-read-access](./stackit_observability_grafana_public-read-access.md) - Enable or disable public read access for Grafana in Observability instances
* [stackit observability grafana single-sign-on](./stackit_observability_grafana_single-sign-on.md) - Enable or disable single sign-on for Grafana in Observability instances

48 changes: 48 additions & 0 deletions docs/stackit_observability_grafana_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
## stackit observability grafana describe

Shows details of the Grafana configuration of an Observability instance

### Synopsis

Shows details of the Grafana configuration of an Observability instance.
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.
The initial password is hidden by default, if you want to show it use the "--show-password" flag.

```
stackit observability grafana describe INSTANCE_ID [flags]
```

### Examples

```
Get details of the Grafana configuration of an Observability instance with ID "xxx"
$ stackit observability credentials 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

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

### Options

```
-h, --help Help for "stackit observability grafana describe"
-s, --show-password Show password in output
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit observability grafana](./stackit_observability_grafana.md) - Provides functionality for the Grafana configuration of Observability instances

35 changes: 35 additions & 0 deletions docs/stackit_observability_grafana_public-read-access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## stackit observability grafana public-read-access

Enable or disable public read access for Grafana in Observability instances

### Synopsis

Enable or disable public read access for Grafana in Observability instances.
When enabled, anyone can access the Grafana dashboards of the instance without logging in. Otherwise, a login is required.

```
stackit observability grafana public-read-access [flags]
```

### Options

```
-h, --help Help for "stackit observability grafana public-read-access"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit observability grafana](./stackit_observability_grafana.md) - Provides functionality for the Grafana configuration of Observability instances
* [stackit observability grafana public-read-access disable](./stackit_observability_grafana_public-read-access_disable.md) - Disables public read access for Grafana on Observability instances
* [stackit observability grafana public-read-access enable](./stackit_observability_grafana_public-read-access_enable.md) - Enables public read access for Grafana on Observability instances

Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## stackit observability grafana public-read-access disable

Disables public read access for Grafana on Observability instances

### Synopsis

Disables public read access for Grafana on Observability instances.
When disabled, a login is required to access the Grafana dashboards of the instance. Otherwise, anyone can access the dashboards.

```
stackit observability grafana public-read-access disable INSTANCE_ID [flags]
```

### Examples

```
Disable public read access for Grafana on an Observability instance with ID "xxx"
$ stackit observability grafana public-read-access disable xxx
```

### Options

```
-h, --help Help for "stackit observability grafana public-read-access disable"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit observability grafana public-read-access](./stackit_observability_grafana_public-read-access.md) - Enable or disable public read access for Grafana in Observability instances

Loading