Skip to content

Commit c1ba5cc

Browse files
author
Jan Sternagel
committed
updated docs
1 parent f10d6c1 commit c1ba5cc

22 files changed

+116
-116
lines changed

docs/stackit_beta_kms.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ stackit beta kms [flags]
3131

3232
* [stackit beta](./stackit_beta.md) - Contains beta STACKIT CLI commands
3333
* [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
34+
* [stackit beta kms keyring](./stackit_beta_kms_keyring.md) - Manage KMS key rings
35+
* [stackit beta kms version](./stackit_beta_kms_version.md) - Manage KMS key versions
36+
* [stackit beta kms wrapping-key](./stackit_beta_kms_wrapping-key.md) - Manage KMS wrapping keys
3737

docs/stackit_beta_kms_key.md

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

55
### Synopsis
66

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

99
```
1010
stackit beta kms key [flags]
@@ -30,10 +30,10 @@ stackit beta kms key [flags]
3030
### SEE ALSO
3131

3232
* [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
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
36+
* [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
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: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit beta kms key create
22

3-
Creates a KMS Key
3+
Creates a KMS key
44

55
### Synopsis
66

7-
Creates a KMS Key.
7+
Creates a KMS key.
88

99
```
1010
stackit beta kms key create [flags]
@@ -13,23 +13,23 @@ stackit beta kms key create [flags]
1313
### Examples
1414

1515
```
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"
16+
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"
1818
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"
19+
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"
2121
```
2222

2323
### Options
2424

2525
```
2626
--algorithm string En-/Decryption / signing algorithm
27-
--description string Optinal description of the Key
27+
--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 string ID of the KMS key ring
3131
--name string The display name to distinguish multiple keys
32-
--purpose string Purpose of the Key. Enum: 'symmetric_encrypt_decrypt', 'asymmetric_encrypt_decrypt', 'message_authentication_code', 'asymmetric_sign_verify'
32+
--purpose string Purpose of the key. Enum: 'symmetric_encrypt_decrypt', 'asymmetric_encrypt_decrypt', 'message_authentication_code', 'asymmetric_sign_verify'
3333
```
3434

3535
### Options inherited from parent commands

docs/stackit_beta_kms_key_delete.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit beta kms key delete
22

3-
Deletes a KMS Key
3+
Deletes a KMS key
44

55
### Synopsis
66

7-
Deletes a KMS Key inside a specific Key Ring.
7+
Deletes a KMS key inside a specific key ring.
88

99
```
1010
stackit beta kms key delete [flags]
@@ -13,7 +13,7 @@ stackit beta kms key delete [flags]
1313
### Examples
1414

1515
```
16-
Delete a KMS Key "my-key-id" inside the Key Ring "my-key-ring-id"
16+
Delete a KMS key "my-key-id" inside the key ring "my-key-ring-id"
1717
$ stackit beta kms keyring delete --key-ring "my-key-ring-id" --key "my-key-id"
1818
```
1919

docs/stackit_beta_kms_key_import.md

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

3-
Import a KMS Key Version
3+
Import a KMS key
44

55
### Synopsis
66

@@ -13,18 +13,18 @@ stackit beta kms key import [flags]
1313
### Examples
1414

1515
```
16-
Import a new version for the given KMS Key "my-key"
16+
Import a new version for the given KMS key "my-key"
1717
$ 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"
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 string ID of the KMS key
25+
--key-ring string ID of the KMS key ring
2626
--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
27+
--wrapping-key-id string The unique id of the wrapping key the key material has been wrapped with
2828
```
2929

3030
### Options inherited from parent commands

docs/stackit_beta_kms_key_list.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit beta kms key list
22

3-
Lists all KMS Keys
3+
List all KMS keys
44

55
### Synopsis
66

7-
Lists all KMS Keys inside a key ring.
7+
List all KMS keys inside a key ring.
88

99
```
1010
stackit beta kms key list KEYRING_ID [flags]
@@ -13,10 +13,10 @@ stackit beta kms key list KEYRING_ID [flags]
1313
### Examples
1414

1515
```
16-
List all KMS Keys for the key ring "xxx"
16+
List all KMS keys for the key ring "xxx"
1717
$ stackit beta kms key list xxx
1818
19-
List all KMS Keys in JSON format
19+
List all KMS keys in JSON format
2020
$ stackit beta kms key list xxx --output-format json
2121
```
2222

docs/stackit_beta_kms_key_restore.md

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

3-
Resotre a Key
3+
Resotre a key
44

55
### Synopsis
66

@@ -13,7 +13,7 @@ stackit beta kms key restore [flags]
1313
### Examples
1414

1515
```
16-
Restore a KMS Key "my-key-id" inside the Key Ring "my-key-ring-id" that was scheduled for deletion.
16+
Restore a KMS key "my-key-id" inside the key ring "my-key-ring-id" that was scheduled for deletion.
1717
$ stackit beta kms keyring restore --key-ring "my-key-ring-id" --key "my-key-id"
1818
```
1919

docs/stackit_beta_kms_key_rotate.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ stackit beta kms key rotate [flags]
1313
### Examples
1414

1515
```
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"
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 key rotate --key-ring "my-key-ring-id" --key "my-key-id"
1818
```
1919

2020
### Options
2121

2222
```
2323
-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
24+
--key string ID of the actual key
25+
--key-ring string ID of the KMS key Ring where the key is stored
2626
```
2727

2828
### Options inherited from parent commands

docs/stackit_beta_kms_keyring.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit beta kms keyring
22

3-
Manage KMS Keyrings
3+
Manage KMS key rings
44

55
### Synopsis
66

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

99
```
1010
stackit beta kms keyring [flags]
@@ -30,7 +30,7 @@ stackit beta kms keyring [flags]
3030
### SEE ALSO
3131

3232
* [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
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 key ring
35+
* [stackit beta kms keyring list](./stackit_beta_kms_keyring_list.md) - Lists all KMS key rings
3636

docs/stackit_beta_kms_keyring_create.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit beta kms keyring create
22

3-
Creates a KMS Key Ring
3+
Creates a KMS key ring
44

55
### Synopsis
66

7-
Creates a KMS Key Ring.
7+
Creates a KMS key ring.
88

99
```
1010
stackit beta kms keyring create [flags]
@@ -16,16 +16,16 @@ stackit beta kms keyring create [flags]
1616
Create a KMS key ring
1717
$ stakit beta kms keyring create --name my-keyring
1818
19-
Create a KMS Key ring with a description
19+
Create a KMS key ring with a description
2020
$ stakit beta kms keyring create --name my-keyring --description my-description
2121
```
2222

2323
### Options
2424

2525
```
26-
--description string Optinal description of the Key Ring
26+
--description string Optional description of the key ring
2727
-h, --help Help for "stackit beta kms keyring create"
28-
--name string Name of the KMS Key Ring
28+
--name string Name of the KMS key ring
2929
```
3030

3131
### Options inherited from parent commands
@@ -41,5 +41,5 @@ stackit beta kms keyring create [flags]
4141

4242
### SEE ALSO
4343

44-
* [stackit beta kms keyring](./stackit_beta_kms_keyring.md) - Manage KMS Keyrings
44+
* [stackit beta kms keyring](./stackit_beta_kms_keyring.md) - Manage KMS key rings
4545

0 commit comments

Comments
 (0)