Skip to content

Commit 9b79a43

Browse files
author
Jan Sternagel
committed
proper capitalization for flag and argument examples & typos & nitpicks
1 parent de6aba7 commit 9b79a43

30 files changed

+84
-84
lines changed

docs/stackit_beta_kms_key_create.md

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

1515
```
16-
Create a symmetric AES key (AES-256) with the name "symm-aes-gcm" under the key ring "MY_KEYRING_ID"
17-
$ stackit beta kms key create --keyring-id "MY_KEYRING_ID" --algorithm "aes_256_gcm" --name "symm-aes-gcm" --purpose "symmetric_encrypt_decrypt" --protection "software"
16+
Create a symmetric AES key (AES-256) with the name "symm-aes-gcm" under the key ring "my-keyring-id"
17+
$ stackit beta kms key create --keyring-id "my-keyring-id" --algorithm "aes_256_gcm" --name "symm-aes-gcm" --purpose "symmetric_encrypt_decrypt" --protection "software"
1818
1919
Create an asymmetric RSA encryption key (RSA-2048)
20-
$ stackit beta kms key create --keyring-id "MY_KEYRING_ID" --algorithm "rsa_2048_oaep_sha256" --name "prod-orders-rsa" --purpose "asymmetric_encrypt_decrypt" --protection "software"
20+
$ stackit beta kms key create --keyring-id "my-keyring-id" --algorithm "rsa_2048_oaep_sha256" --name "prod-orders-rsa" --purpose "asymmetric_encrypt_decrypt" --protection "software"
2121
2222
Create a message authentication key (HMAC-SHA512)
23-
$ stackit beta kms key create --keyring-id "MY_KEYRING_ID" --algorithm "hmac_sha512" --name "api-mac-key" --purpose "message_authentication_code" --protection "software"
23+
$ stackit beta kms key create --keyring-id "my-keyring-id" --algorithm "hmac_sha512" --name "api-mac-key" --purpose "message_authentication_code" --protection "software"
2424
2525
Create an ECDSA P-256 key for signing & verification
26-
$ stackit beta kms key create --keyring-id "MY_KEYRING_ID" --algorithm "ecdsa_p256_sha256" --name "signing-ecdsa-p256" --purpose "asymmetric_sign_verify" --protection "software"
26+
$ stackit beta kms key create --keyring-id "my-keyring-id" --algorithm "ecdsa_p256_sha256" --name "signing-ecdsa-p256" --purpose "asymmetric_sign_verify" --protection "software"
2727
2828
Create an import-only key (versions must be imported)
29-
$ stackit beta kms key create --keyring-id "MY_KEYRING_ID" --algorithm "rsa_2048_oaep_sha256" --name "ext-managed-rsa" --purpose "asymmetric_encrypt_decrypt" --protection "software" --import-only
29+
$ stackit beta kms key create --keyring-id "my-keyring-id" --algorithm "rsa_2048_oaep_sha256" --name "ext-managed-rsa" --purpose "asymmetric_encrypt_decrypt" --protection "software" --import-only
3030
3131
Create a key and print the result as YAML
32-
$ stackit beta kms key create --keyring-id "MY_KEYRING_ID" --algorithm "rsa_2048_oaep_sha256" --name "yaml-output-rsa" --purpose "asymmetric_encrypt_decrypt" --protection "software" --output yaml
32+
$ stackit beta kms key create --keyring-id "my-keyring-id" --algorithm "rsa_2048_oaep_sha256" --name "yaml-output-rsa" --purpose "asymmetric_encrypt_decrypt" --protection "software" --output yaml
3333
```
3434

3535
### Options

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
@@ -14,10 +14,10 @@ stackit beta kms key import KEY_ID [flags]
1414

1515
```
1616
Import a new version for the given KMS key "MY_KEY_ID" from literal value
17-
$ stackit beta kms key import "MY_KEY_ID" --keyring-id "MY_KEYRING_ID" --wrapped-key "BASE64_VALUE" --wrapping-key-id "MY_WRAPPING_KEY_ID"
17+
$ stackit beta kms key import "MY_KEY_ID" --keyring-id "my-keyring-id" --wrapped-key "BASE64_VALUE" --wrapping-key-id "MY_WRAPPING_KEY_ID"
1818
1919
Import from a file
20-
$ stackit beta kms key import "MY_KEY_ID" --keyring-id "MY_KEYRING_ID" --wrapped-key "@path/to/wrapped.key.b64" --wrapping-key-id "MY_WRAPPING_KEY_ID"
20+
$ stackit beta kms key import "MY_KEY_ID" --keyring-id "my-keyring-id" --wrapped-key "@path/to/wrapped.key.b64" --wrapping-key-id "MY_WRAPPING_KEY_ID"
2121
```
2222

2323
### 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 key 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 key 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 its 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 its 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_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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ 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

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

docs/stackit_beta_kms_version_list.md

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

1515
```
16-
List all key versions for the key "MY_KEY_ID" inside the key ring "MY_KEYRING_ID"
17-
$ stackit beta kms version list --key-id "MY_KEY_ID" --keyring-id "MY_KEYRING_ID"
16+
List all key versions for the key "my-key-id" inside the key ring "my-keyring-id"
17+
$ stackit beta kms version list --key-id "my-key-id" --keyring-id "my-keyring-id"
1818
1919
List all key versions in JSON format
20-
$ stackit beta kms version list --key-id "MY_KEY_ID" --keyring-id "MY_KEYRING_ID" -o json
20+
$ stackit beta kms version list --key-id "my-key-id" --keyring-id "my-keyring-id" -o json
2121
```
2222

2323
### Options

0 commit comments

Comments
 (0)