feat: renamed the service_endpoints input to endpoint_type (#298)

Author: mukulpalit-ibm

README.md

@@ -189,6 +189,7 @@ No modules.
 | <a name="input_ca_config_name"></a> [ca\_config\_name](#input\_ca\_config\_name) | Name of the CA config for the public\_cert secrets engine | `string` | `null` | no |
 | <a name="input_cis_account_id"></a> [cis\_account\_id](#input\_cis\_account\_id) | Account ID of the CIS instance (only needed if different from Secrets Manager account) | `string` | `null` | no |
 | <a name="input_dns_config_name"></a> [dns\_config\_name](#input\_dns\_config\_name) | Name of the DNS config for the public\_cert secrets engine | `string` | `null` | no |
+| <a name="input_endpoint_type"></a> [endpoint\_type](#input\_endpoint\_type) | The endpoint type to communicate with the provided secrets manager instance. Possible values are `public` or `private` | `string` | `"public"` | no |
 | <a name="input_ibmcloud_cis_api_key"></a> [ibmcloud\_cis\_api\_key](#input\_ibmcloud\_cis\_api\_key) | Optional, when not using IAM authorization, use an API key for CIS DNS configuration | `string` | `null` | no |
 | <a name="input_internet_service_domain_id"></a> [internet\_service\_domain\_id](#input\_internet\_service\_domain\_id) | (optional) Specific domain in the CIS to authorize Secrets Manager access to. | `string` | `null` | no |
 | <a name="input_internet_services_crn"></a> [internet\_services\_crn](#input\_internet\_services\_crn) | CRN of the CIS instance to authorize Secrets Manager against | `string` | `null` | no |
@@ -198,7 +199,6 @@ No modules.
 | <a name="input_private_key_secrets_manager_secret_id"></a> [private\_key\_secrets\_manager\_secret\_id](#input\_private\_key\_secrets\_manager\_secret\_id) | The secret ID of your ACME private key. Required if acme\_letsencrypt\_private\_key is not set. If both are set, this value will be used as the private key. | `string` | `null` | no |
 | <a name="input_region"></a> [region](#input\_region) | Region where resources will be created or fetched from | `string` | `"us-south"` | no |
 | <a name="input_secrets_manager_guid"></a> [secrets\_manager\_guid](#input\_secrets\_manager\_guid) | GUID of secrets manager instance to create the secret engine in | `string` | n/a | yes |
-| <a name="input_service_endpoints"></a> [service\_endpoints](#input\_service\_endpoints) | The service endpoint type to communicate with the provided secrets manager instance. Possible values are `public` or `private` | `string` | `"public"` | no |
 | <a name="input_skip_iam_authorization_policy"></a> [skip\_iam\_authorization\_policy](#input\_skip\_iam\_authorization\_policy) | Set to true to skip the creation of an IAM authorization policy that permits Secrets Manager to create a DNS config in the CIS specified in `internet_services_crn`. WARNING: An authorization policy must exist before a DNS config can be created, OR an API key must be provided in `ibmcloud_cis_api_key` | `bool` | `false` | no |
 
 ### Outputs

examples/api_key_auth/main.tf

@@ -65,7 +65,7 @@ module "public_secret_engine" {
   private_key_secrets_manager_instance_guid = var.private_key_secrets_manager_instance_guid
   private_key_secrets_manager_secret_id     = var.private_key_secrets_manager_secret_id
   private_key_secrets_manager_region        = var.private_key_secrets_manager_region
-  service_endpoints                         = "private"
+  endpoint_type                             = "private"
 }
 
 # TODO: Uncomment the following block once the certificate module is published

ibm_catalog.json

@@ -266,7 +266,7 @@
               "description": "The pricing plan to use when provisioning a Secrets Manager instance. Possible values: `standard`, `trial`. You can create only one Trial instance of Secrets Manager per account. Before you can create a new Trial instance, you must delete the existing Trial instance and its reclamation. [Learn more](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-create-instance&interface=ui#upgrade-instance-standard)."
             },
             {
-              "key": "service_endpoints",
+              "key": "endpoint_type",
               "hidden": true
             },
             {

main.tf

@@ -56,7 +56,7 @@ resource "ibm_sm_public_certificate_configuration_dns_cis" "public_dns_config" {
   count                          = var.dns_config_name != null ? 1 : 0
   instance_id                    = var.secrets_manager_guid
   region                         = var.region
-  endpoint_type                  = var.service_endpoints
+  endpoint_type                  = var.endpoint_type
   name                           = var.dns_config_name
   cloud_internet_services_apikey = var.ibmcloud_cis_api_key
   cloud_internet_services_crn    = var.internet_services_crn
@@ -80,7 +80,7 @@ resource "ibm_sm_public_certificate_configuration_ca_lets_encrypt" "public_ca_co
   count                    = var.ca_config_name != null ? 1 : 0
   instance_id              = var.secrets_manager_guid
   region                   = var.region
-  endpoint_type            = var.service_endpoints
+  endpoint_type            = var.endpoint_type
   name                     = var.ca_config_name
   lets_encrypt_environment = var.lets_encrypt_environment
   lets_encrypt_private_key = local.acme_letsencrypt_private_key

solutions/fully-configurable/main.tf

@@ -44,7 +44,7 @@ module "secrets_manager_public_cert_engine" {
   ca_config_name                            = var.ca_config_name == null ? null : "${local.prefix}${var.ca_config_name}"
   lets_encrypt_environment                  = var.lets_encrypt_environment
   acme_letsencrypt_private_key              = var.acme_letsencrypt_private_key
-  service_endpoints                         = var.service_endpoints
+  endpoint_type                             = var.endpoint_type
   skip_iam_authorization_policy             = var.skip_iam_authorization_policy
   private_key_secrets_manager_instance_guid = local.existing_secrets_manager_guid
   private_key_secrets_manager_secret_id     = local.secret_id

solutions/fully-configurable/variables.tf

@@ -53,9 +53,9 @@ variable "prefix" {
   }
 }
 
-variable "service_endpoints" {
+variable "endpoint_type" {
   type        = string
-  description = "The service endpoint type to communicate with the provided secrets manager instance."
+  description = "The endpoint type to communicate with the provided secrets manager instance."
   default     = "private"
 }
 

variables.tf

@@ -73,13 +73,13 @@ variable "acme_letsencrypt_private_key" {
   }
 }
 
-variable "service_endpoints" {
+variable "endpoint_type" {
   type        = string
-  description = "The service endpoint type to communicate with the provided secrets manager instance. Possible values are `public` or `private`"
+  description = "The endpoint type to communicate with the provided secrets manager instance. Possible values are `public` or `private`"
   default     = "public"
   validation {
-    condition     = contains(["public", "private"], var.service_endpoints)
-    error_message = "The specified service_endpoints is not a valid selection!"
+    condition     = contains(["public", "private"], var.endpoint_type)
+    error_message = "The specified endpoint_type is not a valid selection!"
   }
 }