Skip to content
This repository was archived by the owner on Jun 17, 2025. It is now read-only.

Commit f648f6a

Browse files
authored
docs: minor editorial updates (#19)
- Update title to approved name - Update upgrade statement - Update encryption statement Addresses https://github.ibm.com/GoldenEye/issues/issues/5117
1 parent 6c3a90f commit f648f6a

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1-
# IBM Cloud Databases for Enterprise DB module
1+
# IBM Cloud Databases for EnterpriseDB module
22

33
[![Stable (With quality checks)](https://img.shields.io/badge/Status-Stable%20(With%20quality%20checks)-green?style=plastic)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)
44
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
55
[![latest release](https://img.shields.io/github/v/release/terraform-ibm-modules/terraform-ibm-icd-edb?logo=GitHub&sort=semver)](https://github.com/terraform-ibm-modules/terraform-ibm-icd-edb/releases/latest)
66
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
77
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
8-
## Usage
98

10-
> WARNING: **This module does not support major version upgrade or updates to encryption and backup encryption keys**
9+
This module implements an instance of the IBM Cloud Databases for EnterpriseDB service.
10+
11+
:exclamation: The module does not support major version upgrades or updates to encryption and backup encryption keys. To upgrade the version, create another instance of Databases for EnterpriseDBs with the updated version.
12+
13+
## Usage
1114

12-
> NOTE: Currently the database encryption for backups supports only Key Protect keys, not Hyper Protect Crypto keys. If enabling KMS encryption and no value is passed for 'backup_encryption_key_crn', the value of 'kms_key_crn' is used. If this value is a HPCS key, the module will default the backup encryption to use randomly generated keys due to this current limitation. More info: https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-hpcs
15+
IBM Cloud Databases supports only Key Protect encryption for backups, not Hyper Protect Crypto Services. If you enable key management encryption and no value is passed for 'backup_encryption_key_crn', the value of 'kms_key_crn' is used. And if a HPCS value is set for `kms_key_crn`, the database backup encryption uses the default encryption keys. For more information, see [Hyper Protect Crypto Services Integration](https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-hpcs) in the IBM Cloud Docs.
1316

1417
```hcl
1518
provider "ibm" {

0 commit comments

Comments
 (0)