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
2 changes: 2 additions & 0 deletions docs/stackit.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ stackit [flags]
* [stackit config](./stackit_config.md) - CLI configuration options
* [stackit curl](./stackit_curl.md) - Executes an authenticated HTTP request to an endpoint
* [stackit dns](./stackit_dns.md) - Provides functionality for DNS
* [stackit logme](./stackit_logme.md) - Provides functionality for LogMe
* [stackit mariadb](./stackit_mariadb.md) - Provides functionality for MariaDB
* [stackit mongodbflex](./stackit_mongodbflex.md) - Provides functionality for MongoDB Flex
* [stackit opensearch](./stackit_opensearch.md) - Provides functionality for OpenSearch
* [stackit organization](./stackit_organization.md) - Provides functionality regarding organizations
Expand Down
2 changes: 2 additions & 0 deletions docs/stackit_config_set.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ stackit config set [flags]
```
--dns-custom-endpoint string DNS custom endpoint
-h, --help Help for "stackit config set"
--logme-custom-endpoint string LogMe custom endpoint
--mariadb-custom-endpoint string MariaDB custom endpoint
--membership-custom-endpoint string Membership custom endpoint
--mongodbflex-custom-endpoint string MongoDB Flex custom endpoint
--opensearch-custom-endpoint string OpenSearch custom endpoint
Expand Down
2 changes: 2 additions & 0 deletions docs/stackit_config_unset.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ stackit config unset [flags]
--async Configuration option to run commands asynchronously
--dns-custom-endpoint DNS custom endpoint
-h, --help Help for "stackit config unset"
--logme-custom-endpoint LogMe custom endpoint
--mariadb-custom-endpoint MariaDB custom endpoint
--membership-custom-endpoint Membership custom endpoint
--mongodbflex-custom-endpoint MongoDB Flex custom endpoint
--opensearch-custom-endpoint OpenSearch custom endpoint
Expand Down
34 changes: 34 additions & 0 deletions docs/stackit_logme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## stackit logme

Provides functionality for LogMe

### Synopsis

Provides functionality for LogMe.

```
stackit logme [flags]
```

### Options

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

### 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"]
-p, --project-id string Project ID
```

### SEE ALSO

* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [stackit logme credentials](./stackit_logme_credentials.md) - Provides functionality for LogMe credentials
* [stackit logme instance](./stackit_logme_instance.md) - Provides functionality for LogMe instances
* [stackit logme plans](./stackit_logme_plans.md) - Lists all LogMe service plans

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

Provides functionality for LogMe credentials

### Synopsis

Provides functionality for LogMe credentials.

```
stackit logme credentials [flags]
```

### Options

```
-h, --help Help for "stackit logme 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"]
-p, --project-id string Project ID
```

### SEE ALSO

* [stackit logme](./stackit_logme.md) - Provides functionality for LogMe
* [stackit logme credentials create](./stackit_logme_credentials_create.md) - Creates credentials for a LogMe instance
* [stackit logme credentials delete](./stackit_logme_credentials_delete.md) - Deletes credentials of a LogMe instance
* [stackit logme credentials describe](./stackit_logme_credentials_describe.md) - Shows details of credentials of a LogMe instance
* [stackit logme credentials list](./stackit_logme_credentials_list.md) - Lists all credentials' IDs for a LogMe instance

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

Creates credentials for a LogMe instance

### Synopsis

Creates credentials (username and password) for a LogMe instance.

```
stackit logme credentials create [flags]
```

### Examples

```
Create credentials for a LogMe instance
$ stackit logme credentials create --instance-id xxx

Create credentials for a LogMe instance and hide the password in the output
$ stackit logme credentials create --instance-id xxx --hide-password
```

### Options

```
-h, --help Help for "stackit logme credentials create"
--hide-password Hide password in output
--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"]
-p, --project-id string Project ID
```

### SEE ALSO

* [stackit logme credentials](./stackit_logme_credentials.md) - Provides functionality for LogMe credentials

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

Deletes credentials of a LogMe instance

### Synopsis

Deletes credentials of a LogMe instance.

```
stackit logme credentials delete CREDENTIALS_ID [flags]
```

### Examples

```
Delete credentials with ID "xxx" of LogMe instance with ID "yyy"
$ stackit logme credentials delete xxx --instance-id yyy
```

