Update docs

stackitcloud · Jan 30, 2024 · 18076ef · 18076ef
1 parent 97f1a59
commit 18076ef
Show file tree

Hide file tree

Showing 16 changed files with 561 additions and 0 deletions.
diff --git a/docs/stackit.md b/docs/stackit.md
@@ -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]
 ```
@@ -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

diff --git a/docs/stackit_config_set.md b/docs/stackit_config_set.md
@@ -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)

diff --git a/docs/stackit_config_unset.md b/docs/stackit_config_unset.md
@@ -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

diff --git a/docs/stackit_opensearch.md b/docs/stackit_opensearch.md
@@ -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
+
diff --git a/docs/stackit_opensearch_credentials.md b/docs/stackit_opensearch_credentials.md
@@ -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
+
diff --git a/docs/stackit_opensearch_credentials_create.md b/docs/stackit_opensearch_credentials_create.md
@@ -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
+
diff --git a/docs/stackit_opensearch_credentials_delete.md b/docs/stackit_opensearch_credentials_delete.md
@@ -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 CREDENTIAL_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
+
diff --git a/docs/stackit_opensearch_credentials_describe.md b/docs/stackit_opensearch_credentials_describe.md
@@ -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 CREDENTIAL_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
+
diff --git a/docs/stackit_opensearch_credentials_list.md b/docs/stackit_opensearch_credentials_list.md
@@ -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
+
diff --git a/docs/stackit_opensearch_instance.md b/docs/stackit_opensearch_instance.md
@@ -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
+
diff --git a/docs/stackit_opensearch_instance_create.md b/docs/stackit_opensearch_instance_create.md
@@ -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-qa-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
+