Skip to content

Commit 42723d0

Browse files
joaopaletjoaopalet
authored
Onboard OpenSearch service (#41)
* Onboard OpenSearch service * Update docs * Adjustments after review * Explicitly set service name instead pf getting it from parent * Restore line accidentally deleted * Remove changes belonging to other branch * Update module name in imports * Adjustments after review * Make OpenSearch client interface private and credentials plural * Rename last usages of credential to credentials * Remove restrictions from configureFlags to show custom errors in parseInput
1 parent 26895e2 commit 42723d0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+5139
-12
lines changed

‎.goreleaser.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,4 +94,4 @@ snapcrafts:
9494
description: "A command-line interface to manage STACKIT resources.\nThis CLI is in a BETA state. More services and functionality will be supported soon."
9595
license: Apache-2.0
9696
# Will only publish to `edge` and `beta` channels
97-
grade: devel
97+
grade: devel

‎docs/stackit.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
Manage STACKIT resources using the command line
44

5+
### Synopsis
6+
7+
Manage STACKIT resources using the command line.
8+
This CLI is in a BETA state.
9+
More services and functionality will be supported soon. Your feedback is appreciated!
10+
511
```
612
stackit [flags]
713
```
@@ -24,6 +30,7 @@ stackit [flags]
2430
* [stackit curl](./stackit_curl.md) - Execute an authenticated HTTP request to an endpoint
2531
* [stackit dns](./stackit_dns.md) - Provides functionality for DNS
2632
* [stackit mongodbflex](./stackit_mongodbflex.md) - Provides functionality for MongoDB Flex
33+
* [stackit opensearch](./stackit_opensearch.md) - Provides functionality for OpenSearch
2734
* [stackit organization](./stackit_organization.md) - Provides functionality regarding organizations
2835
* [stackit project](./stackit_project.md) - Provides functionality regarding projects
2936
* [stackit service-account](./stackit_service-account.md) - Provides functionality for service accounts

‎docs/stackit_config_set.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ stackit config set [flags]
3333
-h, --help Help for "stackit config set"
3434
--membership-custom-endpoint string Membership custom endpoint
3535
--mongodbflex-custom-endpoint string MongoDB Flex custom endpoint
36+
--opensearch-custom-endpoint string OpenSearch custom endpoint
3637
--resource-manager-custom-endpoint string Resource manager custom endpoint
3738
--service-account-custom-endpoint string Service Account custom endpoint
3839
--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)

‎docs/stackit_config_unset.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ stackit config unset [flags]
3131
-h, --help Help for "stackit config unset"
3232
--membership-custom-endpoint Membership custom endpoint
3333
--mongodbflex-custom-endpoint MongoDB Flex custom endpoint
34+
--opensearch-custom-endpoint OpenSearch custom endpoint
3435
--output-format Output format
3536
--project-id Project ID
3637
--resource-manager-custom-endpoint Resource Manager custom endpoint

‎docs/stackit_opensearch.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## stackit opensearch
2+
3+
Provides functionality for OpenSearch
4+
5+
### Synopsis
6+
7+
Provides functionality for OpenSearch
8+
9+
```
10+
stackit opensearch [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit opensearch"
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"]
25+
-p, --project-id string Project ID
26+
```
27+
28+
### SEE ALSO
29+
30+
* [stackit](./stackit.md) - Manage STACKIT resources using the command line
31+
* [stackit opensearch credentials](./stackit_opensearch_credentials.md) - Provides functionality for OpenSearch credentials
32+
* [stackit opensearch instance](./stackit_opensearch_instance.md) - Provides functionality for OpenSearch instances
33+
* [stackit opensearch plans](./stackit_opensearch_plans.md) - List all OpenSearch service plans
34+

‎docs/stackit_opensearch_credentials.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## stackit opensearch credentials
2+
3+
Provides functionality for OpenSearch credentials
4+
5+
### Synopsis
6+
7+
Provides functionality for OpenSearch credentials
8+
9+
```
10+
stackit opensearch credentials [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit opensearch 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"]
25+
-p, --project-id string Project ID
26+
```
27+
28+
### SEE ALSO
29+
30+
* [stackit opensearch](./stackit_opensearch.md) - Provides functionality for OpenSearch
31+
* [stackit opensearch credentials create](./stackit_opensearch_credentials_create.md) - Create credentials for an OpenSearch instance
32+
* [stackit opensearch credentials delete](./stackit_opensearch_credentials_delete.md) - Delete credentials of an OpenSearch instance
33+
* [stackit opensearch credentials describe](./stackit_opensearch_credentials_describe.md) - Get details of credentials of an OpenSearch instance
34+
* [stackit opensearch credentials list](./stackit_opensearch_credentials_list.md) - List all credentials' IDs for an OpenSearch instance
35+

