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 Secrets Manager instance describe and delete commands, update docs #107

Merged
merged 3 commits into from
Mar 5, 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
1 change: 1 addition & 0 deletions docs/stackit.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ stackit [flags]
* [stackit project](./stackit_project.md) - Provides functionality regarding projects
* [stackit rabbitmq](./stackit_rabbitmq.md) - Provides functionality for RabbitMQ
* [stackit redis](./stackit_redis.md) - Provides functionality for Redis
* [stackit secrets-manager](./stackit_secrets-manager.md) - Provides functionality for Secrets Manager
* [stackit service-account](./stackit_service-account.md) - Provides functionality for service accounts
* [stackit ske](./stackit_ske.md) - Provides functionality for SKE

1 change: 1 addition & 0 deletions docs/stackit_config_set.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ stackit config set [flags]
--rabbitmq-custom-endpoint string RabbitMQ API base URL, used in calls to this API
--redis-custom-endpoint string Redis API base URL, used in calls to this API
--resource-manager-custom-endpoint string Resource Manager API base URL, used in calls to this API
--secrets-manager-custom-endpoint string Secrets Manager API base URL, used in calls to this API
--service-account-custom-endpoint string Service Account API base URL, used in calls to this API
--session-time-limit string Maximum time before authentication is required again. After this time, you will be prompted to login again to execute commands that require authentication. Can't be larger than 24h. Requires authentication after being set to take effect. Examples: 3h, 5h30m40s (BETA: currently values greater than 2h have no effect)
--ske-custom-endpoint string SKE API base URL, used in calls to this API
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 @@ -41,6 +41,7 @@ stackit config unset [flags]
--rabbitmq-custom-endpoint RabbitMQ API base URL. If unset, uses the default base URL
--redis-custom-endpoint Redis API base URL. If unset, uses the default base URL
--resource-manager-custom-endpoint Resource Manager API base URL. If unset, uses the default base URL
--secrets-manager-custom-endpoint Secrets Manager API base URL. If unset, uses the default base URL
--service-account-custom-endpoint SKE API base URL. If unset, uses the default base URL
--session-time-limit Maximum time before authentication is required again. If unset, defaults to 2h
--ske-custom-endpoint SKE API base URL. If unset, uses the default base URL
Expand Down
1 change: 1 addition & 0 deletions docs/stackit_object-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ stackit object-storage [flags]

* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [stackit object-storage bucket](./stackit_object-storage_bucket.md) - Provides functionality for Object Storage buckets
* [stackit object-storage credentials-group](./stackit_object-storage_credentials-group.md) - Provides functionality for Object Storage credentials group
* [stackit object-storage disable](./stackit_object-storage_disable.md) - Disables Object Storage for a project
* [stackit object-storage enable](./stackit_object-storage_enable.md) - Enables Object Storage for a project

34 changes: 34 additions & 0 deletions docs/stackit_object-storage_credentials-group.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## stackit object-storage credentials-group

Provides functionality for Object Storage credentials group

### Synopsis

Provides functionality for Object Storage credentials group.

```
stackit object-storage credentials-group [flags]
```

### Options

```
-h, --help Help for "stackit object-storage credentials-group"
```

### 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 object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage
* [stackit object-storage credentials-group create](./stackit_object-storage_credentials-group_create.md) - Creates a credentials group to hold Object Storage access credentials
* [stackit object-storage credentials-group delete](./stackit_object-storage_credentials-group_delete.md) - Deletes a credentials group
* [stackit object-storage credentials-group list](./stackit_object-storage_credentials-group_list.md) - Lists all credentials groups

39 changes: 39 additions & 0 deletions docs/stackit_object-storage_credentials-group_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## stackit object-storage credentials-group create

Creates a credentials group to hold Object Storage access credentials

### Synopsis

Creates a credentials group to hold Object Storage access credentials.

```
stackit object-storage credentials-group create [flags]
```

### Examples

```
Create credentials group to hold Object Storage access credentials
$ stackit object-storage credentials-group create --name example
```

### Options

```
-h, --help Help for "stackit object-storage credentials-group create"
--name string Name of the group holding 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 object-storage credentials-group](./stackit_object-storage_credentials-group.md) - Provides functionality for Object Storage credentials group

38 changes: 38 additions & 0 deletions docs/stackit_object-storage_credentials-group_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## stackit object-storage credentials-group delete

Deletes a credentials group

### Synopsis

Deletes a credentials group. Only possible if there are no valid credentials (access-keys) left in the group, otherwise it will throw an error.

```
stackit object-storage credentials-group delete CREDENTIALS_GROUP_ID [flags]
```

### Examples

```
Delete a credentials group with ID "xxx"
$ stackit object-storage credentials-group delete xxx
```

### Options

```
-h, --help Help for "stackit object-storage credentials-group delete"
```

### 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 object-storage credentials-group](./stackit_object-storage_credentials-group.md) - Provides functionality for Object Storage credentials group

45 changes: 45 additions & 0 deletions docs/stackit_object-storage_credentials-group_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## stackit object-storage credentials-group list

Lists all credentials groups

### Synopsis

Lists all credentials groups.

```
stackit object-storage credentials-group list [flags]
```

### Examples

```
List all credentials groups
$ stackit object-storage credentials-group list

