diff --git a/.github/workflows/verify-registry-release.yml b/.github/workflows/verify-registry-release.yml index c3cb8ae..fb91ac8 100644 --- a/.github/workflows/verify-registry-release.yml +++ b/.github/workflows/verify-registry-release.yml @@ -49,10 +49,10 @@ jobs: run: | if [ "${{ github.event.inputs.public_release }}" == "false" ] ; then echo Internal release - MODULE_REF="app.terraform.io/SolaceDev/queue-endpoint/solacebroker" + MODULE_REF="app.terraform.io/SolaceDev/queue-endpoint/solacebrokerappliance" else echo Public release - MODULE_REF="SolaceProducts/queue-endpoint/solacebroker" + MODULE_REF="SolaceProducts/queue-endpoint/solacebrokerappliance" fi ci/scripts/test-module.sh ci/module-test/ $MODULE_REF "${{ github.event.inputs.release_version }}" diff --git a/README.md b/README.md index 400de67..042a2e3 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Solace PubSub+ Appliance Queues & Endpoints Terraform Module +# Solace PubSub+ Software Event Broker Queues & Endpoints Terraform Module -Terraform module to configure a "guaranteed messaging endpoint" or an "endpoint template" on the [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/). +This Terraform module configures a "guaranteed messaging endpoint" or an "endpoint template" on the [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/). -This module supports the configuration of one of the followings: +This module supports the configuration of one of the following: - a "_queue_" or a "_topic endpoint_": applications that make use of [Guaranteed Messaging](https://docs.solace.com/Messaging/Guaranteed-Msg/Guaranteed-Messages.htm), need [endpoints](https://docs.solace.com/Messaging/Guaranteed-Msg/Endpoints.htm) configured on the event broker to persist messages. A queue may also have a list of [topic subscriptions](https://docs.solace.com/API/API-Developer-Guide/Adding-Topic-Subscriptio.htm). @@ -10,30 +10,30 @@ This module supports the configuration of one of the followings: The module also supports exposing a created queue or topic endpoint via JNDI for JMS applications. -Full details are provided in the [Examples](#examples). +Use case details are provided in the [Examples](#examples) section. ## Module input variables ### Required -* `msg_vpn_name` - Endpoints and endpoint templates are specific to a Message VPN on the broker +* `msg_vpn_name` - Endpoints and endpoint templates are specific to a Message VPN on the broker. * `endpoint_type` - The type of the endpoint or template to be created. Only one type is allowed at a time. -* `endpoint_name` - The name of the endpoint or template to be created -* `permission` - Queues or topic endpoints must have proper `owner` or `permission` for non-owners configured to enable clients to connect and consume messages. The user shall consider the security implications when choosing a value. For additional details, refer to the [PubSub+ documentation](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Permissions_for_Non-Owner_Clients_..57) +* `endpoint_name` - The name of the endpoint or template to be created. +* `permission` - Queues or topic endpoints must have a valid `owner` or `permission` for non-owners configured to enable clients to connect and consume messages. Consider the security implications when choosing a value. For more information, see the [PubSub+ documentation](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Permissions_for_Non-Owner_Clients_..57). ### Optional -Optional module variables are either shared by multiple types, or conditional to the type where incompatible variables will be ignored. For example, the `permission` variable is shared by all endpoint and template types but `queue_name_filter` is specific to the `queue_template` type and ignored for other types. The recommended approach to determine variable name mappings is to look up the endpoint or template resource's documentation for matching attribute names: +Optional module variables are either shared by multiple types, or conditional to the type where incompatible variables will be ignored. For example, the `permission` variable is shared by all endpoint and template types but `queue_name_filter` is specific to the `queue_template` type and ignored for other types. To determine the variable name mappings, we recommend that you look for matching attribute names in the documentation for the endpoint or template resource: | Resource name | |---------------| -|[solacebroker_msg_vpn_queue](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional)| -|[solacebroker_msg_vpn_topic_endpoint](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint#optional)| -|[solacebroker_msg_vpn_queue_template](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue_template#optional)| -|[solacebroker_msg_vpn_topic_endpoint_template](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint_template#optional)| +|[solacebroker_msg_vpn_queue](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional)| +|[solacebroker_msg_vpn_topic_endpoint](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint#optional)| +|[solacebroker_msg_vpn_queue_template](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue_template#optional)| +|[solacebroker_msg_vpn_topic_endpoint_template](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint_template#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 defaults for `ingress_enabled` and `egress_enabled` optional variables are `true`, which differ from the resource attribute defaults. @@ -45,11 +45,11 @@ Most optional variables' default value is `null`, meaning that if not provided t | Name | Version | |------|---------| -| [solacebroker](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest) | >= 1.0 | +| [solacebrokerappliance](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest) | >= 1.0 | ## Resources -The following table shows the resources created for each `endpoint-type` value. "X" denotes a resource always created, "O" is a resource that may be created optionally +The following table shows the resources created for each `endpoint-type` value. "X" denotes a resource that is always created, "O" denotes a resource that you have the option to create. | Name | queue | topic_endpoint | queue_template | topic_endpoint_template | |------|------|------|------|------| @@ -63,7 +63,7 @@ The following table shows the resources created for each `endpoint-type` value. ## Examples -Refer to the following configuration examples: +The following examples demonstrate several specific use cases for this module: - Queue - [Exclusive queue](examples/exclusive-queue) diff --git a/examples/exclusive-queue/README.md b/examples/exclusive-queue/README.md index c071549..34c4fa8 100644 --- a/examples/exclusive-queue/README.md +++ b/examples/exclusive-queue/README.md @@ -6,49 +6,49 @@ Configuration in this directory creates an [exclusive queue](https://docs.solace ### Mandatory Inputs -* `msg_vpn_name` - set to `default` in the example -* `endpoint_type` - set to `queue` -* `endpoint_name` - set to `testEQ` in the example -* `permission` - set to `consume` in the example to enable the receiver app to remove consumed messages from the queue +* `msg_vpn_name` - Set to `default` in the example. +* `endpoint_type` - Set to `queue` in the example. +* `endpoint_name` - Set to `testEQ` in the example. +* `permission` - Set to `consume` in the example to enable the receiver app to remove consumed messages from the queue. ### Optional Inputs The `access_type` module input variable defines if a queue is "exclusive" or "non-exclusive". The default is "exclusive", so the variable doesn't need to be strictly specified. -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted, then the default for the related resource attribute will be configured on the broker. For a list of attributes and the corresponding defaults, see the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). ### Output The module `provisioned_queue` output refers to the created queue. -## Created resources +## Created Resources -This example will create following resources: +This example will create the following resources: * `solacebroker_msg_vpn_queue` ## Running the Example -### Access to a PubSub+ broker +### Access to a PubSub+ Event Broker -If you don't already have access to a broker, refer to the [Developers page](https://www.solace.dev/) for options to get started. +If you don't already have access to a broker, see the [Developers page](https://www.solace.dev/) for options to get started. -### Sample source code +### Sample Source Code The sample is available from the module GitHub repo: ```bash -git clone https://github.com/SolaceProducts/terraform-solacebroker-queue-endpoint.git +git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-queue-endpoint.git cd examples/exclusive-queue ``` -### Adjust Provider Configuration +### Adjust the Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. -### Create the resource +### Create the Resource -Hint: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm) +Tip: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm). Execute from this folder: @@ -58,9 +58,9 @@ terraform plan terraform apply ``` -Run `terraform destroy` to clean up created resources when no longer needed. +Run `terraform destroy` to clean up the created resources when they are no longer needed. ## Additional Documentation -Refer to the [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation. +For more information, see [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation. diff --git a/examples/non-exclusive-queue/README.md b/examples/non-exclusive-queue/README.md index fe2ea0e..10916c8 100644 --- a/examples/non-exclusive-queue/README.md +++ b/examples/non-exclusive-queue/README.md @@ -6,49 +6,49 @@ Configuration in this directory creates a [non-exclusive queue](https://docs.sol ### Mandatory Inputs -* `msg_vpn_name` - set to `default` in the example -* `endpoint_type` - set to `queue` -* `endpoint_name` - set to `testNEQ` in the example -* `permission` - set to `consume` in the example to enable the receiver app to remove consumed messages from the queue +* `msg_vpn_name` - Set to `default` in the example. +* `endpoint_type` - Set to `queue` in the example. +* `endpoint_name` - Set to `testNEQ` in the example. +* `permission` - Set to `consume` in the example to enable the receiver app to remove consumed messages from the queue. ### Optional Inputs The `access_type` module input variable defines if a queue is "exclusive" or "non-exclusive". This needs to be specified for a "non-exclusive" queue. -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted, then the default for the related resource attribute will be configured on the broker. For a list of attributes and the corresponding defaults, see the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). ### Output The module `provisioned_queue` output refers to the created queue. -## Created resources +## Created Resources -This example will create following resources: +This example will create the following resources: * `solacebroker_msg_vpn_queue` ## Running the Example -### Access to a PubSub+ broker +### Access to a PubSub+ Event Broker -If you don't already have access to a broker, refer to the [Developers page](https://www.solace.dev/) for options to get started. +If you don't already have access to a broker, see the [Developers page](https://www.solace.dev/) for options to get started. -### Sample source code +### Sample Source Code The sample is available from the module GitHub repo: ```bash -git clone https://github.com/SolaceProducts/terraform-solacebroker-queue-endpoint.git +git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-queue-endpoint.git cd examples/non-exclusive-queue ``` -### Adjust Provider Configuration +### Adjust the Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. -### Create the resource +### Create the Resource -Hint: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm) +Tip: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm). Execute from this folder: @@ -58,9 +58,9 @@ terraform plan terraform apply ``` -Run `terraform destroy` to clean up created resources when no longer needed. +Run `terraform destroy` to clean up the created resources when they are no longer needed. ## Additional Documentation -Refer to the [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation. +For more information, see [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation. diff --git a/examples/partitioned-queue/README.md b/examples/partitioned-queue/README.md index 157bd30..5297aa8 100644 --- a/examples/partitioned-queue/README.md +++ b/examples/partitioned-queue/README.md @@ -6,53 +6,53 @@ Configuration in this directory creates a [partitioned queue](https://docs.solac ### Mandatory Inputs -* `msg_vpn_name` - set to `default` in the example -* `endpoint_type` - set to `queue` -* `endpoint_name` - set to `testPQ` in the example -* `permission` - set to `consume` in the example to enable the receiver app to remove consumed messages from the queue +* `msg_vpn_name` - Set to `default` in the example. +* `endpoint_type` - Set to `queue` in the example. +* `endpoint_name` - Set to `testPQ` in the example. +* `permission` - Set to `consume` in the example to enable the receiver app to remove consumed messages from the queue. ### Optional Inputs A partitioned queue is a queue with "non-exclusive" access type and greater than zero partition count. Configuration details are provided in the [PubSub+ documentation](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#configure-partitioned-queues). * `access_type`: must be set to "non-exclusive" -* `partition_count`: greater than zero partitionals needs to be specified -* `partition_rebalance_delay` and `partition_rebalance_max_handoff_time` are additional optional configurations specifically related to partitioned queues +* `partition_count`: greater than zero partitions needs to be specified +* `partition_rebalance_delay` and `partition_rebalance_max_handoff_time` are additional optional settings specifically related to partitioned queues -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted, then the default for the related resource attribute will be configured on the broker. For a list of attributes and the corresponding defaults, see the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). ### Output The module `provisioned_queue` output refers to the created queue. -## Created resources +## Created Resources -This example will create following resources: +This example will create the following resources: * `solacebroker_msg_vpn_queue` ## Running the Example -### Access to a PubSub+ broker +### Access to a PubSub+ Event Broker -If you don't already have access to a broker, refer to the [Developers page](https://www.solace.dev/) for options to get started. +If you don't already have access to a broker, see the [Developers page](https://www.solace.dev/) for options to get started. -### Sample source code +### Sample Source Code The sample is available from the module GitHub repo: ```bash -git clone https://github.com/SolaceProducts/terraform-solacebroker-queue-endpoint.git +git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-queue-endpoint.git cd examples/partitioned-queue ``` -### Adjust Provider Configuration +### Adjust the Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. -### Create the resource +### Create the Resource -Hint: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm) +Tip: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm). Execute from this folder: @@ -62,9 +62,9 @@ terraform plan terraform apply ``` -Run `terraform destroy` to clean up created resources when no longer needed. +Run `terraform destroy` to clean up the created resources when they are no longer needed. ## Additional Documentation -Refer to the [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation. +For more information, see [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation. diff --git a/examples/queue-template/README.md b/examples/queue-template/README.md index 1fd0017..2512eb2 100644 --- a/examples/queue-template/README.md +++ b/examples/queue-template/README.md @@ -6,49 +6,49 @@ Configuration in this directory creates a [queue template](https://docs.solace.c ### Mandatory Inputs -* `msg_vpn_name` - set to `default` in the example -* `endpoint_type` - set to `queue` -* `endpoint_name` - set to `testQT` in the example -* `permission` - set to `consume` in the example to enable the receiver app to remove consumed messages from the queue, that has been created from the template +* `msg_vpn_name` - Set to `default` in the example. +* `endpoint_type` - Set to `queue` in the example. +* `endpoint_name` - Set to `testQT` in the example. +* `permission` - Set to `consume` in the example to enable the receiver app to remove consumed messages from the queue, that has been created from the template. ### Optional Inputs This example specifies an optional attribute `respect_ttl_enabled` of the queue template for demo purposes. -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue_template"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue_template#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted, then the default for the related resource attribute will be configured on the broker. For a list of attributes and the corresponding defaults, see the [documentation of "solacebroker_msg_vpn_queue_template"](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue_template#optional). ### Output The module `provisioned_queue_template` output refers to the created queue template. -## Created resources +## Created Resources -This example will create following resources: +This example will create the following resources: * `solacebroker_msg_vpn_queue_template` ## Running the Example -### Access to a PubSub+ broker +### Access to a PubSub+ Event Broker -If you don't already have access to a broker, refer to the [Developers page](https://www.solace.dev/) for options to get started. +If you don't already have access to a broker, see the [Developers page](https://www.solace.dev/) for options to get started. -### Sample source code +### Sample Source Code The sample is available from the module GitHub repo: ```bash -git clone https://github.com/SolaceProducts/terraform-solacebroker-queue-endpoint.git +git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-queue-endpoint.git cd examples/queue-template ``` -### Adjust Provider Configuration +### Adjust the Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. -### Create the resource +### Create the Resource -Hint: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm) +Tip: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm). Execute from this folder: @@ -58,9 +58,9 @@ terraform plan terraform apply ``` -Run `terraform destroy` to clean up created resources when no longer needed. +Run `terraform destroy` to clean up the created resources when they are no longer needed. ## Additional Documentation -Refer to the [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation. +For more information, see [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation. diff --git a/examples/queue-with-jndi/README.md b/examples/queue-with-jndi/README.md index e78a68d..000fa16 100644 --- a/examples/queue-with-jndi/README.md +++ b/examples/queue-with-jndi/README.md @@ -2,22 +2,22 @@ Configuration in this directory creates a [queue that is also exposed as a JNDI administered object](https://docs.solace.com/API/Solace-JMS-API/Managing-Solace-JNDI-Objects.htm) on the PubSub+ event broker leveraging the Queues & Endpoints Terraform module. -Note that exposing queues as JNDI objects also requires JNDI enabled at the Message VPN level and the configuration of a Connection Factory. The [Service Module](TODO:add link) and the [JNDI Connection Factory Module](TODO:add link) may be used to configure that. This module will not check if they are in place but configuration will fail. +Note that exposing queues as JNDI objects requires that you enable JNDI at the Message VPN level and configure a connection factory. You can use the [Service Module](https://registry.terraform.io/modules/SolaceProducts/service/solacebrokerappliance/latest) and the [JNDI Connection Factory Module](https://registry.terraform.io/modules/SolaceProducts/jndi/solacebrokerappliance/latest) to perform these tasks. This module will not check if the requirements are in place, however, if they aren't the configuration will fail. ## Module Configuration in the Example ### Mandatory Inputs -* `msg_vpn_name` - set to `default` in the example -* `endpoint_type` - set to `queue` -* `endpoint_name` - set to `testJQ` in the example -* `permission` - set to `consume` in the example to enable the receiver app to remove consumed messages from the queue +* `msg_vpn_name` - Set to `default` in the example. +* `endpoint_type` - Set to `queue` in the example. +* `endpoint_name` - Set to `testJQ` in the example. +* `permission` - Set to `consume` in the example to enable the receiver app to remove consumed messages from the queue. ### Optional Inputs * `jndi_queue_name`: if provided then the queue will be exposed to JNDI under this name -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted, then the default for the related resource attribute will be configured on the broker. For a list of attributes and the corresponding defaults, see the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). ### Output @@ -25,35 +25,35 @@ The module `provisioned_queue` output refers to the created queue. The module `provisioned_jndi_queue` output refers to the created JNDI queue resource. -## Created resources +## Created Resources -This example will create following resources: +This example will create the following resources: * `solacebroker_msg_vpn_queue` * `solacebroker_msg_vpn_jndi_queue` if `jndi_queue_name` has been provided ## Running the Example -### Access to a PubSub+ broker +### Access to a PubSub+ Event Broker -If you don't already have access to a broker, refer to the [Developers page](https://www.solace.dev/) for options to get started. +If you don't already have access to a broker, see the [Developers page](https://www.solace.dev/) for options to get started. -### Sample source code +### Sample Source Code The sample is available from the module GitHub repo: ```bash -git clone https://github.com/SolaceProducts/terraform-solacebroker-queue-endpoint.git +git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-queue-endpoint.git cd examples/queue-with-jndi ``` -### Adjust Provider Configuration +### Adjust the Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. -### Create the resource +### Create the Resource -Hint: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm) +Tip: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm). Execute from this folder: @@ -63,9 +63,9 @@ terraform plan terraform apply ``` -Run `terraform destroy` to clean up created resources when no longer needed. +Run `terraform destroy` to clean up the created resources when they are no longer needed. ## Additional Documentation -Refer to the [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation. +For more information, see [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation. diff --git a/examples/queue-with-topic-subscriptions/README.md b/examples/queue-with-topic-subscriptions/README.md index 57b279e..da3466a 100644 --- a/examples/queue-with-topic-subscriptions/README.md +++ b/examples/queue-with-topic-subscriptions/README.md @@ -1,4 +1,4 @@ -# Queue with Topic Subsciptions Example +# Queue with Topic Subscriptions Example Configuration in this directory creates a [queue with topic subscriptions](https://docs.solace.com/API/API-Developer-Guide/Adding-Topic-Subscriptio.htm) on the PubSub+ event broker leveraging the Queues & Endpoints Terraform module. @@ -6,18 +6,18 @@ Configuration in this directory creates a [queue with topic subscriptions](https ### Mandatory Inputs -* `msg_vpn_name` - set to `default` in the example -* `endpoint_type` - set to `queue` -* `endpoint_name` - set to `testQS` in the example -* `permission` - set to `consume` in the example to enable the receiver app to remove consumed messages from the queue +* `msg_vpn_name` - Set to `default` in the example. +* `endpoint_type` - Set to `queue` in the example. +* `endpoint_name` - Set to `testQS` in the example. +* `permission` - Set to `consume` in the example to enable the receiver app to remove consumed messages from the queue. ### Optional Inputs -A list of subscriptions to one or more topics may be specified for the queue. Topics may include [wildcards](https://docs.solace.com/Messaging/Wildcard-Charaters-Topic-Subs.htm). Additional configuration details are provided in the [PubSub+ documentation](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#configure-partitioned-queues). +You can specify a list of subscriptions to one or more topics for the queue. Topics may include [wildcards](https://docs.solace.com/Messaging/Wildcard-Charaters-Topic-Subs.htm). Additional configuration details are provided in the [PubSub+ documentation](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#configure-partitioned-queues). * `queue_subscription_topics`: the list of topics as strings to subscribe to. Omitting this parameter or an empty list means no subscription. -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted, then the default for the related resource attribute will be configured on the broker. For a list of attributes and the corresponding defaults, see the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). ### Output @@ -25,35 +25,35 @@ The module `provisioned_queue` output refers to the created queue. The module `provisioned_queue_subscriptions` output lists the created subscription resources for the queue. -## Created resources +## Created Resources -This example will create following resources: +This example will create the following resources: * `solacebroker_msg_vpn_queue` * zero or more `solacebroker_msg_vpn_queue_subscription` resources, depending on the number of subscription topics provided ## Running the Example -### Access to a PubSub+ broker +### Access to a PubSub+ Event Broker -If you don't already have access to a broker, refer to the [Developers page](https://www.solace.dev/) for options to get started. +If you don't already have access to a broker, see the [Developers page](https://www.solace.dev/) for options to get started. -### Sample source code +### Sample Source Code The sample is available from the module GitHub repo: ```bash -git clone https://github.com/SolaceProducts/terraform-solacebroker-queue-endpoint.git +git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-queue-endpoint.git cd examples/queue-with-topic-subscriptions ``` -### Adjust Provider Configuration +### Adjust the Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. -### Create the resource +### Create the Resource -Hint: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm) +Tip: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm). Execute from this folder: @@ -63,9 +63,9 @@ terraform plan terraform apply ``` -Run `terraform destroy` to clean up created resources when no longer needed. +Run `terraform destroy` to clean up the created resources when they are no longer needed. ## Additional Documentation -Refer to the [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation. +For more information, see [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation. diff --git a/examples/topic-endpoint-template/README.md b/examples/topic-endpoint-template/README.md index 9ef0d17..2ea14fc 100644 --- a/examples/topic-endpoint-template/README.md +++ b/examples/topic-endpoint-template/README.md @@ -2,55 +2,55 @@ Configuration in this directory creates a [topic endpoint template](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Endpoint-Templates.htm) on the PubSub+ event broker leveraging the Queues & Endpoints Terraform module. -Important: The topic subscription that a topic endpoint will spool messages for is not specified when a topic endpoint template is provisioned. For additional details refer to the [PubSub+ documentation](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-DTEs.htm). +Important: The topic subscription that a topic endpoint will spool messages for is not specified when a topic endpoint template is provisioned. For more information, see the [PubSub+ documentation](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-DTEs.htm). ## Module Configuration in the Example ### Mandatory Inputs -* `msg_vpn_name` - set to `default` in the example -* `endpoint_type` - set to `topic_endpoint` -* `endpoint_name` - set to `testTT` in the example -* `permission` - set to `consume` in the example to enable the receiver app to remove consumed messages from the topic endpoint, that has been created from the template +* `msg_vpn_name` - Set to `default` in the example. +* `endpoint_type` - Set to `topic_endpoint` in the example. +* `endpoint_name` - Set to `testTT` in the example. +* `permission` - Set to `consume` in the example to enable the receiver app to remove consumed messages from the topic endpoint, that has been created from the template. ### Optional Inputs This example specifies an optional attribute `respect_ttl_enabled` of the topic endpoint template for demo purposes. -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_topic_endpoint_template"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint_template#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted, then the default for the related resource attribute will be configured on the broker. For a list of attributes and the corresponding defaults, see the [documentation of "solacebroker_msg_vpn_topic_endpoint_template"](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint_template#optional). ### Output The module `provisioned_topic endpoint_template` output refers to the created topic endpoint template. -## Created resources +## Created Resources -This example will create following resources: +This example will create the following resources: * `solacebroker_msg_vpn_topic endpoint_template` ## Running the Example -### Access to a PubSub+ broker +### Access to a PubSub+ Event Broker -If you don't already have access to a broker, refer to the [Developers page](https://www.solace.dev/) for options to get started. +If you don't already have access to a broker, see the [Developers page](https://www.solace.dev/) for options to get started. -### Sample source code +### Sample Source Code The sample is available from the module GitHub repo: ```bash -git clone https://github.com/SolaceProducts/terraform-solacebroker-queue-endpoint.git +git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-queue-endpoint.git cd examples/topic-endpoint-template ``` -### Adjust Provider Configuration +### Adjust the Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. -### Create the resource +### Create the Resource -Hint: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm) +Tip: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm). Execute from this folder: @@ -60,9 +60,9 @@ terraform plan terraform apply ``` -Run `terraform destroy` to clean up created resources when no longer needed. +Run `terraform destroy` to clean up the created resources when they are no longer needed. ## Additional Documentation -Refer to the [Configuring Topic Endpoints](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-DTEs.htm) section in the PubSub+ documentation. +For more information, see [Configuring Topic Endpoints](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-DTEs.htm) section in the PubSub+ documentation. diff --git a/examples/topic-endpoint-with-jndi/README.md b/examples/topic-endpoint-with-jndi/README.md index df7b233..49a19e3 100644 --- a/examples/topic-endpoint-with-jndi/README.md +++ b/examples/topic-endpoint-with-jndi/README.md @@ -2,22 +2,22 @@ Configuration in this directory creates a [topic endpoint that is also exposed as a JNDI administered object](https://docs.solace.com/API/Solace-JMS-API/Managing-Solace-JNDI-Objects.htm) on the PubSub+ event broker leveraging the Queues & Endpoints Terraform module. -Note that exposing topics as JNDI objects also requires JNDI enabled at the Message VPN level and the configuration of a Connection Factory. The [Service Module](TODO:add link) and the [JNDI Connection Factory Module](TODO:add link) may be used to configure that. This module will not check if they are in place but configuration will fail. +Note that exposing topics as JNDI objects requires that you enable JNDI at the Message VPN level and configure a connection factory. You can use the [Service Module](https://registry.terraform.io/modules/SolaceProducts/service/solacebrokerappliance/latest) and the [JNDI Connection Factory Module](https://registry.terraform.io/modules/SolaceProducts/jndi/solacebrokerappliance/latest) to perform these tasks. This module will not check if the requirements are in place, however, if they aren't the configuration will fail. ## Module Configuration in the Example ### Mandatory Inputs -* `msg_vpn_name` - set to `default` in the example -* `endpoint_type` - set to `topic_endpoint` -* `endpoint_name` - set to `testJT` in the example -* `permission` - set to `consume` in the example to enable the receiver app to remove consumed messages from the topic endpoint +* `msg_vpn_name` - Set to `default` in the example. +* `endpoint_type` - Set to `topic_endpoint` in the example. +* `endpoint_name` - Set to `testJT` in the example. +* `permission` - Set to `consume` in the example to enable the receiver app to remove consumed messages from the topic endpoint. ### Optional Inputs * `jndi_topic_name`: if provided then the topic endpoint will be exposed to JNDI under this name -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_topic_endpoint"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted, then the default for the related resource attribute will be configured on the broker. For a list of attributes and the corresponding defaults, see the [documentation of "solacebroker_msg_vpn_topic_endpoint"](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint#optional). ### Output @@ -25,35 +25,35 @@ The module `provisioned_topic endpoint` output refers to the created topic endpo The module `provisioned_jndi_topic endpoint` output refers to the created JNDI topic resource. -## Created resources +## Created Resources -This example will create following resources: +This example will create the following resources: * `solacebroker_msg_vpn_topic endpoint` * `solacebroker_msg_vpn_jndi_topic endpoint` if `jndi_topic_name` has been provided ## Running the Example -### Access to a PubSub+ broker +### Access to a PubSub+ Event Broker -If you don't already have access to a broker, refer to the [Developers page](https://www.solace.dev/) for options to get started. +If you don't already have access to a broker, see the [Developers page](https://www.solace.dev/) for options to get started. -### Sample source code +### Sample Source Code The sample is available from the module GitHub repo: ```bash -git clone https://github.com/SolaceProducts/terraform-solacebroker-queue-endpoint.git +git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-queue-endpoint.git cd examples/topic-endpoint-with-jndi ``` -### Adjust Provider Configuration +### Adjust the Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. -### Create the resource +### Create the Resource -Hint: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm) +Tip: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm). Execute from this folder: @@ -63,9 +63,9 @@ terraform plan terraform apply ``` -Run `terraform destroy` to clean up created resources when no longer needed. +Run `terraform destroy` to clean up the created resources when they are no longer needed. ## Additional Documentation -Refer to the [Configuring Topic Endpoints](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-DTEs.htm) section in the PubSub+ documentation. +For more information, see [Configuring Topic Endpoints](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-DTEs.htm) section in the PubSub+ documentation. diff --git a/examples/topic-endpoint/README.md b/examples/topic-endpoint/README.md index 210e9c6..4afa3d8 100644 --- a/examples/topic-endpoint/README.md +++ b/examples/topic-endpoint/README.md @@ -2,55 +2,55 @@ Configuration in this directory creates a [topic endpoint](https://docs.solace.com/Get-Started/topic-endpoints-queues.htm) on the PubSub+ event broker leveraging the Queues & Endpoints Terraform module. -Important: The topic subscription that a topic endpoint will spool messages for is not specified when a topic endpoint is provisioned. For additional details refer to the [PubSub+ documentation](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-DTEs.htm). +Important: The topic subscription that a topic endpoint will spool messages for is not specified when a topic endpoint is provisioned. For more information, see the [PubSub+ documentation](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-DTEs.htm). ## Module Configuration in the Example ### Mandatory Inputs -* `msg_vpn_name` - set to `default` in the example -* `endpoint_type` - set to `topic_endpoint` -* `endpoint_name` - set to `testTE` in the example -* `permission` - set to `consume` in the example to enable the receiver app to remove consumed messages from the topic endpoint +* `msg_vpn_name` - Set to `default` in the example. +* `endpoint_type` - Set to `topic_endpoint` in the example. +* `endpoint_name` - Set to `testTE` in the example. +* `permission` - Set to `consume` in the example to enable the receiver app to remove consumed messages from the topic endpoint. ### Optional Inputs Note that the `access_type` module input variable defines if a topic endpoint is "exclusive" or "non-exclusive". The default is "exclusive". -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_topic_endpoint"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted, then the default for the related resource attribute will be configured on the broker. For a list of attributes and the corresponding defaults, see the [documentation of "solacebroker_msg_vpn_topic_endpoint"](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint#optional). ### Output The module `provisioned_topic endpoint` output refers to the created topic endpoint. -## Created resources +## Created Resources -This example will create following resources: +This example will create the following resources: * `solacebroker_msg_vpn_topic endpoint` ## Running the Example -### Access to a PubSub+ broker +### Access to a PubSub+ Event Broker -If you don't already have access to a broker, refer to the [Developers page](https://www.solace.dev/) for options to get started. +If you don't already have access to a broker, see the [Developers page](https://www.solace.dev/) for options to get started. -### Sample source code +### Sample Source Code The sample is available from the module GitHub repo: ```bash -git clone https://github.com/SolaceProducts/terraform-solacebroker-queue-endpoint.git +git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-queue-endpoint.git cd examples/topic-endpoint ``` -### Adjust Provider Configuration +### Adjust the Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. -### Create the resource +### Create the Resource -Hint: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm) +Tip: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm). Execute from this folder: @@ -60,9 +60,9 @@ terraform plan terraform apply ``` -Run `terraform destroy` to clean up created resources when no longer needed. +Run `terraform destroy` to clean up the created resources when they are no longer needed. ## Additional Documentation -Refer to the [Configuring Topic Endpoints](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-DTEs.htm) section in the PubSub+ documentation. +For more information, see [Configuring Topic Endpoints](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-DTEs.htm) section in the PubSub+ documentation.