Skip to content

Commit 6831dc0

Browse files
authored
fix: update variable description for endpoint_type (#36)
1 parent c07cad1 commit 6831dc0

File tree

4 files changed

+13
-11
lines changed

4 files changed

+13
-11
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ You need the following permissions to run this module.
8888
|------|-------------|------|---------|:--------:|
8989
| <a name="input_cbr_rules"></a> [cbr\_rules](#input\_cbr\_rules) | (Optional, list) List of CBR rules to create | <pre>list(object({<br> description = string<br> account_id = string<br> rule_contexts = list(object({<br> attributes = optional(list(object({<br> name = string<br> value = string<br> }))) }))<br> enforcement_mode = string<br> }))</pre> | `[]` | no |
9090
| <a name="input_enable_event_notification"></a> [enable\_event\_notification](#input\_enable\_event\_notification) | Set this to true to enable lifecycle notifications for your Secrets Manager instance by connecting an Event Notifications service. When setting this to true, a value must be passed for `existing_en_instance_crn` variable. | `bool` | `false` | no |
91-
| <a name="input_endpoint_type"></a> [endpoint\_type](#input\_endpoint\_type) | The endpoint type of the Secrets Manager instance required for establishing a connection between an Event Notifications service. Possible values are `public`, `private`. | `string` | `"public"` | no |
91+
| <a name="input_endpoint_type"></a> [endpoint\_type](#input\_endpoint\_type) | The type of endpoint (public or private) to connect to the Secrets Manager API. The Terraform provider uses this endpoint type to interact with the Secrets Manager API and configure Event Notifications. | `string` | `"public"` | no |
9292
| <a name="input_existing_en_instance_crn"></a> [existing\_en\_instance\_crn](#input\_existing\_en\_instance\_crn) | The CRN of the Event Notifications service to enable lifecycle notifications for your Secrets Manager instance. | `string` | `null` | no |
9393
| <a name="input_existing_kms_instance_guid"></a> [existing\_kms\_instance\_guid](#input\_existing\_kms\_instance\_guid) | The GUID of the Hyper Protect Crypto Services or Key Protect instance in which the key specified in `kms_key_crn` is coming from. Required only if `kms_encryption_enabled` is set to true, and `skip_kms_iam_authorization_policy` is set to false. | `string` | `null` | no |
9494
| <a name="input_kms_encryption_enabled"></a> [kms\_encryption\_enabled](#input\_kms\_encryption\_enabled) | Set this to true to control the encryption keys used to encrypt the data that you store in Secrets Manager. If set to false, the data that you store is encrypted at rest by using envelope encryption. For more details, see https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-mng-data&interface=ui#about-encryption. | `bool` | `false` | no |

tests/other_test.go

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ func TestRunBasicExample(t *testing.T) {
1111
t.Parallel()
1212

1313
options := testhelper.TestOptionsDefaultWithVars(&testhelper.TestOptions{
14-
Testing: t,
15-
TerraformDir: "examples/basic",
16-
Prefix: "secrets-mgr-def",
17-
ResourceGroup: resourceGroup,
14+
Testing: t,
15+
TerraformDir: "examples/basic",
16+
Prefix: "secrets-mgr-def",
1817
})
1918

2019
output, err := options.RunTestConsistency()

tests/pr_test.go

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import (
1111
"github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper/testhelper"
1212
)
1313

14-
const resourceGroup = "geretain-test-secrets-manager"
1514
const defaultExampleTerraformDir = "examples/complete"
1615
const privateExampleTerraformDir = "examples/complete-private"
1716

@@ -34,10 +33,14 @@ func TestMain(m *testing.M) {
3433

3534
func setupOptions(t *testing.T, prefix string) *testhelper.TestOptions {
3635
options := testhelper.TestOptionsDefaultWithVars(&testhelper.TestOptions{
37-
Testing: t,
38-
TerraformDir: defaultExampleTerraformDir,
39-
Prefix: prefix,
40-
ResourceGroup: resourceGroup,
36+
Testing: t,
37+
TerraformDir: defaultExampleTerraformDir,
38+
Prefix: prefix,
39+
/*
40+
Comment out the 'ResourceGroup' input to force this tests to create a unique resource group. This is because
41+
there is a restriction with the Event Notification service, which allows only one Lite plan instance per resource group.
42+
*/
43+
// ResourceGroup: resourceGroup,
4144
BestRegionYAMLPath: "../common-dev-assets/common-go-assets/cloudinfo-region-secmgr-prefs.yaml",
4245
})
4346

variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ variable "existing_en_instance_crn" {
111111

112112
variable "endpoint_type" {
113113
type = string
114-
description = "The endpoint type of the Secrets Manager instance required for establishing a connection between an Event Notifications service. Possible values are `public`, `private`."
114+
description = "The type of endpoint (public or private) to connect to the Secrets Manager API. The Terraform provider uses this endpoint type to interact with the Secrets Manager API and configure Event Notifications."
115115
default = "public"
116116
validation {
117117
condition = contains(["public", "private"], var.endpoint_type)

0 commit comments

Comments
 (0)