queue-with-jndi

Queue with JNDI Example

Configuration in this directory creates a queue that is also exposed as a JNDI administered object on the PubSub+ appliance leveraging the Queues & Endpoints Terraform module.

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 and the JNDI Connection Factory Module 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 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 a list of attributes and the corresponding defaults, see the documentation of "solacebroker_msg_vpn_queue".

Output

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

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+ Appliance

If you don't already have access to a broker, see the Developers page for options to get started.

Sample Source Code

The sample is available from the module GitHub repo:

git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-queue-endpoint.git
cd examples/queue-with-jndi

Adjust the Provider Configuration

Adjust the provider parameters in main.tf according to your broker. The example configuration shows settings for a local broker running in Docker.

Create the Resource

Tip: You can verify configuration changes on the broker, before and after, using the PubSub+ Broker Manager Web UI.

Execute from this folder:

terraform init
terraform plan
terraform apply

Run terraform destroy to clean up the created resources when they are no longer needed.

Additional Documentation

For more information, see Configuring Queues section in the PubSub+ documentation.