New release v1.0.0-rc.1 (#8)

.github/workflows/module-test-pipeline.yml

@@ -10,8 +10,11 @@ jobs:
       - name: Check out code
         uses: actions/checkout@v4
 
-      - name: Set up Terraform latest
-        uses: hashicorp/setup-terraform@v2
+      - name: Set up Terraform latest - with token
+        uses: hashicorp/setup-terraform@v3
+        with:
+          cli_config_credentials_token: ${{ secrets.TF_API_TOKEN }}
+          terraform_wrapper: true
 
       - name: Setup test broker
         run: |
@@ -20,6 +23,15 @@ jobs:
             --env system_scaling_maxconnectioncount="1000" --mount type=bind,source=$HOME/solace,destination=/var/lib/solace,ro=false solace/solace-pubsub-standard:latest
           while ! curl -s localhost:8080 | grep aurelia ; do sleep 1 ; done
 
+      - name: Setup if private provider is required
+        run: |
+          export PRIVATE_PROVIDER_VERSION="1.0.0-rc.3"
+          if [ -n "$PRIVATE_PROVIDER_VERSION" ]; then
+            echo "Using private provider version $PRIVATE_PROVIDER_VERSION"
+            grep -rl 'source  = "' . | xargs sed -i 's@source  = ".*$@source  = "app.terraform.io/SolaceDev/solacebrokerappliance"@g'
+            grep -rl 'version = "' . | xargs sed -i "s@  version = \".*\$@  version = \"${PRIVATE_PROVIDER_VERSION}\"@g"
+          fi
+
       - name: Test module from template on test broker
         run: |
           ci/scripts/test-module.sh ci/template-test
@@ -34,6 +46,10 @@ jobs:
           for d in examples/!(basic-client-username)/; do (ci/scripts/test-module.sh "$d"); done
           # ci/scripts/test-module.sh examples/basic-client-username/ -var-file=secret.tfvars
 
+      - name: Discard any changes in checked out code
+        run: |
+          git checkout -- .
+
       - name: Set up Go
         uses: actions/setup-go@v3
         with:

.github/workflows/prep-internal-release.yml

@@ -46,11 +46,11 @@ jobs:
             --env system_scaling_maxconnectioncount="1000" --mount type=bind,source=$HOME/solace,destination=/var/lib/solace,ro=false solace/solace-pubsub-standard:latest
           while ! curl -s localhost:8080 | grep aurelia ; do sleep 1 ; done
 
-      - name: Check code builds and pass acceptance test
-        run: |
-          ci/scripts/test-module.sh ci/module-test
-          shopt -s extglob
-          for d in examples/!(basic-client-username)/; do (ci/scripts/test-module.sh "$d"); done
+      # - name: Check code builds and pass acceptance test
+      #   run: |
+      #     ci/scripts/test-module.sh ci/module-test
+      #     shopt -s extglob
+      #     for d in examples/!(basic-client-username)/; do (ci/scripts/test-module.sh "$d"); done
 
       - name: Ensure version reflects release candidate version
         run: |

.github/workflows/verify-registry-release.yml

@@ -50,10 +50,10 @@ jobs:
           MODULENAME=service
           if [ "${{ github.event.inputs.public_release }}" == "false" ] ; then
             echo Internal release
-            MODULE_REF="app.terraform.io/SolaceDev/$MODULENAME/solacebroker"
+            MODULE_REF="app.terraform.io/SolaceDev/$MODULENAME/solacebrokerappliance"
           else
             echo Public release
-            MODULE_REF="SolaceProducts/$MODULENAME/solacebroker"
+            MODULE_REF="SolaceProducts/$MODULENAME/solacebrokerappliance"
           fi
           ci/scripts/test-module.sh ci/module-test/ "" $MODULE_REF "${{ github.event.inputs.release_version }}"
 

README.md

@@ -1,82 +1,82 @@
-# Solace PubSub+ Software Event Broker Service Terraform Module
+# Solace PubSub+ Appliance Service Terraform Module
 
-Terraform module that encapsulates a [message VPN](https://docs.solace.com/Features/VPN/Managing-Message-VPNs.htm) including client and ACL profiles, resource limits and service on the [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/).
+This Terraform module encapsulates a [Message VPN](https://docs.solace.com/Features/VPN/Managing-Message-VPNs.htm) including client and ACL profiles, resource limits and service on the [Solace PubSub+ Appliance](https://solace.com/products/event-broker/).
 
-The basic use case is to create a new message VPN with a permissive `default` ACL and client profile, ready for messaging. Optionally, an additional fully customizable ACL profile and a client profile can be defined. The module also adds advanced client certificate authentication and OAuth authentication configuration support.
+You can use this module to create a new Message VPN with a permissive `default` ACL and client profile, ready for messaging. You can also define an optional additional fully customizable ACL and client profile. The module also adds advanced client certificate authentication and OAuth authentication configuration support.
 
-Note: the `default` client username that is automatically created with the new VPN is disabled. It is recommended to use the [Client Module](https://registry.terraform.io/modules/SolceProducts/client/solacebroker/latest) to setup a client username if required. Also, services that require message VPN specific ports, including REST, MQTT etc. are disabled by default and need to be enabled/configured through optional variables.
+Note: the `default` client username that is automatically created with the new Message VPN is disabled. We recommend that you use the [Client Module](https://registry.terraform.io/modules/SolaceProducts/client/solacebrokerappliance/latest) to setup a client username if required. In addition, services that require Message VPN specific ports, including REST, MQTT etc. are disabled by default and need to be enabled/configured through optional variables.
 
-Use case details are provided in the [Examples](#examples).
+Use case details are provided in the [Examples](#examples) section.
 
 ## Module input variables
 
 ### Required
 
-* `msg_vpn_name` - the name of the new message VPN to be created
+* `msg_vpn_name` - The name of the new Message VPN to be created.
 
 ### Optional
 
-* `acl_profile_name` - the name of the optionally added ACL profile. A `default` profile is always created and if left at default empty then no additional ACL profile will be created.
-* `client_profile_name` - the name of the optionally added client profile. A `default` profile is always created and if left at default empty then no additional ACL profile will be created.
-* `oauth_profile_name` - the name of an optionally added OAuth profile. Note that there will be no OAuth profile created unless a non-empty name is provided.
-* `oauth_profile_client_required_claims` - a set of optional client-required claims.
-* `oauth_profile_resource_server_required_claims` - a set of optional server-required claims.
-* `cert_matching_rule_name` - the name of an optionally added certificate matching rule. Note that there will be no certificate matching rule created unless a non-empty name is provided.
-* `cert_matching_rule_conditions` - a set of optional certificate matching rule conditions.
-* `cert_matching_rule_attribute_filters` - a set of optional certificate matching rule attribute filters.
+* `acl_profile_name` - The name of the optionally added ACL profile. A `default` profile is always created and if left at default empty then no additional ACL profile will be created.
+* `client_profile_name` - The name of the optionally added client profile. A `default` profile is always created and if left at default empty then no additional ACL profile will be created.
+* `oauth_profile_name` - The name of an optionally added OAuth profile. Note that there will be no OAuth profile created unless a non-empty name is provided.
+* `oauth_profile_client_required_claims` - A set of optional client-required claims.
+* `oauth_profile_resource_server_required_claims` - A set of optional server-required claims.
+* `cert_matching_rule_name` - The name of an optionally added certificate matching rule. Note that there will be no certificate matching rule created unless a non-empty name is provided.
+* `cert_matching_rule_conditions` - A set of optional certificate matching rule conditions.
+* `cert_matching_rule_attribute_filters` - A set of optional certificate matching rule attribute filters.
 
-Additional optional module variable names are the same as the underlying resource attributes. The recommended approach to determine variable name mappings is to look up the resource's documentation for matching attribute names:
+Additional optional module variable names are the same as the underlying resource attributes. To determine the variable name mappings, we recommend that you look for matching attribute names in the documentation for the resource:
 
 | Resource name |
 |---------------|
-|[solacebroker_msg_vpn](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn#optional)|
-|[solacebroker_msg_vpn_acl_profile](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_acl_profile#optional)|
-|[solacebroker_msg_vpn_client_profile](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_client_profile#optional)|
-|[solacebroker_msg_vpn_authentication_oauth_profile](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_authentication_oauth_profile#optional)|
+|[solacebroker_msg_vpn](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn#optional)|
+|[solacebroker_msg_vpn_acl_profile](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_acl_profile#optional)|
+|[solacebroker_msg_vpn_client_profile](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_client_profile#optional)|
+|[solacebroker_msg_vpn_authentication_oauth_profile](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_authentication_oauth_profile#optional)|
 
-Most optional variables' default value is `null`, meaning that if not provided then the resource default value will be provisioned on the broker.
+The default value for most of the optional variables is `null`, meaning that if you don’t provide a value then the default value of the resource is provisioned on the event broker.
 
 Exceptions: the following optional variables' default value differ from the resource attribute defaults:
 
 | Input variable | Default value | Note |
 |----------------|---------------|------|
 | `authentication_basic_type` | `internal` |
 | `dmr_enabled` | `true` | 
-| `enabled` | `true` | the Message VPN and underlying created objects |
+| `enabled` | `true` | The Message VPN and underlying created objects |
 | `jndi_enabled` | `true` |
-| `max_msg_spool_usage` | 1500 | MB, message VPN |
+| `max_msg_spool_usage` | 1500 | MB, Message VPN |
 
 ## Module outputs
 
 [Module outputs](https://developer.hashicorp.com/terraform/language/values/outputs) provide reference to created resources. Any reference to a resource that has not been created will be set to `(null)`.
 
-Note that the "message VPN" output is [sensitive](https://developer.hashicorp.com/terraform/language/values/outputs#sensitive-suppressing-values-in-cli-output) due to some sensitive attributes it contains.
+Note that the "Message VPN" output is [sensitive](https://developer.hashicorp.com/terraform/language/values/outputs#sensitive-suppressing-values-in-cli-output) due to some sensitive attributes it contains.
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_solacebroker"></a> [solacebroker](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest) | ~> 0.9 |
+| <a name="provider_solacebrokerappliance"></a> [solacebrokerappliance](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest) | >= 1.0 |
 
 ## Resources
 
-The following table shows the resources created. "X" denotes a resource always created, "O" is a resource that may be created optionally
+The following table shows the resources created. "X" denotes a resource that is always created, "O" denotes a resource that you have the option to create.
 
 | Name |  | Notes |
 |------|------|------|
 | solacebroker_msg_vpn | X | |
-| solacebroker_msg_vpn_acl_profile | O | This is an additional configurable profile. A default ACL profile is always created |
-| solacebroker_msg_vpn_client_profile | O | This is an additional configurable profile. A default client profile is always created |
+| solacebroker_msg_vpn_acl_profile | O | This is an additional configurable profile. A default ACL profile is always created. |
+| solacebroker_msg_vpn_client_profile | O | This is an additional configurable profile. A default client profile is always created. |
 | solacebroker_msg_vpn_authentication_oauth_profile | O | |
-| solacebroker_msg_vpn_authentication_oauth_profile_client_required_claim | O | Requires above AOuth profile and it will be assigned to that |
-| solacebroker_msg_vpn_authentication_oauth_profile_resource_server_required_claim | O | Requires above AOuth profile and it will be assigned to that |
+| solacebroker_msg_vpn_authentication_oauth_profile_client_required_claim | O | This requires the above certificate matching rule and will be assigned to that rule upon creation. |
+| solacebroker_msg_vpn_authentication_oauth_profile_resource_server_required_claim | O | This requires the above certificate matching rule and will be assigned to that rule upon creation. |
 | solacebroker_msg_vpn_cert_matching_rule | O | |
 | solacebroker_msg_vpn_cert_matching_rule_condition | O | Requires above certification matching rule and it will be assigned to that |
 | solacebroker_msg_vpn_cert_matching_rule_attribute_filter | O | Requires above certification matching rule and it will be assigned to that |
 
 ## Examples
 
-Refer to the following configuration examples:
+The following examples demonstrate several specific use cases for this module:
 
 - [Basic VPN](examples/basic-vpn)
 - [Services and listen ports](examples/services-and-listen-ports)
@@ -86,7 +86,7 @@ Refer to the following configuration examples:
 
 ## Module use recommendations
 
-This module is expected to be used primarily by middleware teams. It is primarily concerned with setting an environment and constraints where application developer teams may add their specific requirements through the Solace Client, Queues & Endpoints, JNDI or REST delivery modules. This module may be forked and adjusted with private defaults.
+This module is expected to be used primarily by middleware teams. It is primarily concerned with setting an environment and constraints where application developer teams may add their specific requirements through the Solace Client, Queues & Endpoints, JNDI or REST Delivery modules. This module may be forked and adjusted with private defaults.
 
 ## Resources
 

VERSION

@@ -1 +1 @@
-0.1.0-rc.3
+1.0.0-rc.1

ci/module-test/providers.tf

@@ -4,7 +4,7 @@ terraform {
   required_providers {
     solacebroker = {
       source  = "registry.terraform.io/solaceproducts/solacebrokerappliance"
-      version = "~> 0.9"
+      version = "~> 1.0"
     }
   }
   required_version = "~> 1.2"

ci/scripts/test-module.sh

@@ -9,6 +9,7 @@ cat main.tf
 terraform init
 terraform validate
 # Create
+export SOLACEBROKER_SKIP_API_CHECK=true
 terraform plan $2
 terraform apply -auto-approve $2
 # terraform plan $2 | grep "No changes"