‎docs/stackit_opensearch_credentials_create.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## stackit opensearch credentials create
2+
3+
Create credentials for an OpenSearch instance
4+
5+
### Synopsis
6+
7+
Create credentials (username and password) for an OpenSearch instance
8+
9+
```
10+
stackit opensearch credentials create [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Create credentials for an OpenSearch instance
17+
$ stackit opensearch credentials create --instance-id xxx
18+
19+
Create credentials for an OpenSearch instance and hide the password in the output
20+
$ stackit opensearch credentials create --instance-id xxx --hide-password
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit opensearch credentials create"
27+
--hide-password Hide password in output
28+
--instance-id string Instance ID
29+
```
30+
31+
### Options inherited from parent commands
32+
33+
```
34+
-y, --assume-yes If set, skips all confirmation prompts
35+
--async If set, runs the command asynchronously
36+
-o, --output-format string Output format, one of ["json" "pretty"]
37+
-p, --project-id string Project ID
38+
```
39+
40+
### SEE ALSO
41+
42+
* [stackit opensearch credentials](./stackit_opensearch_credentials.md) - Provides functionality for OpenSearch credentials
43+

‎docs/stackit_opensearch_credentials_delete.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## stackit opensearch credentials delete
2+
3+
Delete credentials of an OpenSearch instance
4+
5+
### Synopsis
6+
7+
Delete credentials of an OpenSearch instance
8+
9+
```
10+
stackit opensearch credentials delete CREDENTIALS_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Delete credentials with ID "xxx" of OpenSearch instance with ID "yyy"
17+
$ stackit opensearch credentials delete xxx --instance-id yyy
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit opensearch 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"]
33+
-p, --project-id string Project ID
34+
```
35+
36+
### SEE ALSO
37+
38+
* [stackit opensearch credentials](./stackit_opensearch_credentials.md) - Provides functionality for OpenSearch credentials
39+

‎docs/stackit_opensearch_credentials_describe.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## stackit opensearch credentials describe
2+
3+
Get details of credentials of an OpenSearch instance
4+
5+
### Synopsis
6+
7+
Get details of credentials of an OpenSearch instance. The password will be shown in plain text in the output.
8+
9+
```
10+
stackit opensearch credentials describe CREDENTIALS_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Get details of credentials of an OpenSearch instance with ID "xxx" from instance with ID "yyy"
17+
$ stackit opensearch credentials describe xxx --instance-id yyy
18+
19+
Get details of credentials of an OpenSearch instance with ID "xxx" from instance with ID "yyy" in a table format
20+
$ stackit opensearch credentials describe xxx --instance-id yyy --output-format pretty
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit opensearch credentials describe"
27+
--instance-id string Instance ID
28+
```
29+
30+
### Options inherited from parent commands
31+
32+
```
33+
-y, --assume-yes If set, skips all confirmation prompts
34+
--async If set, runs the command asynchronously
35+
-o, --output-format string Output format, one of ["json" "pretty"]
36+
-p, --project-id string Project ID
37+
```
38+
39+
### SEE ALSO
40+
41+
* [stackit opensearch credentials](./stackit_opensearch_credentials.md) - Provides functionality for OpenSearch credentials
42+

‎docs/stackit_opensearch_credentials_list.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## stackit opensearch credentials list
2+
3+
List all credentials' IDs for an OpenSearch instance
4+
5+
### Synopsis
6+
7+
List all credentials' IDs for an OpenSearch instance
8+
9+
```
10+
stackit opensearch credentials list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
List all credentials' IDs for an OpenSearch instance
17+
$ stackit opensearch credentials list --instance-id xxx
18+
19+
List all credentials' IDs for an OpenSearch instance in JSON format
20+
$ stackit opensearch credentials list --instance-id xxx --output-format json
21+
22+
List up to 10 credentials' IDs for an OpenSearch instance
23+
$ stackit opensearch credentials list --instance-id xxx --limit 10
24+
```
25+
26+
### Options
27+
28+
```
29+
-h, --help Help for "stackit opensearch 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"]
40+
-p, --project-id string Project ID
41+
```
42+
43+
### SEE ALSO
44+
45+
* [stackit opensearch credentials](./stackit_opensearch_credentials.md) - Provides functionality for OpenSearch credentials
46+

0 commit comments

Comments
 (0)