diff --git a/README.md b/README.md index 9f02254..935a330 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Solace PubSub+ Software Event Broker Queue Endpoint Terraform Module -Terraform module to configure a "guaranteed messaging endpoint" or an "endpoint template" on the PubSub+ event broker. Note: "queue endpoint" in the title also refers to all these types as a generic name. +Terraform module to configure a "guaranteed messaging endpoint" or an "endpoint template" on the [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/). Note: "queue endpoint" in the title also refers to all these types as a generic name. This module supports the configuration of one of the followings: diff --git a/examples/non-exclusive-queue/README.md b/examples/non-exclusive-queue/README.md new file mode 100644 index 0000000..a0319a0 --- /dev/null +++ b/examples/non-exclusive-queue/README.md @@ -0,0 +1,17 @@ +# Non-exclusive queue example + +Configuration in [this directory] creates a non-exclusive queue on the PubSub+ event broker leveraging the Queue Endpoint Terraform module. + +## Mandatory inputs + +* `msg_vpn_name` - set to `default` in the example +* `endpoint_type` - set to `queue` +* `endpoint_name` + +While an optional input, `access_type` is set to `non-exclusive` to configure a non-exclusive queue. + +## Optional Inputs + +Optional module input variables have the same name and defaults if omitted, as the attributes of the underlying provider resource. Refer to the [documentation of `solacebroker_msg_vpn_queue`](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_queue#optional). + + diff --git a/examples/non-exclusive-queue/main.tf b/examples/non-exclusive-queue/main.tf new file mode 100644 index 0000000..5ec4546 --- /dev/null +++ b/examples/non-exclusive-queue/main.tf @@ -0,0 +1,26 @@ +provider solacebroker { + username = "admin" + password = "admin" + url = "http://localhost:8080" +} + +module "non_exclusive_queue" { + source = "../.." + + msg_vpn_name = "default" + endpoint_type = "queue" + endpoint_name = "testQ" + access_type = "non-exclusive" + + # ingress and egress are enabled by default in the module + # ingress_enabled = true + # egress_enabled = true + + # other optional module variables example + permission = "consume" +} + +output "provisioned_queue" { + value = module.non_exclusive_queue.queue +} + diff --git a/examples/non-exclusive-queue/providers.tf b/examples/non-exclusive-queue/providers.tf new file mode 100644 index 0000000..d1de478 --- /dev/null +++ b/examples/non-exclusive-queue/providers.tf @@ -0,0 +1,10 @@ +# Terraform configuration + +terraform { + required_providers { + solacebroker = { + source = "registry.terraform.io/solaceproducts/solacebroker" + } + } + required_version = "~> 1.2" +}