Skip to content

Commit e0d0555

Browse files
authored
Onboard Secrets Manager instance describe and delete commands, update docs (#107)
* Onboard secrets manager: add delete subcommand * Onboarding Secrets Manager: describe command and new docs * Address comments
1 parent a542be8 commit e0d0555

22 files changed

+1142
-2
lines changed

docs/stackit.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ stackit [flags]
3939
* [stackit project](./stackit_project.md) - Provides functionality regarding projects
4040
* [stackit rabbitmq](./stackit_rabbitmq.md) - Provides functionality for RabbitMQ
4141
* [stackit redis](./stackit_redis.md) - Provides functionality for Redis
42+
* [stackit secrets-manager](./stackit_secrets-manager.md) - Provides functionality for Secrets Manager
4243
* [stackit service-account](./stackit_service-account.md) - Provides functionality for service accounts
4344
* [stackit ske](./stackit_ske.md) - Provides functionality for SKE
4445

docs/stackit_config_set.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ stackit config set [flags]
4141
--rabbitmq-custom-endpoint string RabbitMQ API base URL, used in calls to this API
4242
--redis-custom-endpoint string Redis API base URL, used in calls to this API
4343
--resource-manager-custom-endpoint string Resource Manager API base URL, used in calls to this API
44+
--secrets-manager-custom-endpoint string Secrets Manager API base URL, used in calls to this API
4445
--service-account-custom-endpoint string Service Account API base URL, used in calls to this API
4546
--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)
4647
--ske-custom-endpoint string SKE API base URL, used in calls to this API

docs/stackit_config_unset.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ stackit config unset [flags]
4141
--rabbitmq-custom-endpoint RabbitMQ API base URL. If unset, uses the default base URL
4242
--redis-custom-endpoint Redis API base URL. If unset, uses the default base URL
4343
--resource-manager-custom-endpoint Resource Manager API base URL. If unset, uses the default base URL
44+
--secrets-manager-custom-endpoint Secrets Manager API base URL. If unset, uses the default base URL
4445
--service-account-custom-endpoint SKE API base URL. If unset, uses the default base URL
4546
--session-time-limit Maximum time before authentication is required again. If unset, defaults to 2h
4647
--ske-custom-endpoint SKE API base URL. If unset, uses the default base URL

docs/stackit_object-storage.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ stackit object-storage [flags]
2929

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## stackit object-storage credentials-group
2+
3+
Provides functionality for Object Storage credentials group
4+
5+
### Synopsis
6+
7+
Provides functionality for Object Storage credentials group.
8+
9+
```
10+
stackit object-storage credentials-group [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit object-storage credentials-group"
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 object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage
31+
* [stackit object-storage credentials-group create](./stackit_object-storage_credentials-group_create.md) - Creates a credentials group to hold Object Storage access credentials
32+
* [stackit object-storage credentials-group delete](./stackit_object-storage_credentials-group_delete.md) - Deletes a credentials group
33+
* [stackit object-storage credentials-group list](./stackit_object-storage_credentials-group_list.md) - Lists all credentials groups
34+
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## stackit object-storage credentials-group create
2+
3+
Creates a credentials group to hold Object Storage access credentials
4+
5+
### Synopsis
6+
7+
Creates a credentials group to hold Object Storage access credentials.
8+
9+
```
10+
stackit object-storage credentials-group create [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Create credentials group to hold Object Storage access credentials
17+
$ stackit object-storage credentials-group create --name example
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit object-storage credentials-group create"
24+
--name string Name of the group holding credentials
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 object-storage credentials-group](./stackit_object-storage_credentials-group.md) - Provides functionality for Object Storage credentials group
39+
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## stackit object-storage credentials-group delete
2+
3+
Deletes a credentials group
4+
5+
### Synopsis
6+
7+
Deletes a credentials group. Only possible if there are no valid credentials (access-keys) left in the group, otherwise it will throw an error.
8+
9+
```
10+
stackit object-storage credentials-group delete CREDENTIALS_GROUP_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Delete a credentials group with ID "xxx"
17+
$ stackit object-storage credentials-group delete xxx
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit object-storage credentials-group delete"
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
-y, --assume-yes If set, skips all confirmation prompts
30+
--async If set, runs the command asynchronously
31+
-o, --output-format string Output format, one of ["json" "pretty"]
32+
-p, --project-id string Project ID
33+
```
34+
35+
### SEE ALSO
36+
37+
* [stackit object-storage credentials-group](./stackit_object-storage_credentials-group.md) - Provides functionality for Object Storage credentials group
38+
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## stackit object-storage credentials-group list
2+
3+
Lists all credentials groups
4+
5+
### Synopsis
6+
7+
Lists all credentials groups.
8+
9+
```
10+
stackit object-storage credentials-group list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
List all credentials groups
17+
$ stackit object-storage credentials-group list
18+
19+
List all credentials groups in JSON format
20+
$ stackit object-storage credentials-group list --output-format json
21+
22+
List up to 10 credentials groups
23+
$ stackit object-storage credentials-group list --limit 10
24+
```
25+
26+
### Options
27+
28+
```
29+
-h, --help Help for "stackit object-storage credentials-group list"
30+
--limit int Maximum number of entries to list
31+
```
32+
33+
### Options inherited from parent commands
34+
35+
```
36+
-y, --assume-yes If set, skips all confirmation prompts
37+
--async If set, runs the command asynchronously
38+
-o, --output-format string Output format, one of ["json" "pretty"]
39+
-p, --project-id string Project ID
40+
```
41+
42+
### SEE ALSO
43+
44+
* [stackit object-storage credentials-group](./stackit_object-storage_credentials-group.md) - Provides functionality for Object Storage credentials group
45+

docs/stackit_object-storage_disable.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Disables Object Storage for a project
44

55
### Synopsis
66

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

99
```
1010
stackit object-storage disable [flags]
@@ -13,7 +13,7 @@ stackit object-storage disable [flags]
1313
### Examples
1414

1515
```
16-
Disable Object Storage functionality for your project, deleting all associated buckets
16+
Disable Object Storage functionality for your project.
1717
$ stackit object-storage disable
1818
```
1919

docs/stackit_secrets-manager.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## stackit secrets-manager
2+
3+
Provides functionality for Secrets Manager
4+
5+
### Synopsis
6+
7+
Provides functionality for Secrets Manager.
8+
9+
```
10+
stackit secrets-manager [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit secrets-manager"
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 secrets-manager instance](./stackit_secrets-manager_instance.md) - Provides functionality for Secrets Manager instances
32+

0 commit comments

Comments
 (0)