Skip to content

Commit 8880348

Browse files
author
Jan Sternagel
committed
argument ID always in uppercase & typo fix
1 parent 54332f0 commit 8880348

30 files changed

+74
-74
lines changed

docs/stackit_beta_kms_key_create.md

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

1515
```
1616
Create a Symmetric KMS key
17-
$ stackit beta kms key create --keyring-id "my-keyring-id" --algorithm "rsa_2048_oaep_sha256" --name "my-key-name" --purpose "asymmetric_encrypt_decrypt" --protection "software"
17+
$ stackit beta kms key create --keyring-id "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 --keyring-id "my-keyring-id" --algorithm "hmac_sha512" --name "my-key-name" --purpose "message_authentication_code" --protection "software"
20+
$ stackit beta kms key create --keyring-id "MY_KEYRING_ID" --algorithm "hmac_sha512" --name "my-key-name" --purpose "message_authentication_code" --protection "software"
2121
```
2222

2323
### Options
2424

2525
```
26-
--algorithm string En-/Decryption / signing algorithm
26+
--algorithm string En-/Decryption / signing algorithm. Possible values: ["aes_256_gcm" "rsa_2048_oaep_sha256" "rsa_3072_oaep_sha256" "rsa_4096_oaep_sha256" "rsa_4096_oaep_sha512" "hmac_sha256" "hmac_sha384" "hmac_sha512" "ecdsa_p256_sha256" "ecdsa_p384_sha384" "ecdsa_p521_sha512"] (default "rsa_2048_oaep_sha256")
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
3030
--keyring-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'
33-
--purpose string Purpose of the key. Enum: 'symmetric_encrypt_decrypt', 'asymmetric_encrypt_decrypt', 'message_authentication_code', 'asymmetric_sign_verify'
32+
--protection string The underlying system that is responsible for protecting the key material. Possible values: ["symmetric_encrypt_decrypt" "asymmetric_encrypt_decrypt" "message_authentication_code" "asymmetric_sign_verify"] (default "software")
33+
--purpose string Purpose of the key. Possible values: ["symmetric_encrypt_decrypt" "asymmetric_encrypt_decrypt" "message_authentication_code" "asymmetric_sign_verify"] (default "asymmetric_encrypt_decrypt")
3434
```
3535

3636
### Options inherited from parent commands

docs/stackit_beta_kms_key_delete.md

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

1515
```
16-
Delete a KMS key "my-key-id" inside the key ring "my-keyring-id"
17-
$ stackit beta kms key delete "my-key-id" --keyring-id "my-keyring-id"
16+
Delete a KMS key "MY_KEY_ID" inside the key ring "MY_KEYRING_ID"
17+
$ stackit beta kms key delete "MY_KEY_ID" --keyring-id "MY_KEYRING_ID"
1818
```
1919

2020
### Options

docs/stackit_beta_kms_key_import.md

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

1515
```
16-
Import a new version for the given KMS key "my-key-id"
17-
$ stackit beta kms key import "my-key-id" --keyring-id "my-keyring-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" --keyring-id "MY_KEYRING_ID" --wrapped-key "base64-encoded-wrapped-key-material" --wrapping-key-id "MY_WRAPPING_KEY_ID"
1818
```
1919

2020
### Options

docs/stackit_beta_kms_key_list.md

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

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

2323
### Options

docs/stackit_beta_kms_key_restore.md

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

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

2020
### Options

docs/stackit_beta_kms_key_rotate.md

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

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

2020
### 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 "my-keyring-id"
17-
$ stackit beta kms keyring delete "my-keyring-id"
16+
Delete a KMS key ring with ID "MY_KEYRING_ID"
17+
$ stackit beta kms keyring delete "MY_KEYRING_ID"
1818
```
1919

2020
### Options

docs/stackit_beta_kms_version_destroy.md

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

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

2020
### Options

docs/stackit_beta_kms_version_disable.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ stackit beta kms version disable VERSION_NUMBER [flags]
1313
### Examples
1414

1515
```
16-
Disable key version "42" for the key "my-key-id" inside the key ring "my-keyring-id"
17-
$ stackit beta kms version disable 42 --key-id "my-key-id" --keyring-id "my-keyring-id"
16+
Disable key version "42" for the key "MY_KEY_ID" inside the key ring "MY_KEYRING_ID"
17+
$ stackit beta kms version disable 42 --key-id "MY_KEY_ID" --keyring-id "MY_KEYRING_ID"
1818
```
1919

2020
### Options
2121

2222
```
2323
-h, --help Help for "stackit beta kms version disable"
24-
--key-id string ID of the rey
24+
--key-id string ID of the key
2525
--keyring-id string ID of the KMS key ring
2626
```
2727

docs/stackit_beta_kms_version_enable.md

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

1515
```
16-
Enable key version "42" for the key "my-key-id" inside the key ring "my-keyring-id"
17-
$ stackit beta kms version enable 42 --key-id "my-key-id" --keyring-id "my-keyring-id"
16+
Enable key version "42" for the key "MY_KEY_ID" inside the key ring "MY_KEYRING_ID"
17+
$ stackit beta kms version enable 42 --key-id "MY_KEY_ID" --keyring-id "MY_KEYRING_ID"
1818
```
1919

2020
### Options

0 commit comments

Comments
 (0)