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

* Updated API spec to broker 10.8.1

.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.7"
+          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/solacebroker"@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
@@ -33,6 +45,10 @@ jobs:
           for dir in examples/*; do (ci/scripts/test-module.sh "$dir"); done
           # ci/scripts/test-module.sh examples/non-exclusive-queue
 
+      - 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,10 +46,10 @@ 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
-          for dir in examples/*; do (ci/scripts/test-module.sh "$dir"); done
+      # - name: Check code builds and pass acceptance test
+      #   run: |
+      #     ci/scripts/test-module.sh ci/module-test
+      #     for dir in examples/*; do (ci/scripts/test-module.sh "$dir"); done
 
       - name: Ensure version reflects release candidate version
         run: |

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

@@ -29,7 +29,7 @@ jobs:
         run: |
           mkdir -p $HOME/solace; chmod 777 $HOME/solace
           docker run -d -p 8080:8080 -p 55555:55555 --shm-size=1g --env username_admin_globalaccesslevel=admin --env username_admin_password=admin --env system_scaling_maxkafkabridgecount="10" --name=solace \
-            --mount type=bind,source=$HOME/solace,destination=/var/lib/solace,ro=false solace/solace-pubsub-standard:"10.6.1.52"
+            --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: Set up Terraform latest - public

README.md

@@ -1,48 +1,48 @@
 # Solace PubSub+ Software Event Broker JNDI Terraform Module
 
-Terraform module to configure a [connection factory object](https://docs.solace.com/API/Solace-JMS-API/Connection-Factories.htm) in the JNDI store of a [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/). 
+This Terraform module configures a [connection factory object](https://docs.solace.com/API/Solace-JMS-API/Connection-Factories.htm) in the JNDI store of a [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/). 
 
-Full details are provided in the [Examples](#examples).
+Use case details are provided in the [Examples](#examples) section.
 
 ## Related modules
 
-To use JNDI, access must be enabled on the Message VPN. This can be configured using the [Service Module](TODO:fixlink). By default, JNDI access is not enabled on Solace PubSub+ appliances, but it is enabled on Solace PubSub+ software event brokers.
+To use JNDI, access must be enabled on the Message VPN. You can configure this using the [Service Module](TODO:fixlink). By default, JNDI access is not enabled on Solace PubSub+ appliances, but it is enabled on Solace PubSub+ software event brokers.
 
 To configure JNDI managed objects (JNDI Topics and Queues) when provisioning a PubSub+ queue or topic endpoint, use the [Queues & Endpoints Module](TODO:fixlink).
 
 ## Module input variables
 
 ### Required
 
-* `msg_vpn_name` - the Message VPN on the broker for which JNDI configuration is created
-* `connection_factory_name` - The name of the connection factory to be created
+* `msg_vpn_name` - the Message VPN on the event broker for which JNDI configuration is created.
+* `connection_factory_name` - The name of the connection factory to be created.
 
 ### Optional
 
-* `local_transactions_enabled` - specifies if the connection factory shall support local transactions. The default is `false`.
-* `xa_enabled` - specifies if the connection factory shall support XA transactions. When enabled it also enables local transactions support. The default is `false`. Note: this variable has the same name and use as the underlying resource attribute.
+* `local_transactions_enabled` - Specifies if the connection factory shall support local transactions. The default is `false`.
+* `xa_enabled` - Specifies if the connection factory shall support XA transactions. When enabled it also enables local transactions support. The default is `false`. Note: this variable has the same name and use as the underlying resource attribute.
 
-Additional optional module variables names are the same as the underlying connection factory 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 variables names are the same as the underlying connection factory 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_jndi_connection_factory](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_jndi_connection_factory#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.
 
 ## 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)`.
 
 Outputs:
-* `connection_factory` - the connection factory created
-* `xa_connection_factory` - an alternative reference to the same `connection_factory`, only if an XA connection factory has been created
+* `connection_factory` - The connection factory created.
+* `xa_connection_factory` - An alternative reference to the same `connection_factory`, only if an XA connection factory has been created.
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_solacebroker"></a> [solacebroker](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest) | ~> 0.9 |
+| <a name="provider_solacebroker"></a> [solacebroker](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest) | ~> 1.0 |
 
 ## Resources
 
@@ -54,11 +54,11 @@ The following table shows the resources created.
 
 ## Examples
 
-Refer to the following configuration examples:
+The following examples demonstrate several specific use cases for this module:
 
-- [Connection factory](examples/basic/)
-    - [Connection factory with local transactions support](examples/local-transactions-support/)
-    - [Connection factory with XA transactions support](examples/xa-transactions-support/)
+- [Basic connection factory](examples/basic/)
+- [Connection factory with local transactions support](examples/local-transactions-support/)
+- [Connection factory with XA transactions support](examples/xa-transactions-support/)
 
 ## Module use recommendations
 

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/solacebroker"
-      version = "~> 0.9"
+      version = "~> 1.0"
     }
   }
   required_version = "~> 1.2"