Skip to content

Commit 1c4301d

Browse files
author
Jan Sternagel
committed
added generated documentation updates
1 parent 13bbc8c commit 1c4301d

25 files changed

+931
-0
lines changed

‎docs/stackit_beta.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,6 @@ stackit beta [flags]
4242

4343
* [stackit](./stackit.md) - Manage STACKIT resources using the command line
4444
* [stackit beta alb](./stackit_beta_alb.md) - Manages application loadbalancers
45+
* [stackit beta kms](./stackit_beta_kms.md) - Provides functionality for KMS
4546
* [stackit beta sqlserverflex](./stackit_beta_sqlserverflex.md) - Provides functionality for SQLServer Flex
4647

‎docs/stackit_beta_kms.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## stackit beta kms
2+
3+
Provides functionality for KMS
4+
5+
### Synopsis
6+
7+
Provides functionality for KMS.
8+
9+
```
10+
stackit beta kms [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit beta kms"
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" "none" "yaml"]
25+
-p, --project-id string Project ID
26+
--region string Target region for region-specific requests
27+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
28+
```
29+
30+
### SEE ALSO
31+
32+
* [stackit beta](./stackit_beta.md) - Contains beta STACKIT CLI commands
33+
* [stackit beta kms key](./stackit_beta_kms_key.md) - Manage KMS Keys
34+
* [stackit beta kms keyring](./stackit_beta_kms_keyring.md) - Manage KMS Keyrings
35+
* [stackit beta kms version](./stackit_beta_kms_version.md) - Manage KMS Key versions
36+
* [stackit beta kms wrappingkey](./stackit_beta_kms_wrappingkey.md) - Manage KMS Wrapping Keys
37+

‎docs/stackit_beta_kms_key.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## stackit beta kms key
2+
3+
Manage KMS Keys
4+
5+
### Synopsis
6+
7+
Provides CRUD functionality for Key operations inside the KMS
8+
9+
```
10+
stackit beta kms key [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit beta kms key"
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" "none" "yaml"]
25+
-p, --project-id string Project ID
26+
--region string Target region for region-specific requests
27+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
28+
```
29+
30+
### SEE ALSO
31+
32+
* [stackit beta kms](./stackit_beta_kms.md) - Provides functionality for KMS
33+
* [stackit beta kms key create](./stackit_beta_kms_key_create.md) - Creates a KMS Key
34+
* [stackit beta kms key delete](./stackit_beta_kms_key_delete.md) - Deletes a KMS Key
35+
* [stackit beta kms key import](./stackit_beta_kms_key_import.md) - Import a KMS Key Version
36+
* [stackit beta kms key list](./stackit_beta_kms_key_list.md) - Lists all KMS Keys
37+
* [stackit beta kms key restore](./stackit_beta_kms_key_restore.md) - Resotre a Key
38+
* [stackit beta kms key rotate](./stackit_beta_kms_key_rotate.md) - Rotate a key
39+

‎docs/stackit_beta_kms_key_create.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
## stackit beta kms key create
2+
3+
Creates a KMS Key
4+
5+
### Synopsis
6+
7+
Creates a KMS Key.
8+
9+
```
10+
stackit beta kms key create [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Create a Symmetric KMS Key
17+
$ stakit beta kms key create --key-ring "my-keyring-id" --algorithm "rsa_2048_oaep_sha256" --name "my-key-name" --purpose "symmetric_encrypt_decrypt"
18+
19+
Create a Message Authentication KMS Key
20+
$ stakit beta kms key create --key-ring "my-keyring-id" --algorithm "hmac_sha512" --name "my-key-name" --purpose "message_authentication_code"
21+
```
22+
23+
### Options
24+
25+
```
26+
--algorithm string En-/Decryption / signing algorithm
27+
--backend string The backend that is responsible for maintaining this key (default "software")
28+
--description string Optinal description of the Key
29+
-h, --help Help for "stackit beta kms key create"
30+
--import-only States whether versions can be created or only imported
31+
--key-ring string ID of the KMS Key Ring
32+
--name string The display name to distinguish multiple keys
33+
--purpose string Purpose of the Key. Enum: 'symmetric_encrypt_decrypt', 'asymmetric_encrypt_decrypt', 'message_authentication_code', 'asymmetric_sign_verify'
34+
```
35+
36+
### Options inherited from parent commands
37+
38+
```
39+
-y, --assume-yes If set, skips all confirmation prompts
40+
--async If set, runs the command asynchronously
41+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
42+
-p, --project-id string Project ID
43+
--region string Target region for region-specific requests
44+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
45+
```
46+
47+
### SEE ALSO
48+
49+
* [stackit beta kms key](./stackit_beta_kms_key.md) - Manage KMS Keys
50+

‎docs/stackit_beta_kms_key_delete.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## stackit beta kms key delete
2+
3+
Deletes a KMS Key
4+
5+
### Synopsis
6+
7+
Deletes a KMS Key inside a specific Key Ring.
8+
9+
```
10+
stackit beta kms key delete [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Delete a KMS Key "my-key-id" inside the Key Ring "my-key-ring-id"
17+
$ stackit beta kms keyring delete --key-ring "my-key-ring-id" --key "my-key-id"
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit beta kms key delete"
24+
--key string ID of the actual Key
25+
--key-ring string ID of the KMS Key Ring where the Key is stored
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-y, --assume-yes If set, skips all confirmation prompts
32+
--async If set, runs the command asynchronously
33+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
34+
-p, --project-id string Project ID
35+
--region string Target region for region-specific requests
36+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
37+
```
38+
39+
### SEE ALSO
40+
41+
* [stackit beta kms key](./stackit_beta_kms_key.md) - Manage KMS Keys
42+

