Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/stackit_beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,6 @@ stackit beta [flags]

* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [stackit beta alb](./stackit_beta_alb.md) - Manages application loadbalancers
* [stackit beta kms](./stackit_beta_kms.md) - Provides functionality for KMS
* [stackit beta sqlserverflex](./stackit_beta_sqlserverflex.md) - Provides functionality for SQLServer Flex

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

Provides functionality for KMS

### Synopsis

Provides functionality for KMS.

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

### Options

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

### 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 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 Keyrings
* [stackit beta kms version](./stackit_beta_kms_version.md) - Manage KMS Key versions
* [stackit beta kms wrappingkey](./stackit_beta_kms_wrappingkey.md) - Manage KMS Wrapping Keys

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

Manage KMS Keys

### Synopsis

Provides CRUD functionality for Key operations inside the KMS

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

### Options

```
-h, --help Help for "stackit beta 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 beta kms](./stackit_beta_kms.md) - Provides functionality for KMS
* [stackit beta kms key create](./stackit_beta_kms_key_create.md) - Creates a KMS Key
* [stackit beta kms key delete](./stackit_beta_kms_key_delete.md) - Deletes a KMS Key
* [stackit beta kms key import](./stackit_beta_kms_key_import.md) - Import a KMS Key Version
* [stackit beta kms key list](./stackit_beta_kms_key_list.md) - Lists all KMS Keys
* [stackit beta kms key restore](./stackit_beta_kms_key_restore.md) - Resotre a Key
* [stackit beta kms key rotate](./stackit_beta_kms_key_rotate.md) - Rotate a key

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

Creates a KMS Key

### Synopsis

Creates a KMS Key.

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

### Examples

```
Create a Symmetric KMS Key
$ stakit beta kms key create --key-ring "my-keyring-id" --algorithm "rsa_2048_oaep_sha256" --name "my-key-name" --purpose "symmetric_encrypt_decrypt"

Create a Message Authentication KMS Key
$ stakit beta kms key create --key-ring "my-keyring-id" --algorithm "hmac_sha512" --name "my-key-name" --purpose "message_authentication_code"
```

### Options

```
--algorithm string En-/Decryption / signing algorithm
--backend string The backend that is responsible for maintaining this key (default "software")
--description string Optinal description of the Key
-h, --help Help for "stackit beta kms key create"
--import-only States whether versions can be created or only imported
--key-ring string ID of the KMS Key Ring
--name string The display name to distinguish multiple keys
--purpose string Purpose of the Key. Enum: 'symmetric_encrypt_decrypt', 'asymmetric_encrypt_decrypt', 'message_authentication_code', 'asymmetric_sign_verify'
```

### 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 beta kms key](./stackit_beta_kms_key.md) - Manage KMS Keys

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

Deletes a KMS Key

### Synopsis

Deletes a KMS Key inside a specific Key Ring.

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

### Examples

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

### Options

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

### 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 beta kms key](./stackit_beta_kms_key.md) - Manage KMS Keys

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

Import a KMS Key Version

### Synopsis

Improt a new version to the given KMS key.

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

### Examples

```
Import a new version for the given KMS Key "my-key"
$ stakit beta kms key improt --key-ring "my-keyring-id" --key "my-key-id" --wrapped-key "base64-encoded-wrapped-key-material" --wrapping-key-id "my-wrapping-key-id"
```

### Options

```
-h, --help Help for "stackit beta kms key import"
--key string ID of the KMS Key
--key-ring string ID of the KMS Key Ring
--wrapped-key string The wrapped key material that has to be imported. Encoded in base64
--wrapping-key-id string he unique id of the wrapping key the key material has been wrapped with
```

### 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 beta kms key](./stackit_beta_kms_key.md) - Manage KMS Keys

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

Lists all KMS Keys

### Synopsis

Lists all KMS Keys inside a key ring.

```
stackit beta kms key list KEYRING_ID [flags]
```

### Examples

```
List all KMS Keys for the key ring "xxx"
$ stackit beta kms key list xxx

List all KMS Keys in JSON format
$ stackit beta kms key list xxx --output-format json
```

### Options

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

### 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 beta kms key](./stackit_beta_kms_key.md) - Manage KMS Keys

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

Resotre a Key

### Synopsis

Restores the given key from being deleted.

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

### Examples

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

### Options

```
-h, --help Help for "stackit beta kms key restore"
--key string ID of the actual Key
--key-ring string ID of the KMS Key Ring where the Key is stored
```

### 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 beta kms key](./stackit_beta_kms_key.md) - Manage KMS Keys

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

Rotate a key

### Synopsis

Rotates the given key.

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

### Examples

```
Rotate a KMS Key "my-key-id" and increase it's version inside the Key Ring "my-key-ring-id".
$ stackit beta kms keyring rotate --key-ring "my-key-ring-id" --key "my-key-id"
```

### Options

```
-h, --help Help for "stackit beta kms key rotate"
--key string ID of the actual Key
--key-ring string ID of the KMS Key Ring where the Key is stored
```

### 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 beta kms key](./stackit_beta_kms_key.md) - Manage KMS Keys

36 changes: 36 additions & 0 deletions docs/stackit_beta_kms_keyring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## stackit beta kms keyring

Manage KMS Keyrings

### Synopsis

Provides functionality for Keyring operations inside the KMS

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

### Options

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

### 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 beta kms](./stackit_beta_kms.md) - Provides functionality for KMS
* [stackit beta kms keyring create](./stackit_beta_kms_keyring_create.md) - Creates a KMS Key Ring
* [stackit beta kms keyring delete](./stackit_beta_kms_keyring_delete.md) - Deletes a KMS Keyring
* [stackit beta kms keyring list](./stackit_beta_kms_keyring_list.md) - Lists all KMS Keyrings

Loading