Skip to content

Commit 973e17e

Browse files
committed
chore: added generic variable description
1 parent 96495f4 commit 973e17e

File tree

7 files changed

+9
-11
lines changed

7 files changed

+9
-11
lines changed

modules/backend/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This module creates `google_compute_backend_service` resource and its dependenci
2121
| health\_check | Input for creating HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend. | <pre>object({<br> host = optional(string, null)<br> request_path = optional(string, null)<br> request = optional(string, null)<br> response = optional(string, null)<br> port = optional(number, null)<br> port_name = optional(string, null)<br> proxy_header = optional(string, null)<br> port_specification = optional(string, null)<br> protocol = optional(string, null)<br> check_interval_sec = optional(number, 5)<br> timeout_sec = optional(number, 5)<br> healthy_threshold = optional(number, 2)<br> unhealthy_threshold = optional(number, 2)<br> logging = optional(bool, false)<br> })</pre> | `null` | no |
2222
| host\_path\_mappings | The list of host/path for which traffic could be sent to the backend service | <pre>list(object({<br> host = string<br> path = string<br> }))</pre> | <pre>[<br> {<br> "host": "*",<br> "path": "/*"<br> }<br>]</pre> | no |
2323
| iap\_config | Settings for enabling Cloud Identity Aware Proxy Structure. | <pre>object({<br> enable = bool<br> oauth2_client_id = optional(string)<br> oauth2_client_secret = optional(string)<br> })</pre> | <pre>{<br> "enable": false<br>}</pre> | no |
24-
| load\_balancing\_scheme | Load balancing scheme type (EXTERNAL for classic external load balancer, EXTERNAL\_MANAGED for Envoy-based load balancer, and INTERNAL\_MANAGED for internal load balancer) | `string` | `"EXTERNAL_MANAGED"` | no |
24+
| load\_balancing\_scheme | Load balancing scheme type (EXTERNAL for classic external load balancer, EXTERNAL\_MANAGED for Envoy-based load balancer, INTERNAL\_MANAGED for internal load balancer and INTERNAL\_SELF\_MANAGED for traffic director) | `string` | `"EXTERNAL_MANAGED"` | no |
2525
| locality\_lb\_policy | The load balancing algorithm used within the scope of the locality. | `string` | `null` | no |
2626
| log\_config | This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. | <pre>object({<br> enable = bool<br> sample_rate = number<br> })</pre> | <pre>{<br> "enable": true,<br> "sample_rate": 1<br>}</pre> | no |
2727
| name | Name for the backend service. | `string` | n/a | yes |

modules/backend/metadata.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ spec:
7979
varType: string
8080
required: true
8181
- name: load_balancing_scheme
82-
description: Load balancing scheme type (EXTERNAL for classic external load balancer, EXTERNAL_MANAGED for Envoy-based load balancer, and INTERNAL_MANAGED for internal load balancer)
82+
description: Load balancing scheme type (EXTERNAL for classic external load balancer, EXTERNAL_MANAGED for Envoy-based load balancer, INTERNAL_MANAGED for internal load balancer and INTERNAL_SELF_MANAGED for traffic director)
8383
varType: string
8484
defaultValue: EXTERNAL_MANAGED
8585
- name: protocol

modules/backend/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ variable "project_id" {
2626
}
2727

2828
variable "load_balancing_scheme" {
29-
description = "Load balancing scheme type (EXTERNAL for classic external load balancer, EXTERNAL_MANAGED for Envoy-based load balancer, and INTERNAL_MANAGED for internal load balancer)"
29+
description = "Load balancing scheme type (EXTERNAL for classic external load balancer, EXTERNAL_MANAGED for Envoy-based load balancer, INTERNAL_MANAGED for internal load balancer and INTERNAL_SELF_MANAGED for traffic director)"
3030
type = string
3131
default = "EXTERNAL_MANAGED"
3232
}

