Clarifying documentation for google_compute_backend_service `locali…

…ty_lb_policy` (#11732) (#19513) [upstream:a6cb55b7424ecf27e53703dc3250b2e06404df35] Signed-off-by: Modular Magician <[email protected]>
hashicorp · Sep 17, 2024 · fc3652d · fc3652d
1 parent 4f99624
commit fc3652d
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/.changelog/11732.txt b/.changelog/11732.txt
@@ -0,0 +1,3 @@
+```release-note:none
+
+```
diff --git a/google/services/compute/resource_compute_backend_service.go b/google/services/compute/resource_compute_backend_service.go
@@ -803,7 +803,8 @@ The possible values are:
             Maglev, refer to https://ai.google/research/pubs/pub44824
 
 * 'WEIGHTED_MAGLEV': Per-instance weighted Load Balancing via health check
-                     reported weights. If set, the Backend Service must
+                     reported weights. Only applicable to loadBalancingScheme
+                     EXTERNAL. If set, the Backend Service must
                      configure a non legacy HTTP-based Health Check, and
                      health check replies are expected to contain
                      non-standard HTTP response header field
@@ -815,7 +816,7 @@ The possible values are:
                      UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains
                      equal-weight.
 
-This field is applicable to either:
+locality_lb_policy is applicable to either:
 
 * A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2,
   and loadBalancingScheme set to INTERNAL_MANAGED.
@@ -824,7 +825,7 @@ This field is applicable to either:
   Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
   Network Load Balancing. The default is MAGLEV.
 
-If session_affinity is not NONE, and this field is not set to MAGLEV, WEIGHTED_MAGLEV,
+If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
 or RING_HASH, session affinity settings will not take effect.
 
 Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced

diff --git a/website/docs/r/compute_backend_service.html.markdown b/website/docs/r/compute_backend_service.html.markdown
@@ -489,7 +489,8 @@ The following arguments are supported:
               build times and host selection times. For more information about
               Maglev, refer to https://ai.google/research/pubs/pub44824
   * `WEIGHTED_MAGLEV`: Per-instance weighted Load Balancing via health check
-                       reported weights. If set, the Backend Service must
+                       reported weights. Only applicable to loadBalancingScheme
+                       EXTERNAL. If set, the Backend Service must
                        configure a non legacy HTTP-based Health Check, and
                        health check replies are expected to contain
                        non-standard HTTP response header field
@@ -500,14 +501,14 @@ The following arguments are supported:
                        instance either reported a valid weight or had
                        UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains
                        equal-weight.
-  This field is applicable to either:
+  locality_lb_policy is applicable to either:
   * A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2,
     and loadBalancingScheme set to INTERNAL_MANAGED.
   * A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
   * A regional backend service with loadBalancingScheme set to EXTERNAL (External Network
     Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
     Network Load Balancing. The default is MAGLEV.
-  If session_affinity is not NONE, and this field is not set to MAGLEV, WEIGHTED_MAGLEV,
+  If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
   or RING_HASH, session affinity settings will not take effect.
   Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced
   by a URL map that is bound to target gRPC proxy that has validate_for_proxyless