From 2715684d9804eaf5a496a11384dece3129932d8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bal=C3=A1zs=20Czoma?= Date: Thu, 4 Apr 2024 08:37:04 -0400 Subject: [PATCH] Documentation fixes (#15) --- README.md | 8 +++----- examples/basic-vpn/README.md | 2 +- examples/client-certificate-authentication/README.md | 2 +- examples/customized-acl-and-client-profiles/README.md | 2 +- examples/oauth-authentication/README.md | 2 +- examples/services-and-listen-ports/README.md | 2 +- internal/gen-template/variables.tf | 2 +- variables.tf | 2 +- 8 files changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 9d0f66d..3cba273 100644 --- a/README.md +++ b/README.md @@ -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 | |---------------| @@ -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)`. diff --git a/examples/basic-vpn/README.md b/examples/basic-vpn/README.md index 855268e..a3557ba 100644 --- a/examples/basic-vpn/README.md +++ b/examples/basic-vpn/README.md @@ -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-solacebroker-service.git cd examples/basic-vpn ``` diff --git a/examples/client-certificate-authentication/README.md b/examples/client-certificate-authentication/README.md index f79b161..6577628 100644 --- a/examples/client-certificate-authentication/README.md +++ b/examples/client-certificate-authentication/README.md @@ -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-solacebroker-service.git cd examples/client-certificate-authentication ``` diff --git a/examples/customized-acl-and-client-profiles/README.md b/examples/customized-acl-and-client-profiles/README.md index d9eb1cb..50cbe3a 100644 --- a/examples/customized-acl-and-client-profiles/README.md +++ b/examples/customized-acl-and-client-profiles/README.md @@ -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-solacebroker-service.git cd examples/customized-acl-and-client-profiles ``` diff --git a/examples/oauth-authentication/README.md b/examples/oauth-authentication/README.md index 6efb7ce..122db0b 100644 --- a/examples/oauth-authentication/README.md +++ b/examples/oauth-authentication/README.md @@ -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-solacebroker-service.git cd examples/oauth-authentication ``` diff --git a/examples/services-and-listen-ports/README.md b/examples/services-and-listen-ports/README.md index 2143a51..645cba3 100644 --- a/examples/services-and-listen-ports/README.md +++ b/examples/services-and-listen-ports/README.md @@ -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-solacebroker-service.git cd examples/services-and-listen-ports ``` diff --git a/internal/gen-template/variables.tf b/internal/gen-template/variables.tf index 957647e..047526c 100644 --- a/internal/gen-template/variables.tf +++ b/internal/gen-template/variables.tf @@ -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 = "" } diff --git a/variables.tf b/variables.tf index d5b8696..3e3d075 100644 --- a/variables.tf +++ b/variables.tf @@ -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 = "" }