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

* 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
@@ -34,6 +46,10 @@ jobs:
           for d in examples/!(adding-headers)/; do (ci/scripts/test-module.sh "$d"); done
           ci/scripts/test-module.sh examples/adding-headers/ -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,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,10 +1,10 @@
 # Solace PubSub+ Software Event Broker REST Delivery Terraform Module
 
-Terraform module to support the setup of a [REST consumer](https://docs.solace.com/API/REST/REST-Consumers.htm) on the [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/).
+This Terraform module supports the setup of a [REST consumer](https://docs.solace.com/API/REST/REST-Consumers.htm) on the [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/).
 
 Given a queue on the broker, as a destination for messages to be forwarded to a REST consumer application, this module configures a [REST delivery point](https://docs.solace.com/API/REST/REST-Consumers.htm#_Toc433874658) between the queue and the application.
 
-Specific use case details are provided in the [Examples](#examples).
+Specific use case details are provided in the [Examples](#examples) section.
 
 ## Limitations
 
@@ -25,12 +25,12 @@ Important: The REST delivery point must have permission to consume messages from
 
 ### Optional
 
-* `client_profile_name` - the [client profile associated](https://docs.solace.com/Services/Managing-RDPs.htm#associating-client-profiles-with-REST-delivery-points). If not provided, the `default` client profile for the Message VPN will be associated.
-* `request_headers` - A set of request headers to be added to the HTTP request
-* `protected_request_headers` - A set of protected request headers with sensitive value to be added to the HTTP request
+* `client_profile_name` - The [client profile associated](https://docs.solace.com/Services/Managing-RDPs.htm#associating-client-profiles-with-REST-delivery-points). If not provided, the `default` client profile for the Message VPN will be associated.
+* `request_headers` - A set of request headers to be added to the HTTP request.
+* `protected_request_headers` - A set of protected request headers with sensitive value to be added to the HTTP request.
 * `rest_consumer_name` - The name of the REST consumer to be created. The default is `consumer`.
 
-Additional optional module variables 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 variables 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 |
 |---------------|
@@ -40,7 +40,7 @@ Additional optional module variables names are the same as the underlying resour
 |[solacebroker_msg_vpn_rest_delivery_point_queue_binding_request_header](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_rest_delivery_point_queue_binding_request_header#optional)|
 |[solacebroker_msg_vpn_rest_delivery_point_queue_binding_protected_request_header](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header#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.
 
 -> The module default for the `enabled` optional variable is `true`, which differ from the resource attribute default.
 
@@ -54,11 +54,11 @@ Note that the "rest consumer" and the "protected request headers" outputs are [s
 
 | 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
 
-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 | |
 |------|------|
@@ -70,7 +70,7 @@ The following table shows the resources created. "X" denotes a resource always c
 
 ## Examples
 
-Refer to the following configuration examples:
+The following examples demonstrate several specific use cases for this module:
 
 - [Basic](examples/basic)
 - [Substitution expressions](examples/using-substitution-expressions)

VERSION

@@ -1 +1 @@
-0.1.0-rc.6
+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"