### Options

```
-h, --help Help for "stackit logme 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"]
-p, --project-id string Project ID
```

### SEE ALSO

* [stackit logme credentials](./stackit_logme_credentials.md) - Provides functionality for LogMe credentials

42 changes: 42 additions & 0 deletions docs/stackit_logme_credentials_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## stackit logme credentials describe

Shows details of credentials of a LogMe instance

### Synopsis

Shows details of credentials of a LogMe instance. The password will be shown in plain text in the output.

```
stackit logme credentials describe CREDENTIALS_ID [flags]
```

### Examples

```
Get details of credentials of a LogMe instance with ID "xxx" from instance with ID "yyy"
$ stackit logme credentials describe xxx --instance-id yyy

Get details of credentials of a LogMe instance with ID "xxx" from instance with ID "yyy" in a table format
$ stackit logme credentials describe xxx --instance-id yyy --output-format pretty
```

### Options

```
-h, --help Help for "stackit logme credentials describe"
--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"]
-p, --project-id string Project ID
```

### SEE ALSO

* [stackit logme credentials](./stackit_logme_credentials.md) - Provides functionality for LogMe credentials

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

Lists all credentials' IDs for a LogMe instance

### Synopsis

Lists all credentials' IDs for a LogMe instance.

```
stackit logme credentials list [flags]
```

### Examples

```
List all credentials' IDs for a LogMe instance
$ stackit logme credentials list --instance-id xxx

List all credentials' IDs for a LogMe instance in JSON format
$ stackit logme credentials list --instance-id xxx --output-format json

List up to 10 credentials' IDs for a LogMe instance
$ stackit logme credentials list --instance-id xxx --limit 10
```

### Options

```
-h, --help Help for "stackit logme 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"]
-p, --project-id string Project ID
```

### SEE ALSO

* [stackit logme credentials](./stackit_logme_credentials.md) - Provides functionality for LogMe credentials

36 changes: 36 additions & 0 deletions docs/stackit_logme_instance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## stackit logme instance

Provides functionality for LogMe instances

### Synopsis

Provides functionality for LogMe instances.

```
stackit logme instance [flags]
```

### Options

```
-h, --help Help for "stackit logme instance"
```

### 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"]
-p, --project-id string Project ID
```

### SEE ALSO

* [stackit logme](./stackit_logme.md) - Provides functionality for LogMe
* [stackit logme instance create](./stackit_logme_instance_create.md) - Creates a LogMe instance
* [stackit logme instance delete](./stackit_logme_instance_delete.md) - Deletes a LogMe instance
* [stackit logme instance describe](./stackit_logme_instance_describe.md) - Shows details of a LogMe instance
* [stackit logme instance list](./stackit_logme_instance_list.md) - Lists all LogMe instances
* [stackit logme instance update](./stackit_logme_instance_update.md) - Updates a LogMe instance

56 changes: 56 additions & 0 deletions docs/stackit_logme_instance_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
## stackit logme instance create

Creates a LogMe instance

### Synopsis

Creates a LogMe instance.

```
stackit logme instance create [flags]
```

### Examples

```
Create a LogMe instance with name "my-instance" and specify plan by name and version
$ stackit logme instance create --name my-instance --plan-name stackit-logme2-1.2.50-replica --version 2

Create a LogMe instance with name "my-instance" and specify plan by ID
$ stackit logme instance create --name my-instance --plan-id xxx

Create a LogMe instance with name "my-instance" and specify IP range which is allowed to access it
$ stackit logme instance create --name my-instance --plan-id xxx --acl 192.168.1.0/24
```

### Options

```
--acl strings List of IP networks in CIDR notation which are allowed to access this instance (default [])
--enable-monitoring Enable monitoring
--graphite string Graphite host
-h, --help Help for "stackit logme instance create"
--metrics-frequency int Metrics frequency
--metrics-prefix string Metrics prefix
--monitoring-instance-id string Monitoring instance ID
-n, --name string Instance name
--plan-id string Plan ID
--plan-name string Plan name
--plugin strings Plugin
--syslog strings Syslog
--version string Instance LogMe version
```

### 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"]
-p, --project-id string Project ID
```

### SEE ALSO

* [stackit logme instance](./stackit_logme_instance.md) - Provides functionality for LogMe instances

Loading