‎docs/stackit_beta_kms_key_import.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## stackit beta kms key import
2+
3+
Import a KMS Key Version
4+
5+
### Synopsis
6+
7+
Improt a new version to the given KMS key.
8+
9+
```
10+
stackit beta kms key import [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Import a new version for the given KMS Key "my-key"
17+
$ stakit beta kms key improt --key-ring "my-keyring-id" --key "my-key-id" --wrapped-key "base64-encoded-wrapped-key-material" --wrapping-key-id "my-wrapping-key-id"
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit beta kms key import"
24+
--key string ID of the KMS Key
25+
--key-ring string ID of the KMS Key Ring
26+
--wrapped-key string The wrapped key material that has to be imported. Encoded in base64
27+
--wrapping-key-id string he unique id of the wrapping key the key material has been wrapped with
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" "none" "yaml"]
36+
-p, --project-id string Project ID
37+
--region string Target region for region-specific requests
38+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
39+
```
40+
41+
### SEE ALSO
42+
43+
* [stackit beta kms key](./stackit_beta_kms_key.md) - Manage KMS Keys
44+

‎docs/stackit_beta_kms_key_list.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## stackit beta kms key list
2+
3+
Lists all KMS Keys
4+
5+
### Synopsis
6+
7+
Lists all KMS Keys inside a key ring.
8+
9+
```
10+
stackit beta kms key list KEYRING_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
List all KMS Keys for the key ring "xxx"
17+
$ stackit beta kms key list xxx
18+
19+
List all KMS Keys in JSON format
20+
$ stackit beta kms key list xxx --output-format json
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit beta kms key list"
27+
```
28+
29+
### Options inherited from parent commands
30+
31+
```
32+
-y, --assume-yes If set, skips all confirmation prompts
33+
--async If set, runs the command asynchronously
34+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
35+
-p, --project-id string Project ID
36+
--region string Target region for region-specific requests
37+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
38+
```
39+
40+
### SEE ALSO
41+
42+
* [stackit beta kms key](./stackit_beta_kms_key.md) - Manage KMS Keys
43+

‎docs/stackit_beta_kms_key_restore.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## stackit beta kms key restore
2+
3+
Resotre a Key
4+
5+
### Synopsis
6+
7+
Restores the given key from being deleted.
8+
9+
```
10+
stackit beta kms key restore [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Restore a KMS Key "my-key-id" inside the Key Ring "my-key-ring-id" that was scheduled for deletion.
17+
$ stackit beta kms keyring restore --key-ring "my-key-ring-id" --key "my-key-id"
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit beta kms key restore"
24+
--key string ID of the actual Key
25+
--key-ring string ID of the KMS Key Ring where the Key is stored
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-y, --assume-yes If set, skips all confirmation prompts
32+
--async If set, runs the command asynchronously
33+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
34+
-p, --project-id string Project ID
35+
--region string Target region for region-specific requests
36+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
37+
```
38+
39+
### SEE ALSO
40+
41+
* [stackit beta kms key](./stackit_beta_kms_key.md) - Manage KMS Keys
42+

‎docs/stackit_beta_kms_key_rotate.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## stackit beta kms key rotate
2+
3+
Rotate a key
4+
5+
### Synopsis
6+
7+
Rotates the given key.
8+
9+
```
10+
stackit beta kms key rotate [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Rotate a KMS Key "my-key-id" and increase it's version inside the Key Ring "my-key-ring-id".
17+
$ stackit beta kms keyring rotate --key-ring "my-key-ring-id" --key "my-key-id"
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit beta kms key rotate"
24+
--key string ID of the actual Key
25+
--key-ring string ID of the KMS Key Ring where the Key is stored
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-y, --assume-yes If set, skips all confirmation prompts
32+
--async If set, runs the command asynchronously
33+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
34+
-p, --project-id string Project ID
35+
--region string Target region for region-specific requests
36+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
37+
```
38+
39+
### SEE ALSO
40+
41+
* [stackit beta kms key](./stackit_beta_kms_key.md) - Manage KMS Keys
42+

‎docs/stackit_beta_kms_keyring.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## stackit beta kms keyring
2+
3+
Manage KMS Keyrings
4+
5+
### Synopsis
6+
7+
Provides functionality for Keyring operations inside the KMS
8+
9+
```
10+
stackit beta kms keyring [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit beta kms keyring"
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" "none" "yaml"]
25+
-p, --project-id string Project ID
26+
--region string Target region for region-specific requests
27+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
28+
```
29+
30+
### SEE ALSO
31+
32+
* [stackit beta kms](./stackit_beta_kms.md) - Provides functionality for KMS
33+
* [stackit beta kms keyring create](./stackit_beta_kms_keyring_create.md) - Creates a KMS Key Ring
34+
* [stackit beta kms keyring delete](./stackit_beta_kms_keyring_delete.md) - Deletes a KMS Keyring
35+
* [stackit beta kms keyring list](./stackit_beta_kms_keyring_list.md) - Lists all KMS Keyrings
36+

0 commit comments

Comments
 (0)