Skip to content

Commit

Permalink
Documentation fixes (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
bczoma authored Apr 4, 2024
1 parent 80c53df commit b446bc5
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 12 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@ Use case details are provided in the [Examples](#examples).

### Required

* `msg_vpn_name` - thename of the new message VPN to be created
* `msg_vpn_name` - the name of the new message VPN to be created

### Optional

* `acl_profile_name` - the name of the optionally added ACL profile. A `default` profile is always created and if left at default empty then no additional ACL profile will be created.
* `client_profile_name` - the name of the optionally added client profile. A `default` profile is always created and if left at default empty then no additional ACL profile will be created.
* `oauth_profile_name` - the name of an optionally added OAuth profile. Note that there will be no OAUth profile created unless a non-empty name is provided.
* `oauth_profile_name` - the name of an optionally added OAuth profile. Note that there will be no OAuth profile created unless a non-empty name is provided.
* `oauth_profile_client_required_claims` - a set of optional client-required claims.
* `oauth_profile_resource_server_required_claims` - a set of optional server-required claims.
* `cert_matching_rule_name` - the name of an optionally added certificate matching rule. Note that there will be no certificate matching rule created unless a non-empty name is provided.
* `cert_matching_rule_conditions` - a set of optional certificate matching rule conditions.
* `cert_matching_rule_attribute_filters` - a set of optional certificate matching rule attribute filters.

Additional optional module variables names are the same as the underlying resource attributes. The recommended approach to determine variable name mappings is to look up the resource's documentation for matching attribute names:
Additional optional module variable names are the same as the underlying resource attributes. The recommended approach to determine variable name mappings is to look up the resource's documentation for matching attribute names:

| Resource name |
|---------------|
Expand All @@ -46,8 +46,6 @@ Exceptions: the following optional variables' default value differ from the reso
| `jndi_enabled` | `true` |
| `max_msg_spool_usage` | 1500 | MB, message VPN |

-> The module default for the optional variable is `true`, which

## Module outputs

[Module outputs](https://developer.hashicorp.com/terraform/language/values/outputs) provide reference to created resources. Any reference to a resource that has not been created will be set to `(null)`.
Expand Down
2 changes: 1 addition & 1 deletion examples/basic-vpn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ If you don't already have access to a broker, refer to the [Developers page](htt
The sample is available from the module GitHub repo:

```bash
git clone https://github.com/SolaceProducts/terraform-solacebroker-rest-delivery.git
git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-service.git
cd examples/basic-vpn
```

Expand Down
2 changes: 1 addition & 1 deletion examples/client-certificate-authentication/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ If you don't already have access to a broker, refer to the [Developers page](htt
The sample is available from the module GitHub repo:

```bash
git clone https://github.com/SolaceProducts/terraform-solacebroker-rest-delivery.git
git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-service.git
cd examples/client-certificate-authentication
```

Expand Down
2 changes: 1 addition & 1 deletion examples/customized-acl-and-client-profiles/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ If you don't already have access to a broker, refer to the [Developers page](htt
The sample is available from the module GitHub repo:

```bash
git clone https://github.com/SolaceProducts/terraform-solacebroker-rest-delivery.git
git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-service.git
cd examples/customized-acl-and-client-profiles
```

Expand Down
2 changes: 1 addition & 1 deletion examples/oauth-authentication/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ If you don't already have access to a broker, refer to the [Developers page](htt
The sample is available from the module GitHub repo:

```bash
git clone https://github.com/SolaceProducts/terraform-solacebroker-rest-delivery.git
git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-service.git
cd examples/oauth-authentication
```

Expand Down
2 changes: 1 addition & 1 deletion examples/services-and-listen-ports/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ If you don't already have access to a broker, refer to the [Developers page](htt
The sample is available from the module GitHub repo:

```bash
git clone https://github.com/SolaceProducts/terraform-solacebroker-rest-delivery.git
git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-service.git
cd examples/services-and-listen-ports
```

Expand Down
2 changes: 1 addition & 1 deletion internal/gen-template/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ variable "client_profile_name" {
}

variable "oauth_profile_name" {
description = "The name of the OAuth Profile to be created and added to the Message VPN. If not specified, no OAuth Profile will be added. If specified, OAUth will be enabled on the VPN and this profile will be set as the default profile. Default is \"\""
description = "The name of the OAuth Profile to be created and added to the Message VPN. If not specified, no OAuth Profile will be added. If specified, OAuth will be enabled on the VPN and this profile will be set as the default profile. Default is \"\""
type = string
default = ""
}
Expand Down
2 changes: 1 addition & 1 deletion variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ variable "client_profile_name" {
}

variable "oauth_profile_name" {
description = "The name of the OAuth Profile to be created and added to the Message VPN. If not specified, no OAuth Profile will be added. If specified, OAUth will be enabled on the VPN and this profile will be set as the default profile. Default is \"\""
description = "The name of the OAuth Profile to be created and added to the Message VPN. If not specified, no OAuth Profile will be added. If specified, OAuth will be enabled on the VPN and this profile will be set as the default profile. Default is \"\""
type = string
default = ""
}
Expand Down

0 comments on commit b446bc5

Please sign in to comment.