modules/frontend/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ This module creates `HTTP(S) forwarding rule` and its dependencies. This modules
2222
| internal\_forwarding\_rules\_config | List of internal managed forwarding rules config. One of 'address' or 'subnetwork' is required for each. It is only applicable for internal load balancer | <pre>list(object({<br> region = string<br> address = optional(string)<br> subnetwork = optional(string)<br> }))</pre> | `[]` | no |
2323
| ipv6\_address | An existing IPv6 address to use (the actual IP address value) | `string` | `null` | no |
2424
| labels | The labels to attach to resources created by this module | `map(string)` | `{}` | no |
25-
| load\_balancing\_scheme | Load balancing scheme type (EXTERNAL for classic external load balancer, EXTERNAL\_MANAGED for Envoy-based load balancer, and INTERNAL\_MANAGED for internal load balancer) | `string` | `"EXTERNAL_MANAGED"` | no |
25+
| load\_balancing\_scheme | Load balancing scheme type (EXTERNAL for classic external load balancer, EXTERNAL\_MANAGED for Envoy-based load balancer, INTERNAL\_MANAGED for internal load balancer and INTERNAL\_SELF\_MANAGED for traffic director) | `string` | `"EXTERNAL_MANAGED"` | no |
2626
| managed\_ssl\_certificate\_domains | Create Google-managed SSL certificates for specified domains. Requires `ssl` to be set to `true` | `list(string)` | `[]` | no |
2727
| name | Name for the forwarding rule and prefix for supporting resources | `string` | n/a | yes |
28-
| network | Network for INTERNAL\_MANAGED load balancing scheme | `string` | `"default"` | no |
28+
| network | Network for internal load balancer | `string` | `"default"` | no |
2929
| private\_key | Content of the private SSL key. Requires `ssl` to be set to `true` and `create_ssl_certificate` set to `true` | `string` | `null` | no |
3030
| project\_id | The project to deploy to, if not set the default provider project is used. | `string` | n/a | yes |
3131
| quic | Specifies the QUIC override policy for this resource. Set true to enable HTTP/3 and Google QUIC support, false to disable both. Defaults to null which enables support for HTTP/3 only. | `bool` | `null` | no |

modules/frontend/metadata.display.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,6 @@ spec:
8181
value: EXTERNAL_MANAGED
8282
- label: INTERNAL_MANAGED
8383
value: INTERNAL_MANAGED
84-
- label: INTERNAL_SELF_MANAGED
85-
value: INTERNAL_SELF_MANAGED
8684
managed_ssl_certificate_domains:
8785
name: managed_ssl_certificate_domains
8886
title: Managed Ssl Certificate Domains

modules/frontend/metadata.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,11 +166,11 @@ spec:
166166
varType: map(string)
167167
defaultValue: {}
168168
- name: load_balancing_scheme
169-
description: Load balancing scheme type (EXTERNAL for classic external load balancer, EXTERNAL_MANAGED for Envoy-based load balancer, and INTERNAL_MANAGED for internal load balancer)
169+
description: Load balancing scheme type (EXTERNAL for classic external load balancer, EXTERNAL_MANAGED for Envoy-based load balancer, INTERNAL_MANAGED for internal load balancer and INTERNAL_SELF_MANAGED for traffic director)
170170
varType: string
171171
defaultValue: EXTERNAL_MANAGED
172172
- name: network
173-
description: Network for INTERNAL_MANAGED load balancing scheme
173+
description: Network for internal load balancer
174174
varType: string
175175
defaultValue: default
176176
- name: server_tls_policy

modules/frontend/variables.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,13 +156,13 @@ variable "labels" {
156156
}
157157

158158
variable "load_balancing_scheme" {
159-
description = "Load balancing scheme type (EXTERNAL for classic external load balancer, EXTERNAL_MANAGED for Envoy-based load balancer, and INTERNAL_MANAGED for internal load balancer)"
159+
description = "Load balancing scheme type (EXTERNAL for classic external load balancer, EXTERNAL_MANAGED for Envoy-based load balancer, INTERNAL_MANAGED for internal load balancer and INTERNAL_SELF_MANAGED for traffic director)"
160160
type = string
161161
default = "EXTERNAL_MANAGED"
162162
}
163163

164164
variable "network" {
165-
description = "Network for INTERNAL_MANAGED load balancing scheme"
165+
description = "Network for internal load balancer"
166166
type = string
167167
default = "default"
168168
}

0 commit comments

Comments
 (0)