generated from terraform-ibm-modules/terraform-ibm-module-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: updated the deployable architecture
keys
variable description …
…to point to a helper doc (#465)
- Loading branch information
Showing
2 changed files
with
64 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# Configuring keys in a KMS in IBM Cloud projects | ||
|
||
When you add a key management service from the IBM Cloud catalog to an IBM Cloud Projects service, you can configure key rings and keys. In the edit mode for the projects configuration, select the Configure panel and then click the optional tab. | ||
|
||
In the configuration, specify the name of the key ring, whether the key ring exists, and whether to force the deletion of the key. The object also contains a list of keys with all the information about the keys that you want to create in that key ring. | ||
|
||
To enter a custom value, use the edit action to open the "Edit Array" panel. Add the KMS key ring and key configurations to the array here. | ||
|
||
|
||
## Options | ||
### Key Ring options | ||
|
||
- `key_ring_name` (required): A unique human-readable name that identifies this key ring. To protect your privacy, do not use personal data, such as your name or location. The key ring name can be between 2 and 100 characters. | ||
- `existing_key_ring` (optional, default = `false`): Set to true if the key ring already exists and keys should be added to it. | ||
- `force_delete_key_ring` (optional, default = `true`): Whether to force delete the key ring with a destroy command or when the projects configuration is removed. When `true` this force deletes the key ring in the event that it contains keys in the `Destroyed` state, see [Deleting key rings](https://cloud.ibm.com/docs/key-protect?topic=key-protect-grouping-keys&interface=api#delete-key-ring-api). | ||
|
||
### Key options | ||
|
||
- `key_name` (required): A human-readable name that identifies this key. To protect your privacy, do not use personal data, such as your name or location. The key name can be between 2 and 90 characters. | ||
- `rotation_interval_month` (optional, default = 1): Configures the key rotation interval. | ||
- `standard_key` (optional, default false): whether a standard encryption key is created. For more information, see [Key types](https://cloud.ibm.com/docs/key-protect?topic=key-protect-envelope-encryption#key-types). | ||
- `dual_auth_delete_enabled` (optional, default = `false`): Whether to use dual authorization when deleting the key. For more information, see [Using dual authorization](https://cloud.ibm.com/docs/key-protect?topic=key-protect-manage-dual-auth). | ||
- `force_delete` (optional, default = `true`): Whether to force delete the key. For more information, see [Considerations before deleting and purging a key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-delete-purge-keys#delete-purge-keys-considerations). | ||
|
||
The following example includes all the configuration options for two key rings. One ring contains two keys. | ||
|
||
[ | ||
{ | ||
"key_ring_name": "da-ring-1", | ||
"existing_key_ring": false, | ||
"force_delete_key_ring": true, | ||
"keys": [ | ||
{ | ||
"key_name": "da-key-1-1", | ||
"rotation_interval_month": 1, | ||
"standard_key": false, | ||
"dual_auth_delete_enabled": false, | ||
"force_delete": true | ||
}, | ||
{ | ||
"key_name": "da-key-1-2", | ||
"rotation_interval_month": 1, | ||
"standard_key": false, | ||
"dual_auth_delete_enabled": false, | ||
"force_delete": true | ||
} | ||
] | ||
}, | ||
{ | ||
"key_ring_name": "da-ring-2", | ||
"existing_key_ring": false, | ||
"force_delete_key_ring": true, | ||
"keys": [ | ||
{ | ||
"key_name": "da-key-2-1", | ||
"rotation_interval_month": 1, | ||
"standard_key": false, | ||
"dual_auth_delete_enabled": false, | ||
"force_delete": true | ||
} | ||
] | ||
} | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters