Skip to content

Commit

Permalink
Basic example adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
bczoma committed Mar 19, 2024
1 parent a536f8f commit 50f5569
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 9 deletions.
7 changes: 2 additions & 5 deletions examples/basic-vpn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Configuration in this directory creates a basic [message VPN](https://docs.solace.com/Features/VPN/Managing-Message-VPNs.htm) on the PubSub+ event broker, leveraging the Service Terraform module.

The created VPN will enable SMF and WebSocket messaging services with a message spool of 1500 MB assigned by default, however REST, AMQP and MQTT services need to be enabled and configured if required through optional input variables. The code will show an example how to enable and configure REST messaging. Use of JNDI and DMR will also be enabled by default.
The created VPN will enable SMF and WebSocket messaging services with a message spool of 1500 MB assigned by default, as well as use of JNDI and DMR will also be enabled. Refer to the example [Services and listen ports](examples/services-and-listen-ports) how to enable and configure other services including REST, MQTT and AMQP.

The VPN will include a `default` permissive ACL profile and a client profile, similar to the ones in the `default` message VPN.
These profiles will enable ready-to-go messaging on the VPN for development and demo purposes. For production use a customized ACL profile and a client profile should be specified as in [this example](examples/customized-client-and-acl-profiles).
Expand All @@ -21,9 +21,6 @@ The default authentication method will be set to basic authentication with inter

### Optional Inputs

* `service_rest_incoming_plain_text_enabled` - the example shows how to enable this protocol
* `service_rest_incoming_plain_text_listen_port` - the example shows how to configure this protocol

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_client_username"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_client_username#optional).

The module default for the `enabled` variable is true, which enables the message VPN and underlying resources.
Expand All @@ -38,7 +35,7 @@ This example will create following resources:

* `solacebroker_msg_vpn`

Note that `default` ACL profile, client profile and client username resources will also be automatically created an part of the new VPN but are only exposed by referencing their name.
Note that `default` ACL profile, client profile and client username resources will also be automatically created as part of the new VPN but are only exposed by referencing their name.

## Running the Example

Expand Down
4 changes: 0 additions & 4 deletions examples/basic-vpn/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ module "testvpn" {

msg_vpn_name = "myvpn"

// Enable and configure incoming messaging protocols, for example REST. Note that plain text is not recommended for production use.
service_rest_incoming_plain_text_enabled = true
service_rest_incoming_plain_text_listen_port = 9000

// No need to set the VPN enabled, it defaults to true
// enabled = true
}
Expand Down

0 comments on commit 50f5569

Please sign in to comment.