Skip to content
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

Onboard OpenSearch service #41

Merged
merged 12 commits into from
Feb 5, 2024
2 changes: 1 addition & 1 deletion .goreleaser.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,4 @@ snapcrafts:
description: "A command-line interface to manage STACKIT resources.\nThis CLI is in a BETA state. More services and functionality will be supported soon."
license: Apache-2.0
# Will only publish to `edge` and `beta` channels
grade: devel
grade: devel
7 changes: 7 additions & 0 deletions docs/stackit.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

Manage STACKIT resources using the command line

### Synopsis

Manage STACKIT resources using the command line.
This CLI is in a BETA state.
More services and functionality will be supported soon. Your feedback is appreciated!

```
stackit [flags]
```
Expand All @@ -24,6 +30,7 @@ stackit [flags]
* [stackit curl](./stackit_curl.md) - Execute an authenticated HTTP request to an endpoint
* [stackit dns](./stackit_dns.md) - Provides functionality for DNS
* [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
* [stackit project](./stackit_project.md) - Provides functionality regarding projects
* [stackit service-account](./stackit_service-account.md) - Provides functionality for service accounts
Expand Down
1 change: 1 addition & 0 deletions docs/stackit_config_set.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ stackit config set [flags]
-h, --help Help for "stackit config set"
--membership-custom-endpoint string Membership custom endpoint
--mongodbflex-custom-endpoint string MongoDB Flex custom endpoint
--opensearch-custom-endpoint string OpenSearch custom endpoint
--resource-manager-custom-endpoint string Resource manager custom endpoint
--service-account-custom-endpoint string Service Account custom endpoint
--session-time-limit string Maximum time before authentication is required again. Can't be larger than 24h. Examples: 3h, 5h30m40s (BETA: currently values greater than 2h have no effect)
Expand Down
1 change: 1 addition & 0 deletions docs/stackit_config_unset.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ stackit config unset [flags]
-h, --help Help for "stackit config unset"
--membership-custom-endpoint Membership custom endpoint
--mongodbflex-custom-endpoint MongoDB Flex custom endpoint
--opensearch-custom-endpoint OpenSearch custom endpoint
--output-format Output format
--project-id Project ID
--resource-manager-custom-endpoint Resource Manager custom endpoint
Expand Down
34 changes: 34 additions & 0 deletions docs/stackit_opensearch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## stackit opensearch

Provides functionality for OpenSearch

### Synopsis

Provides functionality for OpenSearch

```
stackit opensearch [flags]
```

### Options

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

### 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 opensearch credentials](./stackit_opensearch_credentials.md) - Provides functionality for OpenSearch credentials
* [stackit opensearch instance](./stackit_opensearch_instance.md) - Provides functionality for OpenSearch instances
* [stackit opensearch plans](./stackit_opensearch_plans.md) - List all OpenSearch service plans

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

Provides functionality for OpenSearch credentials

### Synopsis

Provides functionality for OpenSearch credentials

```
stackit opensearch credentials [flags]
```

### Options

```
-h, --help Help for "stackit opensearch 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 opensearch](./stackit_opensearch.md) - Provides functionality for OpenSearch
* [stackit opensearch credentials create](./stackit_opensearch_credentials_create.md) - Create credentials for an OpenSearch instance
* [stackit opensearch credentials delete](./stackit_opensearch_credentials_delete.md) - Delete credentials of an OpenSearch instance
* [stackit opensearch credentials describe](./stackit_opensearch_credentials_describe.md) - Get details of credentials of an OpenSearch instance
* [stackit opensearch credentials list](./stackit_opensearch_credentials_list.md) - List all credentials' IDs for an OpenSearch instance

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

Create credentials for an OpenSearch instance

### Synopsis

Create credentials (username and password) for an OpenSearch instance

```
stackit opensearch credentials create [flags]
```

### Examples

```
Create credentials for an OpenSearch instance
$ stackit opensearch credentials create --instance-id xxx

Create credentials for an OpenSearch instance and hide the password in the output
$ stackit opensearch credentials create --instance-id xxx --hide-password
```

### Options

```
-h, --help Help for "stackit opensearch 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 opensearch credentials](./stackit_opensearch_credentials.md) - Provides functionality for OpenSearch credentials

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

Delete credentials of an OpenSearch instance

### Synopsis

Delete credentials of an OpenSearch instance

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

### Examples

```
Delete credentials with ID "xxx" of OpenSearch instance with ID "yyy"
$ stackit opensearch credentials delete xxx --instance-id yyy
```

### Options

```
-h, --help Help for "stackit opensearch 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 opensearch credentials](./stackit_opensearch_credentials.md) - Provides functionality for OpenSearch credentials

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

Get details of credentials of an OpenSearch instance

### Synopsis

Get details of credentials of an OpenSearch instance. The password will be shown in plain text in the output.

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

### Examples

```
Get details of credentials of an OpenSearch instance with ID "xxx" from instance with ID "yyy"
$ stackit opensearch credentials describe xxx --instance-id yyy

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

### Options

```
-h, --help Help for "stackit opensearch 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 opensearch credentials](./stackit_opensearch_credentials.md) - Provides functionality for OpenSearch credentials

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

List all credentials' IDs for an OpenSearch instance

### Synopsis

List all credentials' IDs for an OpenSearch instance

```
stackit opensearch credentials list [flags]
```

### Examples

```
List all credentials' IDs for an OpenSearch instance
$ stackit opensearch credentials list --instance-id xxx

List all credentials' IDs for an OpenSearch instance in JSON format
$ stackit opensearch credentials list --instance-id xxx --output-format json

List up to 10 credentials' IDs for an OpenSearch instance
$ stackit opensearch credentials list --instance-id xxx --limit 10
```

### Options

```
-h, --help Help for "stackit opensearch 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 opensearch credentials](./stackit_opensearch_credentials.md) - Provides functionality for OpenSearch credentials

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

Provides functionality for OpenSearch instances

### Synopsis

Provides functionality for OpenSearch instances

```
stackit opensearch instance [flags]
```

### Options

```
-h, --help Help for "stackit opensearch 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 opensearch](./stackit_opensearch.md) - Provides functionality for OpenSearch
* [stackit opensearch instance create](./stackit_opensearch_instance_create.md) - Create an OpenSearch instance
* [stackit opensearch instance delete](./stackit_opensearch_instance_delete.md) - Delete an OpenSearch instance
* [stackit opensearch instance describe](./stackit_opensearch_instance_describe.md) - Get details of an OpenSearch instance
* [stackit opensearch instance list](./stackit_opensearch_instance_list.md) - List all OpenSearch instances
* [stackit opensearch instance update](./stackit_opensearch_instance_update.md) - Updates an OpenSearch instance

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

Create an OpenSearch instance

### Synopsis

Create an OpenSearch instance.

```
stackit opensearch instance create [flags]
```

### Examples

```
Create an OpenSearch instance with name "my-instance" and specify plan by name and version
$ stackit opensearch instance create --name my-instance --plan-name stackit-opensearch-1.2.10-replica --version 2

Create an OpenSearch instance with name "my-instance" and specify plan by ID
$ stackit opensearch instance create --name my-instance --plan-id xxx

Create an OpenSearch instance with name "my-instance" and specify IP range which is allowed to access it
$ stackit opensearch 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 opensearch 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 OpenSearch 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 opensearch instance](./stackit_opensearch_instance.md) - Provides functionality for OpenSearch instances

Loading
Loading