diff --git a/.changelog/3068.txt b/.changelog/3068.txt new file mode 100644 index 000000000..b1f54dc22 --- /dev/null +++ b/.changelog/3068.txt @@ -0,0 +1,3 @@ +```release-note:REPLACEME + +``` diff --git a/plugins/modules/gcp_compute_region_backend_service.py b/plugins/modules/gcp_compute_region_backend_service.py index 49d58bb5c..24ac27e96 100644 --- a/plugins/modules/gcp_compute_region_backend_service.py +++ b/plugins/modules/gcp_compute_region_backend_service.py @@ -66,8 +66,9 @@ description: - A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). - - Default value is 1, which means the group will serve up to 100% of its configured - capacity (depending on balancingMode). + - "~>**NOTE**: This field cannot be set for INTERNAL region backend services + (default loadBalancingScheme), but is required for non-INTERNAL backend + service. The total capacity_scaler for all backends must be non-zero." - A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. required: false @@ -98,6 +99,7 @@ description: - The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. + - Cannot be set for INTERNAL backend services. - For CONNECTION mode, either maxConnections or one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set. required: false @@ -105,8 +107,9 @@ max_connections_per_instance: description: - The max number of simultaneous connections that a single backend instance - can handle. This is used to calculate the capacity of the group. Can be - used in either CONNECTION or UTILIZATION balancing modes. + can handle. Cannot be set for INTERNAL backend services. + - This is used to calculate the capacity of the group. + - Can be used in either CONNECTION or UTILIZATION balancing modes. - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. required: false @@ -114,15 +117,16 @@ max_connections_per_endpoint: description: - The max number of simultaneous connections that a single backend network - endpoint can handle. This is used to calculate the capacity of the group. - Can be used in either CONNECTION or UTILIZATION balancing modes. - - For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint - must be set. + endpoint can handle. Cannot be set for INTERNAL backend services. + - This is used to calculate the capacity of the group. Can be used in either + CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections + or maxConnectionsPerEndpoint must be set. required: false type: int max_rate: description: - - The max requests per second (RPS) of the group. + - The max requests per second (RPS) of the group. Cannot be set for INTERNAL + backend services. - Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. Either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set. @@ -133,7 +137,7 @@ - The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must - be set. + be set. Cannot be set for INTERNAL backend services. required: false type: str max_rate_per_endpoint: @@ -141,13 +145,14 @@ - The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint - must be set. + must be set. Cannot be set for INTERNAL backend services. required: false type: str max_utilization: description: - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0]. + - Cannot be set for INTERNAL backend services. required: false type: str connection_draining: @@ -320,8 +325,9 @@ description: - A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). - - Default value is 1, which means the group will serve up to 100% of its configured - capacity (depending on balancingMode). + - "~>**NOTE**: This field cannot be set for INTERNAL region backend services + (default loadBalancingScheme), but is required for non-INTERNAL backend service. + The total capacity_scaler for all backends must be non-zero." - A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. returned: success @@ -352,6 +358,7 @@ description: - The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. + - Cannot be set for INTERNAL backend services. - For CONNECTION mode, either maxConnections or one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set. returned: success @@ -359,8 +366,9 @@ maxConnectionsPerInstance: description: - The max number of simultaneous connections that a single backend instance - can handle. This is used to calculate the capacity of the group. Can be used - in either CONNECTION or UTILIZATION balancing modes. + can handle. Cannot be set for INTERNAL backend services. + - This is used to calculate the capacity of the group. + - Can be used in either CONNECTION or UTILIZATION balancing modes. - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. returned: success @@ -368,15 +376,16 @@ maxConnectionsPerEndpoint: description: - The max number of simultaneous connections that a single backend network endpoint - can handle. This is used to calculate the capacity of the group. Can be used - in either CONNECTION or UTILIZATION balancing modes. - - For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must - be set. + can handle. Cannot be set for INTERNAL backend services. + - This is used to calculate the capacity of the group. Can be used in either + CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections + or maxConnectionsPerEndpoint must be set. returned: success type: int maxRate: description: - - The max requests per second (RPS) of the group. + - The max requests per second (RPS) of the group. Cannot be set for INTERNAL + backend services. - Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. Either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set. @@ -387,7 +396,7 @@ - The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be - set. + set. Cannot be set for INTERNAL backend services. returned: success type: str maxRatePerEndpoint: @@ -395,13 +404,14 @@ - The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint - must be set. + must be set. Cannot be set for INTERNAL backend services. returned: success type: str maxUtilization: description: - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0]. + - Cannot be set for INTERNAL backend services. returned: success type: str connectionDraining: diff --git a/plugins/modules/gcp_compute_region_backend_service_info.py b/plugins/modules/gcp_compute_region_backend_service_info.py index 642c058c4..accf49b84 100644 --- a/plugins/modules/gcp_compute_region_backend_service_info.py +++ b/plugins/modules/gcp_compute_region_backend_service_info.py @@ -133,8 +133,9 @@ description: - A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). - - Default value is 1, which means the group will serve up to 100% of its - configured capacity (depending on balancingMode). + - "~>**NOTE**: This field cannot be set for INTERNAL region backend services + (default loadBalancingScheme), but is required for non-INTERNAL backend + service. The total capacity_scaler for all backends must be non-zero." - A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. returned: success @@ -167,6 +168,7 @@ description: - The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. + - Cannot be set for INTERNAL backend services. - For CONNECTION mode, either maxConnections or one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set. returned: success @@ -174,8 +176,9 @@ maxConnectionsPerInstance: description: - The max number of simultaneous connections that a single backend instance - can handle. This is used to calculate the capacity of the group. Can be - used in either CONNECTION or UTILIZATION balancing modes. + can handle. Cannot be set for INTERNAL backend services. + - This is used to calculate the capacity of the group. + - Can be used in either CONNECTION or UTILIZATION balancing modes. - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. returned: success @@ -183,15 +186,16 @@ maxConnectionsPerEndpoint: description: - The max number of simultaneous connections that a single backend network - endpoint can handle. This is used to calculate the capacity of the group. - Can be used in either CONNECTION or UTILIZATION balancing modes. - - For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint - must be set. + endpoint can handle. Cannot be set for INTERNAL backend services. + - This is used to calculate the capacity of the group. Can be used in either + CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either + maxConnections or maxConnectionsPerEndpoint must be set. returned: success type: int maxRate: description: - - The max requests per second (RPS) of the group. + - The max requests per second (RPS) of the group. Cannot be set for INTERNAL + backend services. - Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. Either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set. @@ -202,7 +206,7 @@ - The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must - be set. + be set. Cannot be set for INTERNAL backend services. returned: success type: str maxRatePerEndpoint: @@ -210,13 +214,14 @@ - The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint - must be set. + must be set. Cannot be set for INTERNAL backend services. returned: success type: str maxUtilization: description: - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0]. + - Cannot be set for INTERNAL backend services. returned: success type: str connectionDraining: