From 20ea6871f4530f82174a5d82ee4981c25703c246 Mon Sep 17 00:00:00 2001 From: maheshwarishikha Date: Fri, 8 Sep 2023 13:44:18 +0530 Subject: [PATCH] fix: update readme (#76) * fix: update readme * docs: update readme * docs: update readme --------- Co-authored-by: shikha-mah --- .secrets.baseline | 6 +++--- README.md | 10 +++++++--- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/.secrets.baseline b/.secrets.baseline index ea3dada..a1665f7 100644 --- a/.secrets.baseline +++ b/.secrets.baseline @@ -3,7 +3,7 @@ "files": "go.sum|^.secrets.baseline$", "lines": null }, - "generated_at": "2023-07-13T08:02:39Z", + "generated_at": "2023-09-07T10:12:57Z", "plugins_used": [ { "name": "AWSKeyDetector" @@ -82,7 +82,7 @@ "hashed_secret": "b7789e80adceebbe078db3e927944143c93e3116", "is_secret": false, "is_verified": false, - "line_number": 158, + "line_number": 162, "type": "Base64 High Entropy String", "verified_result": null }, @@ -90,7 +90,7 @@ "hashed_secret": "379f23674341f122f9075538a32277b5efaa2f7d", "is_secret": false, "is_verified": false, - "line_number": 163, + "line_number": 167, "type": "Base64 High Entropy String", "verified_result": null } diff --git a/README.md b/README.md index 54b3d66..da2f87c 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,10 @@ The next step after provisioning an HPCS instance is to [initialize](https://clo For more information, see [components and concepts](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-understand-concepts) of HPCS and [about service instance initialization](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-introduce-service) in the Cloud Docs. +If you provision an HPCS instance with a `private-only` endpoint, both public and private endpoints URLs are included in the output. You can ignore the public endpoint. It is included for convenience in case you need to switch to it temporarily. However, make sure that you switch back to the private endpoint as soon as possible. + + + ## Create Hyper Protect Crypto Services instance ### Usage to create the HPCS instance @@ -42,7 +46,7 @@ module "hpcs" { source = "git::https://github.com/terraform-ibm-modules/terraform-ibm-hpcs?ref=main" resource_group_id = "000fb3134f214c3a9017554db4510f70" # pragma: allowlist secret region = "us-south" - service_name = "my-hpcs-instance" + name = "my-hpcs-instance" tags = ["tag1","tag2"] plan = "standard" auto_initialization_using_recovery_crypto_units = false @@ -110,7 +114,7 @@ module "hpcs" { source = "git::https://github.com/terraform-ibm-modules/terraform-ibm-hpcs?ref=main" resource_group_id = "000fb3134f214c3a9017554db4510f70" # pragma: allowlist secret region = "us-south" - service_name = "my-hpcs-instance" + name = "my-hpcs-instance" tags = ["tag1","tag2"] auto_initialization_using_recovery_crypto_units = true number_of_crypto_units = 3 @@ -148,7 +152,7 @@ module "hpcs" { source = "git::https://github.com/terraform-ibm-modules/terraform-ibm-hpcs?ref=main" resource_group_id = "000fb3134f214c3a9017554db4510f70" # pragma: allowlist secret region = "us-south" - service_name = "my-hpcs-instance" + name = "my-hpcs-instance" tags = ["tag1","tag2"] auto_initialization_using_recovery_crypto_units = true number_of_crypto_units = 3