Skip to content

Commit e39d775

Browse files
author
Jan Sternagel
committed
updated the docs
1 parent bba5217 commit e39d775

18 files changed

+78
-83
lines changed

docs/stackit_beta_kms_key.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Manage KMS Keys
44

55
### Synopsis
66

7-
Provides functionality for Key operations inside the KMS
7+
Provides functionality for key operations inside the KMS
88

99
```
1010
stackit beta kms key [flags]
@@ -34,6 +34,6 @@ stackit beta kms key [flags]
3434
* [stackit beta kms key delete](./stackit_beta_kms_key_delete.md) - Deletes a KMS key
3535
* [stackit beta kms key import](./stackit_beta_kms_key_import.md) - Import a KMS key
3636
* [stackit beta kms key list](./stackit_beta_kms_key_list.md) - List all KMS keys
37-
* [stackit beta kms key restore](./stackit_beta_kms_key_restore.md) - Resotre a key
37+
* [stackit beta kms key restore](./stackit_beta_kms_key_restore.md) - Restore a key
3838
* [stackit beta kms key rotate](./stackit_beta_kms_key_rotate.md) - Rotate a key
3939

docs/stackit_beta_kms_key_create.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ stackit beta kms key create [flags]
1414

1515
```
1616
Create a Symmetric KMS key
17-
$ stackit beta kms key create --key-ring "my-keyring-id" --algorithm "rsa_2048_oaep_sha256" --name "my-key-name" --purpose "symmetric_encrypt_decrypt"
17+
$ stackit beta kms key create --key-ring "my-keyring-id" --algorithm "rsa_2048_oaep_sha256" --name "my-key-name" --purpose "asymmetric_encrypt_decrypt" --protection "software"
1818
1919
Create a Message Authentication KMS key
20-
$ stackit beta kms key create --key-ring "my-keyring-id" --algorithm "hmac_sha512" --name "my-key-name" --purpose "message_authentication_code"
20+
$ stackit beta kms key create --key-ring "my-keyring-id" --algorithm "hmac_sha512" --name "my-key-name" --purpose "message_authentication_code" --protection "software"
2121
```
2222

2323
### Options
@@ -27,8 +27,9 @@ stackit beta kms key create [flags]
2727
--description string Optional description of the key
2828
-h, --help Help for "stackit beta kms key create"
2929
--import-only States whether versions can be created or only imported
30-
--key-ring string ID of the KMS key ring
30+
--key-ring-id string ID of the KMS key ring
3131
--name string The display name to distinguish multiple keys
32+
--protection string The underlying system that is responsible for protecting the key material. Value: 'software'
3233
--purpose string Purpose of the key. Enum: 'symmetric_encrypt_decrypt', 'asymmetric_encrypt_decrypt', 'message_authentication_code', 'asymmetric_sign_verify'
3334
```
3435

docs/stackit_beta_kms_key_delete.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,21 @@ Deletes a KMS key
77
Deletes a KMS key inside a specific key ring.
88

99
```
10-
stackit beta kms key delete [flags]
10+
stackit beta kms key delete KEY_ID [flags]
1111
```
1212

1313
### Examples
1414

1515
```
1616
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"
17+
$ stackit beta kms keyring delete "my-key-id" --key-ring "my-key-ring-id"
1818
```
1919

2020
### Options
2121

2222
```
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
23+
-h, --help Help for "stackit beta kms key delete"
24+
--key-ring-id string ID of the KMS Key Ring where the Key is stored
2625
```
2726

2827
### Options inherited from parent commands

docs/stackit_beta_kms_key_import.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,21 @@ Import a KMS key
77
Import a new version to the given KMS key.
88

99
```
10-
stackit beta kms key import [flags]
10+
stackit beta kms key import KEY_ID [flags]
1111
```
1212

1313
### Examples
1414

1515
```
16-
Import a new version for the given KMS key "my-key"
17-
$ stakit beta kms key import --key-ring "my-keyring-id" --key "my-key-id" --wrapped-key "base64-encoded-wrapped-key-material" --wrapping-key-id "my-wrapping-key-id"
16+
Import a new version for the given KMS key "my-key-id"
17+
$ stackit beta kms key import "my-key-id" --key-ring "my-keyring-id" --wrapped-key "base64-encoded-wrapped-key-material" --wrapping-key-id "my-wrapping-key-id"
1818
```
1919

2020
### Options
2121

2222
```
2323
-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
24+
--key-ring-id string ID of the KMS key ring
2625
--wrapped-key string The wrapped key material that has to be imported. Encoded in base64
2726
--wrapping-key-id string The unique id of the wrapping key the key material has been wrapped with
2827
```

docs/stackit_beta_kms_key_list.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,24 @@ List all KMS keys
77
List all KMS keys inside a key ring.
88

