Skip to content

Commit 3d2048c

Browse files
Baptiste Rouxbaprx
Baptiste Roux
authored and
baprx
committed
chore: run generate_docs
1 parent df30867 commit 3d2048c

File tree

3 files changed

+143
-105
lines changed

3 files changed

+143
-105
lines changed

‎README.md‎

Lines changed: 49 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -90,46 +90,60 @@ module "gce-lb-http" {
9090

9191

9292
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
93-
9493
## Inputs
9594

96-
| Name | Description | Type | Default | Required |
97-
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | :----------: | :-------: | :------: |
98-
| address | IPv4 address (actual IP address value) | string | `"null"` | no |
99-
| ipv6_address | IPv6 address (actual IP address value) | string | `"null"` | no |
100-
| backends | Map backend indices to list of backend maps. | object | n/a | yes |
101-
| cdn | Set to `true` to enable cdn on backend. | bool | `"false"` | no |
102-
| certificate | Content of the SSL certificate. Required if `ssl` is `true` and `ssl_certificates` is empty. | string | `"null"` | no |
103-
| certificate\_map | Certificate Map ID in format projects/{project}/locations/global/certificateMaps/. Identifies a certificate map associated with the given target proxy | `string` | `null` | no |
104-
| create_address | Create a new global IPv4 address | bool | `"true"` | no |
105-
| create_ipv6_address | Create a new global IPv6 address | bool | `"true"` | no |
106-
| create_url_map | Set to `false` if url_map variable is provided. | bool | `"true"` | no |
107-
| firewall_networks | Names of the networks to create firewall rules in | list(string) | `<list>` | no |
108-
| firewall_projects | Names of the projects to create firewall rules in | list(string) | `<list>` | no |
109-
| http_forward | Set to `false` to disable HTTP port 80 forward | bool | `"true"` | no |
110-
| https_redirect | Set to `true` to enable https redirect on the lb. | bool | `"false"` | no |
111-
| name | Name for the forwarding rule and prefix for supporting resources | string | n/a | yes |
112-
| private_key | Content of the private SSL key. Required if `ssl` is `true` and `ssl_certificates` is empty. | string | `"null"` | no |
113-
| project | The project to deploy to, if not set the default provider project is used. | string | n/a | yes |
114-
| quic | Set to `true` to enable QUIC support | bool | `"false"` | no |
115-
| security_policy | The resource URL for the security policy to associate with the backend service | string | `"null"` | no |
116-
| ssl | Set to `true` to enable SSL support, requires variable `ssl_certificates` - a list of self_link certs | bool | `"false"` | no |
117-
| ssl_certificates | SSL cert self_link list. Required if `ssl` is `true` and no `private_key` and `certificate` is provided. | list(string) | `<list>` | no |
118-
| ssl_policy | Selfink to SSL Policy | string | `"null"` | no |
119-
| target_service_accounts | List of target service accounts for health check firewall rule. Exactly one of target_tags or target_service_accounts should be specified. | list(string) | `<list>` | no |
120-
| target_tags | List of target tags for health check firewall rule. Exactly one of target_tags or target_service_accounts should be specified. | list(string) | `<list>` | no |
121-
| url_map | The url_map resource to use. Default is to send all traffic to first backend. | string | `"null"` | no |
122-
| use_ssl_certificates | If true, use the certificates provided by `ssl_certificates`, otherwise, create cert from `private_key` and `certificate` | bool | `"false"` | no |
95+
| Name | Description | Type | Default | Required |
96+
|------|-------------|------|---------|:--------:|
97+
| address | Existing IPv4 address to use (the actual IP address value) | `string` | `null` | no |
98+
| backends | Map backend indices to list of backend maps. | <pre>map(object({<br> port = optional(number)<br> project = optional(string)<br> protocol = optional(string)<br> port_name = optional(string)<br> description = optional(string)<br> enable_cdn = optional(bool)<br> compression_mode = optional(string)<br> security_policy = optional(string, null)<br> edge_security_policy = optional(string, null)<br> custom_request_headers = optional(list(string))<br> custom_response_headers = optional(list(string))<br><br> timeout_sec = optional(number)<br> connection_draining_timeout_sec = optional(number)<br> session_affinity = optional(string)<br> affinity_cookie_ttl_sec = optional(number)<br> locality_lb_policy = optional(string)<br><br> health_check = optional(object({<br> host = optional(string)<br> request_path = optional(string)<br> request = optional(string)<br> response = optional(string)<br> port = optional(number)<br> port_name = optional(string)<br> proxy_header = optional(string)<br> port_specification = optional(string)<br> protocol = optional(string)<br> check_interval_sec = optional(number)<br> timeout_sec = optional(number)<br> healthy_threshold = optional(number)<br> unhealthy_threshold = optional(number)<br> logging = optional(bool)<br> }))<br><br> log_config = object({<br> enable = optional(bool)<br> sample_rate = optional(number)<br> })<br><br> groups = list(object({<br> group = string<br> description = optional(string)<br><br> balancing_mode = optional(string)<br> capacity_scaler = optional(number)<br> max_connections = optional(number)<br> max_connections_per_instance = optional(number)<br> max_connections_per_endpoint = optional(number)<br> max_rate = optional(number)<br> max_rate_per_instance = optional(number)<br> max_rate_per_endpoint = optional(number)<br> max_utilization = optional(number)<br> }))<br> iap_config = optional(object({<br> enable = bool<br> oauth2_client_id = optional(string)<br> oauth2_client_secret = optional(string)<br> }))<br> cdn_policy = optional(object({<br> cache_mode = optional(string)<br> signed_url_cache_max_age_sec = optional(string)<br> default_ttl = optional(number)<br> max_ttl = optional(number)<br> client_ttl = optional(number)<br> negative_caching = optional(bool)<br> negative_caching_policy = optional(object({<br> code = optional(number)<br> ttl = optional(number)<br> }))<br> serve_while_stale = optional(number)<br> cache_key_policy = optional(object({<br> include_host = optional(bool)<br> include_protocol = optional(bool)<br> include_query_string = optional(bool)<br> query_string_blacklist = optional(list(string))<br> query_string_whitelist = optional(list(string))<br> include_http_headers = optional(list(string))<br> include_named_cookies = optional(list(string))<br> }))<br> bypass_cache_on_request_headers = optional(list(string))<br> }))<br> outlier_detection = optional(object({<br> base_ejection_time = optional(object({<br> seconds = number<br> nanos = optional(number)<br> }))<br> consecutive_errors = optional(number)<br> consecutive_gateway_failure = optional(number)<br> enforcing_consecutive_errors = optional(number)<br> enforcing_consecutive_gateway_failure = optional(number)<br> enforcing_success_rate = optional(number)<br> interval = optional(object({<br> seconds = number<br> nanos = optional(number)<br> }))<br> max_ejection_percent = optional(number)<br> success_rate_minimum_hosts = optional(number)<br> success_rate_request_volume = optional(number)<br> success_rate_stdev_factor = optional(number)<br> }))<br> }))</pre> | n/a | yes |
99+
| certificate | Content of the SSL certificate. Requires `ssl` to be set to `true` and `create_ssl_certificate` set to `true` | `string` | `null` | no |
100+
| certificate\_map | Certificate Map ID in format projects/{project}/locations/global/certificateMaps/{name}. Identifies a certificate map associated with the given target proxy. Requires `ssl` to be set to `true` | `string` | `null` | no |
101+
| create\_address | Create a new global IPv4 address | `bool` | `true` | no |
102+
| create\_ipv6\_address | Allocate a new IPv6 address. Conflicts with "ipv6\_address" - if both specified, "create\_ipv6\_address" takes precedence. | `bool` | `false` | no |
103+
| create\_ssl\_certificate | If `true`, Create certificate using `private_key/certificate` | `bool` | `false` | no |
104+
| create\_url\_map | Set to `false` if url\_map variable is provided. | `bool` | `true` | no |
105+
| edge\_security\_policy | The resource URL for the edge security policy to associate with the backend service | `string` | `null` | no |
106+
| enable\_ipv6 | Enable IPv6 address on the CDN load-balancer | `bool` | `false` | no |
107+
| firewall\_networks | Names of the networks to create firewall rules in | `list(string)` | <pre>[<br> "default"<br>]</pre> | no |
108+
| firewall\_projects | Names of the projects to create firewall rules in | `list(string)` | <pre>[<br> "default"<br>]</pre> | no |
109+
| http\_forward | Set to `false` to disable HTTP port 80 forward | `bool` | `true` | no |
110+
| http\_keep\_alive\_timeout\_sec | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). | `number` | `null` | no |
111+
| http\_port | The port for the HTTP load balancer | `number` | `80` | no |
112+
| https\_port | The port for the HTTPS load balancer | `number` | `443` | no |
113+
| https\_redirect | Set to `true` to enable https redirect on the lb. | `bool` | `false` | no |
114+
| ipv6\_address | An existing IPv6 address to use (the actual IP address value) | `string` | `null` | no |
115+
| labels | The labels to attach to resources created by this module | `map(string)` | `{}` | no |
116+
| load\_balancing\_scheme | Load balancing scheme type (EXTERNAL for classic external load balancer, EXTERNAL\_MANAGED for Envoy-based load balancer, and INTERNAL\_SELF\_MANAGED for traffic director) | `string` | `"EXTERNAL"` | no |
117+
| managed\_ssl\_certificate\_domains | Create Google-managed SSL certificates for specified domains. Requires `ssl` to be set to `true` | `list(string)` | `[]` | no |
118+
| name | Name for the forwarding rule and prefix for supporting resources | `string` | n/a | yes |
119+
| name\_prefixes | Map of resource name prefixes allowing name customization. `null` values fallback to module defaults. | <pre>object({<br> address = optional(string, null)<br> address_ipv6 = optional(string, null)<br> certificate = optional(string, null)<br> http_forwarding_rule = optional(string, null)<br> http_ipv6_forwarding_rule = optional(string, null)<br> https_forwarding_rule = optional(string, null)<br> https_ipv6_forwarding_rule = optional(string, null)<br> target_http_proxy = optional(string, null)<br> target_https_proxy = optional(string, null)<br> url_map = optional(string, null)<br> url_map_https_redirect = optional(string, null)<br> backend_service = optional(string, null)<br> health_check = optional(string, null)<br> })</pre> | `{}` | no |
120+
| name\_suffixes | Map of suffixes to the created resource names. | <pre>object({<br> address = optional(string, "-address")<br> address_ipv6 = optional(string, "-ipv6-address")<br> certificate = optional(string, "-cert")<br> http_forwarding_rule = optional(string, "")<br> http_ipv6_forwarding_rule = optional(string, "-ipv6-http")<br> https_forwarding_rule = optional(string, "-https")<br> https_ipv6_forwarding_rule = optional(string, "-ipv6-https")<br> target_http_proxy = optional(string, "-http-proxy")<br> target_https_proxy = optional(string, "-https-proxy")<br> url_map = optional(string, "-url-map")<br> url_map_https_redirect = optional(string, "-https-redirect")<br> backend_service = optional(string, "")<br> health_check = optional(string, "")<br> })</pre> | `{}` | no |
121+
| network | Network for INTERNAL\_SELF\_MANAGED load balancing scheme | `string` | `"default"` | no |
122+
| 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 |
123+
| project | The project to deploy to, if not set the default provider project is used. | `string` | n/a | yes |
124+
| 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 |
125+
| random\_certificate\_suffix | Bool to enable/disable random certificate name generation. Set and keep this to true if you need to change the SSL cert. | `bool` | `false` | no |
126+
| security\_policy | The resource URL for the security policy to associate with the backend service | `string` | `null` | no |
127+
| server\_tls\_policy | The resource URL for the server TLS policy to associate with the https proxy service | `string` | `null` | no |
128+
| ssl | Set to `true` to enable SSL support. If `true` then at least one of these are required: 1) `ssl_certificates` OR 2) `create_ssl_certificate` set to `true` and `private_key/certificate` OR 3) `managed_ssl_certificate_domains`, OR 4) `certificate_map` | `bool` | `false` | no |
129+
| ssl\_certificates | SSL cert self\_link list. Requires `ssl` to be set to `true` | `list(string)` | `[]` | no |
130+
| ssl\_policy | Selfink to SSL Policy | `string` | `null` | no |
131+
| target\_service\_accounts | List of target service accounts for health check firewall rule. Exactly one of target\_tags or target\_service\_accounts should be specified. | `list(string)` | `[]` | no |
132+
| target\_tags | List of target tags for health check firewall rule. Exactly one of target\_tags or target\_service\_accounts should be specified. | `list(string)` | `[]` | no |
133+
| url\_map | The url\_map resource to use. Default is to send all traffic to first backend. | `string` | `null` | no |
123134

124135
## Outputs
125136

126-
| Name | Description |
127-
| --------------------- | ---------------------------------------------------------------- |
128-
| backend_services | The backend service resources. |
129-
| external_ip | The external IPv4 address assigned to the global fowarding rule. |
130-
| external_ipv6_address | The external IPv6 address assigned to the global fowarding rule. |
131-
| http_proxy | The HTTP proxy used by this module. |
132-
| https_proxy | The HTTPS proxyused by this module. |
137+
| Name | Description |
138+
|------|-------------|
139+
| backend\_services | The backend service resources. |
140+
| external\_ip | The external IPv4 assigned to the global fowarding rule. |
141+
| external\_ipv6\_address | The external IPv6 assigned to the global fowarding rule. |
142+
| http\_proxy | The HTTP proxy used by this module. |
143+
| https\_proxy | The HTTPS proxy used by this module. |
144+
| ipv6\_enabled | Whether IPv6 configuration is enabled on this load-balancer |
145+
| ssl\_certificate\_created | The SSL certificate create from key/pem |
146+
| url\_map | The default URL map used by this module. |
133147

134148
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
135149

0 commit comments

Comments
 (0)