Skip to content
1 change: 1 addition & 0 deletions docs/stackit.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ stackit [flags]
* [stackit git](./stackit_git.md) - Provides functionality for STACKIT Git
* [stackit image](./stackit_image.md) - Manage server images
* [stackit key-pair](./stackit_key-pair.md) - Provides functionality for SSH key pairs
* [stackit kms](./stackit_kms.md) - Provides functionality for KMS
* [stackit load-balancer](./stackit_load-balancer.md) - Provides functionality for Load Balancer
* [stackit logme](./stackit_logme.md) - Provides functionality for LogMe
* [stackit logs](./stackit_logs.md) - Provides functionality for Logs
Expand Down
1 change: 0 additions & 1 deletion docs/stackit_beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ stackit beta [flags]
* [stackit beta cdn](./stackit_beta_cdn.md) - Manage CDN resources
* [stackit beta edge-cloud](./stackit_beta_edge-cloud.md) - Provides functionality for edge services.
* [stackit beta intake](./stackit_beta_intake.md) - Provides functionality for intake
* [stackit beta kms](./stackit_beta_kms.md) - Provides functionality for KMS
* [stackit beta sfs](./stackit_beta_sfs.md) - Provides functionality for SFS (stackit file storage)
* [stackit beta sqlserverflex](./stackit_beta_sqlserverflex.md) - Provides functionality for SQLServer Flex

40 changes: 0 additions & 40 deletions docs/stackit_beta_kms_key.md

This file was deleted.

38 changes: 0 additions & 38 deletions docs/stackit_beta_kms_version.md

This file was deleted.

37 changes: 0 additions & 37 deletions docs/stackit_beta_kms_wrapping-key.md

This file was deleted.

16 changes: 8 additions & 8 deletions docs/stackit_beta_kms.md → docs/stackit_kms.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## stackit beta kms
## stackit kms

Provides functionality for KMS

Expand All @@ -7,13 +7,13 @@ Provides functionality for KMS
Provides functionality for KMS.

```
stackit beta kms [flags]
stackit kms [flags]
```

### Options

```
-h, --help Help for "stackit beta kms"
-h, --help Help for "stackit kms"
```

### Options inherited from parent commands
Expand All @@ -29,9 +29,9 @@ stackit beta kms [flags]

### SEE ALSO

* [stackit beta](./stackit_beta.md) - Contains beta STACKIT CLI commands
* [stackit beta kms key](./stackit_beta_kms_key.md) - Manage KMS keys
* [stackit beta kms keyring](./stackit_beta_kms_keyring.md) - Manage KMS key rings
* [stackit beta kms version](./stackit_beta_kms_version.md) - Manage KMS key versions
* [stackit beta kms wrapping-key](./stackit_beta_kms_wrapping-key.md) - Manage KMS wrapping keys
* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [stackit kms key](./stackit_kms_key.md) - Manage KMS keys
* [stackit kms keyring](./stackit_kms_keyring.md) - Manage KMS key rings
* [stackit kms version](./stackit_kms_version.md) - Manage KMS key versions
* [stackit kms wrapping-key](./stackit_kms_wrapping-key.md) - Manage KMS wrapping keys

40 changes: 40 additions & 0 deletions docs/stackit_kms_key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## stackit kms key

Manage KMS keys

### Synopsis

Provides functionality for key operations inside the KMS

```
stackit kms key [flags]
```

### Options

```
-h, --help Help for "stackit kms key"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit kms](./stackit_kms.md) - Provides functionality for KMS
* [stackit kms key create](./stackit_kms_key_create.md) - Creates a KMS key
* [stackit kms key delete](./stackit_kms_key_delete.md) - Deletes a KMS key
* [stackit kms key describe](./stackit_kms_key_describe.md) - Describe a KMS key
* [stackit kms key import](./stackit_kms_key_import.md) - Import a KMS key
* [stackit kms key list](./stackit_kms_key_list.md) - List all KMS keys
* [stackit kms key restore](./stackit_kms_key_restore.md) - Restore a key
* [stackit kms key rotate](./stackit_kms_key_rotate.md) - Rotate a key

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## stackit beta kms key create
## stackit kms key create

Creates a KMS key

Expand All @@ -7,37 +7,37 @@ Creates a KMS key
Creates a KMS key.

```
stackit beta kms key create [flags]
stackit kms key create [flags]
```

### Examples

```
Create a symmetric AES key (AES-256) with the name "symm-aes-gcm" under the key ring "my-keyring-id"
$ stackit beta kms key create --keyring-id "my-keyring-id" --algorithm "aes_256_gcm" --name "symm-aes-gcm" --purpose "symmetric_encrypt_decrypt" --protection "software"
$ stackit kms key create --keyring-id "my-keyring-id" --algorithm "aes_256_gcm" --name "symm-aes-gcm" --purpose "symmetric_encrypt_decrypt" --protection "software"

Create an asymmetric RSA encryption key (RSA-2048)
$ 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"
$ stackit kms key create --keyring-id "my-keyring-id" --algorithm "rsa_2048_oaep_sha256" --name "prod-orders-rsa" --purpose "asymmetric_encrypt_decrypt" --protection "software"