List all credentials groups in JSON format
$ stackit object-storage credentials-group list --output-format json

List up to 10 credentials groups
$ stackit object-storage credentials-group list --limit 10
```

### Options

```
-h, --help Help for "stackit object-storage credentials-group list"
--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 object-storage credentials-group](./stackit_object-storage_credentials-group.md) - Provides functionality for Object Storage credentials group

4 changes: 2 additions & 2 deletions docs/stackit_object-storage_disable.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Disables Object Storage for a project

### Synopsis

Disables Object Storage for a project. It will delete all associated buckets.
Disables Object Storage for a project. All buckets must be deleted beforehand.

```
stackit object-storage disable [flags]
Expand All @@ -13,7 +13,7 @@ stackit object-storage disable [flags]
### Examples

```
Disable Object Storage functionality for your project, deleting all associated buckets
Disable Object Storage functionality for your project.
$ stackit object-storage disable
```

Expand Down
32 changes: 32 additions & 0 deletions docs/stackit_secrets-manager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## stackit secrets-manager

Provides functionality for Secrets Manager

### Synopsis

Provides functionality for Secrets Manager.

```
stackit secrets-manager [flags]
```

### Options

```
-h, --help Help for "stackit secrets-manager"
```

### 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 secrets-manager instance](./stackit_secrets-manager_instance.md) - Provides functionality for Secrets Manager instances

35 changes: 35 additions & 0 deletions docs/stackit_secrets-manager_instance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## stackit secrets-manager instance

Provides functionality for Secrets Manager instances

### Synopsis

Provides functionality for Secrets Manager instances.

```
stackit secrets-manager instance [flags]
```

### Options

```
-h, --help Help for "stackit secrets-manager 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 secrets-manager](./stackit_secrets-manager.md) - Provides functionality for Secrets Manager
* [stackit secrets-manager instance create](./stackit_secrets-manager_instance_create.md) - Creates a Secrets Manager instance
* [stackit secrets-manager instance delete](./stackit_secrets-manager_instance_delete.md) - Deletes a Secrets Manager instance
* [stackit secrets-manager instance describe](./stackit_secrets-manager_instance_describe.md) - Shows details of a Secrets Manager instance
* [stackit secrets-manager instance list](./stackit_secrets-manager_instance_list.md) - Lists all Secrets Manager instances

39 changes: 39 additions & 0 deletions docs/stackit_secrets-manager_instance_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## stackit secrets-manager instance create

Creates a Secrets Manager instance

### Synopsis

Creates a Secrets Manager instance.

```
stackit secrets-manager instance create [flags]
```

### Examples

```
Create a Secrets Manager instance with name "my-instance"
$ stackit secrets-manager instance create --name my-instance
```

### Options

```
-h, --help Help for "stackit secrets-manager instance create"
-n, --name string Instance name
```

### 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 secrets-manager instance](./stackit_secrets-manager_instance.md) - Provides functionality for Secrets Manager instances

38 changes: 38 additions & 0 deletions docs/stackit_secrets-manager_instance_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## stackit secrets-manager instance delete

Deletes a Secrets Manager instance

### Synopsis

Deletes a Secrets Manager instance.

```
stackit secrets-manager instance delete INSTANCE_ID [flags]
```

### Examples

```
Delete a Secrets Manager instance with ID "xxx"
$ stackit secrets-manager instance delete xxx
```

### Options

```
-h, --help Help for "stackit secrets-manager instance delete"
```

### 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 secrets-manager instance](./stackit_secrets-manager_instance.md) - Provides functionality for Secrets Manager instances

41 changes: 41 additions & 0 deletions docs/stackit_secrets-manager_instance_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## stackit secrets-manager instance describe

Shows details of a Secrets Manager instance

### Synopsis

Shows details of a Secrets Manager instance.

```
stackit secrets-manager instance describe INSTANCE_ID [flags]
```

### Examples

```
Get details of a Secrets Manager instance with ID "xxx"
$ stackit secrets-manager instance describe xxx

Get details of a Secrets Manager instance with ID "xxx" in a table format
$ stackit secrets-manager instance describe xxx --output-format pretty
```

### Options

```
-h, --help Help for "stackit secrets-manager instance describe"
```

### 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 secrets-manager instance](./stackit_secrets-manager_instance.md) - Provides functionality for Secrets Manager instances

Loading