Skip to content

Commit

Permalink
Updated non-exclusive queue example docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bczoma committed Feb 8, 2024
1 parent 6367c0c commit acdfa29
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 6 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ Optional module variables are either shared by multiple types, or conditional to

Most optional variables' default value is null. If they are not provided then the default for the related resource attribute will be configured on the broker.

-> The module defaults for `ingress_enabled` and `egress_enabled` are `true`, which differ from the resource attribute defaults.

-> Important: Queues or topic endpoints must have proper `owner` or `permission` for non-owners configured to enable clients to connect and consume messages. The default values restrict all access. For additional details, refer to the [Solace documentation](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queue_Owners)

## Examples

Refer to the following configuration examples:
Expand All @@ -44,7 +48,7 @@ Refer to the following configuration examples:

## Module use recommendations

This module is expected to be used primarily by application teams, it provides for provisioning endpoints required by the specific applications. It may be forked and updated with private defaults.
This module is expected to be used primarily by application teams. It provides support to provision endpoints required by a specific application. It may be forked and adjusted with private defaults.

## Resources

Expand Down
43 changes: 39 additions & 4 deletions examples/non-exclusive-queue/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,52 @@
# Non-exclusive queue example
# Non-exclusive Queue Example

Configuration in [this directory] creates a non-exclusive queue on the PubSub+ event broker leveraging the Queue Endpoint Terraform module.
Configuration in this directory creates a [non-exclusive queue](https://docs.solace.com/Get-Started/message-exchange-patterns.htm#Point-to) on the PubSub+ event broker leveraging the Queue Endpoint Terraform module.

## Mandatory inputs
## Module Use in the Example

### 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 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).

### Output

The module `queue` output refers to the created queue.

## Running the Example

### Access to a PubSub+ broker

If you don't already have access to a broker, refer to the [Developers page](https://www.solace.dev/) to get started.

### PubSub+ Broker Manager

You can verify configuration changes using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm)

### Adjust Provider Configuration

Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/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

Execute from this folder:

```bash
$ terraform init
$ terraform plan
$ terraform apply
```

Run `terraform destroy` to clean up created resources.

## Additional Documentation

Refer to the [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the Solace documentation.

1 change: 0 additions & 1 deletion examples/non-exclusive-queue/providers.tf
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,4 @@ terraform {
source = "registry.terraform.io/solaceproducts/solacebroker"
}
}
required_version = "~> 1.2"
}

0 comments on commit acdfa29

Please sign in to comment.