[ELB] Make SSL passtrough documentation more verbose

Clarify `transparent_client_ip_enable` argument documentation
opentelekomcloud · Mar 21, 2022 · d900c46 · d900c46
1 parent bbf7b67
commit d900c46
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/docs/resources/lb_listener_v2.md b/docs/resources/lb_listener_v2.md
@@ -70,8 +70,11 @@ The following arguments are supported:
   suites. The option is effective only in conjunction with `TERMINATED_HTTPS`.
 
 * `transparent_client_ip_enable` - (Optional) Specifies whether to pass source IP addresses of the clients to
-  backend servers. The value can be true or false, and the default value is false for `TCP` and `UDP` listeners.
-  The value can only be true for `HTTP` and `HTTPS` listeners.
+  backend servers. The value is always `true` for `HTTP` and `HTTPS` listeners. For `TCP` and `UDP` listeners the
+  value can be `true` or `false` with `false` by default.
+
+->
+  If the load balancer is a Dedicated Load Balancer, `transparent_client_ip_enable` is always `true`
 
 * `admin_state_up` - (Optional) The administrative state of the Listener.
   A valid value is `true` (UP) or `false` (DOWN).

diff --git a/releasenotes/notes/elbv2-listener-doc-a8383f1c4666f6ac.yaml b/releasenotes/notes/elbv2-listener-doc-a8383f1c4666f6ac.yaml
@@ -0,0 +1,5 @@
+---
+other:
+  - |
+    **[ELB]** Clarify ``transparent_client_ip_enable`` argument description in documentation of
+    ``resource/opentelekomcloud_lb_listener_v2``