Create a message authentication key (HMAC-SHA512)
$ stackit beta kms key create --keyring-id "my-keyring-id" --algorithm "hmac_sha512" --name "api-mac-key" --purpose "message_authentication_code" --protection "software"
$ stackit kms key create --keyring-id "my-keyring-id" --algorithm "hmac_sha512" --name "api-mac-key" --purpose "message_authentication_code" --protection "software"

Create an ECDSA P-256 key for signing & verification
$ stackit beta kms key create --keyring-id "my-keyring-id" --algorithm "ecdsa_p256_sha256" --name "signing-ecdsa-p256" --purpose "asymmetric_sign_verify" --protection "software"
$ stackit kms key create --keyring-id "my-keyring-id" --algorithm "ecdsa_p256_sha256" --name "signing-ecdsa-p256" --purpose "asymmetric_sign_verify" --protection "software"

Create an import-only key (versions must be imported)
$ 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
$ stackit 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

Create a key and print the result as YAML
$ 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
$ stackit 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
```

### Options

```
--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"]
--description string Optional description of the key
-h, --help Help for "stackit beta kms key create"
-h, --help Help for "stackit kms key create"
--import-only States whether versions can be created or only imported
--keyring-id string ID of the KMS key ring
--name string The display name to distinguish multiple keys
Expand All @@ -58,5 +58,5 @@ stackit beta kms key create [flags]

### SEE ALSO

* [stackit beta kms key](./stackit_beta_kms_key.md) - Manage KMS keys
* [stackit kms key](./stackit_kms_key.md) - Manage KMS keys

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## stackit beta kms key delete
## stackit kms key delete

Deletes a KMS key

Expand All @@ -7,20 +7,20 @@ Deletes a KMS key
Deletes a KMS key inside a specific key ring.

```
stackit beta kms key delete KEY_ID [flags]
stackit kms key delete KEY_ID [flags]
```

### Examples

```
Delete a KMS key "MY_KEY_ID" inside the key ring "my-keyring-id"
$ stackit beta kms key delete "MY_KEY_ID" --keyring-id "my-keyring-id"
$ stackit kms key delete "MY_KEY_ID" --keyring-id "my-keyring-id"
```

### Options

```
-h, --help Help for "stackit beta kms key delete"
-h, --help Help for "stackit kms key delete"
--keyring-id string ID of the KMS key ring where the key is stored
```

Expand All @@ -37,5 +37,5 @@ stackit beta kms key delete KEY_ID [flags]

### SEE ALSO

* [stackit beta kms key](./stackit_beta_kms_key.md) - Manage KMS keys
* [stackit kms key](./stackit_kms_key.md) - Manage KMS keys

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## stackit beta kms key describe
## stackit kms key describe

Describe a KMS key

Expand All @@ -7,20 +7,20 @@ Describe a KMS key
Describe a KMS key

```
stackit beta kms key describe KEY_ID [flags]
stackit kms key describe KEY_ID [flags]
```

### Examples

```
Describe a KMS key with ID xxx of keyring yyy
$ stackit beta kms key describe xxx --keyring-id yyy
$ stackit kms key describe xxx --keyring-id yyy
```

### Options

```
-h, --help Help for "stackit beta kms key describe"
-h, --help Help for "stackit kms key describe"
--keyring-id string Key Ring ID
```

Expand All @@ -37,5 +37,5 @@ stackit beta kms key describe KEY_ID [flags]

### SEE ALSO

* [stackit beta kms key](./stackit_beta_kms_key.md) - Manage KMS keys
* [stackit kms key](./stackit_kms_key.md) - Manage KMS keys

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## stackit beta kms key import
## stackit kms key import

Import a KMS key

Expand All @@ -7,23 +7,23 @@ Import a KMS key
After encrypting the secret with the wrapping key’s public key and Base64-encoding it, import it as a new version of the specified KMS key.

```
stackit beta kms key import KEY_ID [flags]
stackit kms key import KEY_ID [flags]
```

### Examples

```
Import a new version for the given KMS key "MY_KEY_ID" from literal value
$ stackit beta kms key import "MY_KEY_ID" --keyring-id "my-keyring-id" --wrapped-key "BASE64_VALUE" --wrapping-key-id "MY_WRAPPING_KEY_ID"
$ stackit kms key import "MY_KEY_ID" --keyring-id "my-keyring-id" --wrapped-key "BASE64_VALUE" --wrapping-key-id "MY_WRAPPING_KEY_ID"

Import from a file
$ 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"
$ stackit 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"
```

### Options

```
-h, --help Help for "stackit beta kms key import"
-h, --help Help for "stackit kms key import"
--keyring-id string ID of the KMS key ring
--wrapped-key string The wrapped key material to be imported. Base64-encoded. Pass the value directly or a file path (e.g. @path/to/wrapped.key.b64)
--wrapping-key-id string The unique id of the wrapping key the key material has been wrapped with
Expand All @@ -42,5 +42,5 @@ stackit beta kms key import KEY_ID [flags]

### SEE ALSO

* [stackit beta kms key](./stackit_beta_kms_key.md) - Manage KMS keys
* [stackit kms key](./stackit_kms_key.md) - Manage KMS keys

Loading
Loading