99
```
10-
stackit beta kms key list KEYRING_ID [flags]
10+
stackit beta kms key list [flags]
1111
```
1212

1313
### Examples
1414

1515
```
16-
List all KMS keys for the key ring "xxx"
17-
$ stackit beta kms key list xxx
16+
List all KMS keys for the key ring "my-key-ring-id"
17+
$ stackit beta kms key list --key-ring "my-key-ring-id"
1818
1919
List all KMS keys in JSON format
20-
$ stackit beta kms key list xxx --output-format json
20+
$ stackit beta kms key list --key-ring "my-key-ring-id" --output-format json
2121
```
2222

2323
### Options
2424

2525
```
26-
-h, --help Help for "stackit beta kms key list"
26+
-h, --help Help for "stackit beta kms key list"
27+
--key-ring-id string ID of the KMS Key Ring where the Key is stored
2728
```
2829

2930
### Options inherited from parent commands

docs/stackit_beta_kms_key_restore.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
11
## stackit beta kms key restore
22

3-
Resotre a key
3+
Restore a key
44

55
### Synopsis
66

77
Restores the given key from being deleted.
88

99
```
10-
stackit beta kms key restore [flags]
10+
stackit beta kms key restore KEY_ID [flags]
1111
```
1212

1313
### Examples
1414

1515
```
1616
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"
17+
$ stackit beta kms keyring restore "my-key-id" --key-ring "my-key-ring-id"
1818
```
1919

2020
### Options
2121

2222
```
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
23+
-h, --help Help for "stackit beta kms key restore"
24+
--key-ring-id string ID of the KMS Key Ring where the Key is stored
2625
```
2726

2827
### Options inherited from parent commands

docs/stackit_beta_kms_key_rotate.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,21 @@ Rotate a key
77
Rotates the given key.
88

99
```
10-
stackit beta kms key rotate [flags]
10+
stackit beta kms key rotate KEY_ID [flags]
1111
```
1212

1313
### Examples
1414

1515
```
1616
Rotate a KMS key "my-key-id" and increase it's version inside the key ring "my-key-ring-id".
17-
$ stackit beta kms key rotate --key-ring "my-key-ring-id" --key "my-key-id"
17+
$ stackit beta kms key rotate "my-key-id" --key-ring "my-key-ring-id"
1818
```
1919

2020
### Options
2121

2222
```
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
23+
-h, --help Help for "stackit beta kms key rotate"
24+
--key-ring-id string ID of the KMS key Ring where the key is stored
2625
```
2726

2827
### Options inherited from parent commands

docs/stackit_beta_kms_keyring_create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ stackit beta kms keyring create [flags]
1414

1515
```
1616
Create a KMS key ring
17-
$ stakit beta kms keyring create --name my-keyring
17+
$ stackit beta kms keyring create --name my-keyring
1818
1919
Create a KMS key ring with a description
20-
$ stakit beta kms keyring create --name my-keyring --description my-description
20+
$ stackit beta kms keyring create --name my-keyring --description my-description
2121
```
2222

2323
### Options

docs/stackit_beta_kms_keyring_delete.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ stackit beta kms keyring delete KEYRING_ID [flags]
1313
### Examples
1414

1515
```
16-
Delete a KMS key ring with ID "xxx"
17-
$ stackit beta kms keyring delete xxx
16+
Delete a KMS key ring with ID "my-key-ring-id"
17+
$ stackit beta kms keyring delete "my-key-ring-id"
1818
```
1919

2020
### Options

docs/stackit_beta_kms_version_destroy.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,22 @@ Destroy a key version
77
Removes the key material of a version.
88

99
```
10-
stackit beta kms version destroy [flags]
10+
stackit beta kms version destroy VERSION_NUMBER [flags]
1111
```
1212

1313
### Examples
1414

1515
```
16-
Destroy key version "0" for the key "my-key-id" inside the key ring "my-key-ring-id"
17-
$ stackit beta kms version destroy --key "my-key-id" --key-ring "my-key-ring-id" --version 0
16+
Destroy key version "42" for the key "my-key-id" inside the key ring "my-key-ring-id"
17+
$ stackit beta kms version destroy 42 --key "my-key-id" --key-ring "my-key-ring-id"
1818
```
1919

2020
### Options
2121

2222
```
23-
-h, --help Help for "stackit beta kms version destroy"
24-
--key string ID of the key
25-
--key-ring string ID of the KMS key ring
26-
--version int Version number of the key
23+
-h, --help Help for "stackit beta kms version destroy"
24+
--key-id string ID of the key
25+
--key-ring-id string ID of the KMS key ring
2726
```
2827

2928
### Options inherited from parent commands

0 commit comments

Comments
 (0)