ComputeBackendService


Property Value
Google Cloud Service Name Compute Engine
Google Cloud Service Documentation /compute/docs/
Google Cloud REST Resource Name
v1.backendServices
v1.regionBackendServices
Google Cloud REST Resource Documentation
/compute/docs/reference/rest/v1/backendServices
/compute/docs/reference/rest/v1/regionBackendServices
Config Connector Resource Short Names gcpcomputebackendservice
gcpcomputebackendservices
computebackendservice
Config Connector Service Name compute.googleapis.com
Config Connector Resource Fully Qualified Name computebackendservices.compute.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No
Config Connector Default Average Reconcile Interval In Seconds 600

ComputeBackendService can manage both global and regional backend services. To manage a global ComputeBackendService use a value of global in the spec.location field. To manage a regional ComputeBackendService, use a region name in the spec.location field.

Custom Resource Definition Properties

Annotations

Fields
cnrm.cloud.google.com/project-id
cnrm.cloud.google.com/state-into-spec

Spec

Schema

affinityCookieTtlSec: integer
backend:
- balancingMode: string
  capacityScaler: float
  description: string
  failover: boolean
  group:
    instanceGroupRef:
      external: string
      name: string
      namespace: string
    networkEndpointGroupRef:
      external: string
      name: string
      namespace: string
  maxConnections: integer
  maxConnectionsPerEndpoint: integer
  maxConnectionsPerInstance: integer
  maxRate: integer
  maxRatePerEndpoint: float
  maxRatePerInstance: float
  maxUtilization: float
cdnPolicy:
  bypassCacheOnRequestHeaders:
  - headerName: string
  cacheKeyPolicy:
    includeHost: boolean
    includeHttpHeaders:
    - string
    includeNamedCookies:
    - string
    includeProtocol: boolean
    includeQueryString: boolean
    queryStringBlacklist:
    - string
    queryStringWhitelist:
    - string
  cacheMode: string
  clientTtl: integer
  defaultTtl: integer
  maxTtl: integer
  negativeCaching: boolean
  negativeCachingPolicy:
  - code: integer
    ttl: integer
  serveWhileStale: integer
  signedUrlCacheMaxAgeSec: integer
circuitBreakers:
  connectTimeout:
    nanos: integer
    seconds: integer
  maxConnections: integer
  maxPendingRequests: integer
  maxRequests: integer
  maxRequestsPerConnection: integer
  maxRetries: integer
compressionMode: string
connectionDrainingTimeoutSec: integer
connectionTrackingPolicy:
  connectionPersistenceOnUnhealthyBackends: string
  enableStrongAffinity: boolean
  idleTimeoutSec: integer
  trackingMode: string
consistentHash:
  httpCookie:
    name: string
    path: string
    ttl:
      nanos: integer
      seconds: integer
  httpHeaderName: string
  minimumRingSize: integer
customRequestHeaders:
- string
customResponseHeaders:
- string
description: string
edgeSecurityPolicyRef:
  external: string
  name: string
  namespace: string
enableCdn: boolean
failoverPolicy:
  disableConnectionDrainOnFailover: boolean
  dropTrafficIfUnhealthy: boolean
  failoverRatio: float
healthChecks:
- healthCheckRef:
    external: string
    name: string
    namespace: string
  httpHealthCheckRef:
    external: string
    name: string
    namespace: string
iap:
  oauth2ClientId: string
  oauth2ClientIdRef:
    external: string
    name: string
    namespace: string
  oauth2ClientSecret:
    value: string
    valueFrom:
      secretKeyRef:
        key: string
        name: string
  oauth2ClientSecretSha256: string
loadBalancingScheme: string
localityLbPolicies:
- customPolicy:
    data: string
    name: string
  policy:
    name: string
localityLbPolicy: string
location: string
logConfig:
  enable: boolean
  sampleRate: float
networkRef:
  external: string
  name: string
  namespace: string
outlierDetection:
  baseEjectionTime:
    nanos: integer
    seconds: integer
  consecutiveErrors: integer
  consecutiveGatewayFailure: integer
  enforcingConsecutiveErrors: integer
  enforcingConsecutiveGatewayFailure: integer
  enforcingSuccessRate: integer
  interval:
    nanos: integer
    seconds: integer
  maxEjectionPercent: integer
  successRateMinimumHosts: integer
  successRateRequestVolume: integer
  successRateStdevFactor: integer
portName: string
protocol: string
resourceID: string
securityPolicy: string
securityPolicyRef:
  external: string
  name: string
  namespace: string
securitySettings:
  clientTLSPolicyRef:
    external: string
    name: string
    namespace: string
  subjectAltNames:
  - string
sessionAffinity: string
subsetting:
  policy: string
timeoutSec: integer
Fields

affinityCookieTtlSec

Optional

integer

Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.

backend

Optional

list (object)

The set of backends that serve this BackendService.

backend[]

Optional

object

backend[].balancingMode

Optional

string

Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). See the [Backend Services Overview](https://cloud.google.com/load-balancing/docs/backend-service#balancing-mode) for an explanation of load balancing modes. Default value: "UTILIZATION" Possible values: ["UTILIZATION", "RATE", "CONNECTION"].

backend[].capacityScaler

Optional

float

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). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

backend[].description

Optional

string

An optional description of this resource. Provide this property when you create the resource.

backend[].failover

Optional

boolean

This field designates whether this is a failover backend. More than one failover backend can be configured for a given RegionBackendService.

backend[].group

Required*

object

Reference to a ComputeInstanceGroup or ComputeNetworkEndpointGroup resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group. Backend services cannot mix Instance Group and Network Endpoint Group backends. When the 'load_balancing_scheme' is INTERNAL, only instance groups are supported.

backend[].group.instanceGroupRef

Optional

object

backend[].group.instanceGroupRef.external

Optional

string

Allowed value: The `selfLink` field of a `ComputeInstanceGroup` resource.

backend[].group.instanceGroupRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

backend[].group.instanceGroupRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

backend[].group.networkEndpointGroupRef

Optional

object

backend[].group.networkEndpointGroupRef.external

Optional

string

Allowed value: The `selfLink` field of a `ComputeNetworkEndpointGroup` resource.

backend[].group.networkEndpointGroupRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

backend[].group.networkEndpointGroupRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

backend[].maxConnections

Optional

integer

The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set.

backend[].maxConnectionsPerEndpoint

Optional

integer

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.

backend[].maxConnectionsPerInstance

Optional

integer

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. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

backend[].maxRate

Optional

integer

The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set.

backend[].maxRatePerEndpoint

Optional

float

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.

backend[].maxRatePerInstance

Optional

float

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.

backend[].maxUtilization

Optional

float

Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].

cdnPolicy

Optional

object

Cloud CDN configuration for this BackendService.

cdnPolicy.bypassCacheOnRequestHeaders

Optional

list (object)

Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.

cdnPolicy.bypassCacheOnRequestHeaders[]

Optional

object

cdnPolicy.bypassCacheOnRequestHeaders[].headerName

Required*

string

The header field name to match on when bypassing cache. Values are case-insensitive.

cdnPolicy.cacheKeyPolicy

Optional

object

The CacheKeyPolicy for this CdnPolicy.

cdnPolicy.cacheKeyPolicy.includeHost

Optional

boolean

If true requests to different hosts will be cached separately.

cdnPolicy.cacheKeyPolicy.includeHttpHeaders

Optional

list (string)

Allows HTTP request headers (by name) to be used in the cache key.

cdnPolicy.cacheKeyPolicy.includeHttpHeaders[]

Optional

string

cdnPolicy.cacheKeyPolicy.includeNamedCookies

Optional

list (string)

Names of cookies to include in cache keys.

cdnPolicy.cacheKeyPolicy.includeNamedCookies[]

Optional

string

cdnPolicy.cacheKeyPolicy.includeProtocol

Optional

boolean

If true, http and https requests will be cached separately.

cdnPolicy.cacheKeyPolicy.includeQueryString

Optional

boolean

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

cdnPolicy.cacheKeyPolicy.queryStringBlacklist

Optional

list (string)

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

cdnPolicy.cacheKeyPolicy.queryStringBlacklist[]

Optional

string

cdnPolicy.cacheKeyPolicy.queryStringWhitelist

Optional

list (string)

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

cdnPolicy.cacheKeyPolicy.queryStringWhitelist[]

Optional

string

cdnPolicy.cacheMode

Optional

string

Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL and CACHE_ALL_STATIC Possible values: ["USE_ORIGIN_HEADERS", "FORCE_CACHE_ALL", "CACHE_ALL_STATIC"].

cdnPolicy.clientTtl

Optional

integer

Specifies the maximum allowed TTL for cached content served by this origin.

cdnPolicy.defaultTtl

Optional

integer

Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).

cdnPolicy.maxTtl

Optional

integer

Specifies the maximum allowed TTL for cached content served by this origin.

cdnPolicy.negativeCaching

Optional

boolean

Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.

cdnPolicy.negativeCachingPolicy

Optional

list (object)

Sets a cache TTL for the specified HTTP status code. negativeCaching must be enabled to configure negativeCachingPolicy. Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's default cache TTLs.

cdnPolicy.negativeCachingPolicy[]

Optional

object

cdnPolicy.negativeCachingPolicy[].code

Optional

integer

The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 308, 404, 405, 410, 421, 451 and 501 can be specified as values, and you cannot specify a status code more than once.

cdnPolicy.negativeCachingPolicy[].ttl

Optional

integer

The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

cdnPolicy.serveWhileStale

Optional

integer

Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.

cdnPolicy.signedUrlCacheMaxAgeSec

Optional

integer

Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served. When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

circuitBreakers

Optional

object

Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED.

circuitBreakers.connectTimeout

Optional

object

The timeout for new network connections to hosts.

circuitBreakers.connectTimeout.nanos

Optional

integer

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

circuitBreakers.connectTimeout.seconds

Required*

integer

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

circuitBreakers.maxConnections

Optional

integer

The maximum number of connections to the backend cluster. Defaults to 1024.

circuitBreakers.maxPendingRequests

Optional

integer

The maximum number of pending requests to the backend cluster. Defaults to 1024.

circuitBreakers.maxRequests

Optional

integer

The maximum number of parallel requests to the backend cluster. Defaults to 1024.

circuitBreakers.maxRequestsPerConnection

Optional

integer

Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

circuitBreakers.maxRetries

Optional

integer

The maximum number of parallel retries to the backend cluster. Defaults to 3.

compressionMode

Optional

string

Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values: ["AUTOMATIC", "DISABLED"].

connectionDrainingTimeoutSec

Optional

integer

Time for which instance will be drained (not accept new connections, but still work to finish started).

connectionTrackingPolicy

Optional

object

Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing.

connectionTrackingPolicy.connectionPersistenceOnUnhealthyBackends

Optional

string

Specifies connection persistence when backends are unhealthy. If set to 'DEFAULT_FOR_PROTOCOL', the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to 'NEVER_PERSIST', after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to 'ALWAYS_PERSIST', existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. Default value: "DEFAULT_FOR_PROTOCOL" Possible values: ["DEFAULT_FOR_PROTOCOL", "NEVER_PERSIST", "ALWAYS_PERSIST"].

connectionTrackingPolicy.enableStrongAffinity

Optional

boolean

Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.

connectionTrackingPolicy.idleTimeoutSec

Optional

integer

Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For L4 ILB the minimum(default) is 10 minutes and maximum is 16 hours. For NLB the minimum(default) is 60 seconds and the maximum is 16 hours.

connectionTrackingPolicy.trackingMode

Optional

string

Specifies the key used for connection tracking. There are two options: 'PER_CONNECTION': The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. 'PER_SESSION': The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. Default value: "PER_CONNECTION" Possible values: ["PER_CONNECTION", "PER_SESSION"].

consistentHash

Optional

object

Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH.

consistentHash.httpCookie

Optional

object

Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.

consistentHash.httpCookie.name

Optional

string

Name of the cookie.

consistentHash.httpCookie.path

Optional

string

Path to set for the cookie.

consistentHash.httpCookie.ttl

Optional

object

Lifetime of the cookie.

consistentHash.httpCookie.ttl.nanos

Optional

integer

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

consistentHash.httpCookie.ttl.seconds

Required*

integer

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

consistentHash.httpHeaderName

Optional

string

The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

consistentHash.minimumRingSize

Optional

integer

The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

customRequestHeaders

Optional

list (string)

Headers that the HTTP/S load balancer should add to proxied requests.

customRequestHeaders[]

Optional

string

customResponseHeaders

Optional

list (string)

Headers that the HTTP/S load balancer should add to proxied responses.

customResponseHeaders[]

Optional

string

description

Optional

string

An optional description of this resource.

edgeSecurityPolicyRef

Optional

object

The resource URL for the edge security policy associated with this backend service.

edgeSecurityPolicyRef.external

Optional

string

Allowed value: The `selfLink` field of a `ComputeSecurityPolicy` resource.

edgeSecurityPolicyRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

edgeSecurityPolicyRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

enableCdn

Optional

boolean

If true, enable Cloud CDN for this BackendService.

failoverPolicy

Optional

object

Policy for failovers.

failoverPolicy.disableConnectionDrainOnFailover

Optional

boolean

On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.

failoverPolicy.dropTrafficIfUnhealthy

Optional

boolean

This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.

failoverPolicy.failoverRatio

Optional

float

The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

healthChecks

Optional

list (object)

healthChecks[]

Optional

object

The health check resources for health checking this ComputeBackendService. Currently at most one health check can be specified, and a health check is required.

healthChecks[].healthCheckRef

Optional

object

healthChecks[].healthCheckRef.external

Optional

string

Allowed value: The `selfLink` field of a `ComputeHealthCheck` resource.

healthChecks[].healthCheckRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

healthChecks[].healthCheckRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

healthChecks[].httpHealthCheckRef

Optional

object

healthChecks[].httpHealthCheckRef.external

Optional

string

Allowed value: The `selfLink` field of a `ComputeHTTPHealthCheck` resource.

healthChecks[].httpHealthCheckRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

healthChecks[].httpHealthCheckRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

iap

Optional

object

Settings for enabling Cloud Identity Aware Proxy.

iap.oauth2ClientId

Optional

string

DEPRECATED. Although this field is still available, there is limited support. We recommend that you use `spec.iap.oauth2ClientIdRef` instead.

iap.oauth2ClientIdRef

Optional

object

OAuth2 Client ID for IAP.

iap.oauth2ClientIdRef.external

Optional

string

Allowed value: The `name` field of an `IAPIdentityAwareProxyClient` resource.

iap.oauth2ClientIdRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

iap.oauth2ClientIdRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

iap.oauth2ClientSecret

Optional

object

OAuth2 Client Secret for IAP.

iap.oauth2ClientSecret.value

Optional

string

Value of the field. Cannot be used if 'valueFrom' is specified.

iap.oauth2ClientSecret.valueFrom

Optional

object

Source for the field's value. Cannot be used if 'value' is specified.

iap.oauth2ClientSecret.valueFrom.secretKeyRef

Optional

object

Reference to a value with the given key in the given Secret in the resource's namespace.

iap.oauth2ClientSecret.valueFrom.secretKeyRef.key

Required*

string

Key that identifies the value to be extracted.

iap.oauth2ClientSecret.valueFrom.secretKeyRef.name

Required*

string

Name of the Secret to extract a value from.

iap.oauth2ClientSecretSha256

Optional

string

OAuth2 Client Secret SHA-256 for IAP.

loadBalancingScheme

Optional

string

Immutable. Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). Default value: "EXTERNAL" Possible values: ["EXTERNAL", "INTERNAL_SELF_MANAGED", "INTERNAL_MANAGED", "EXTERNAL_MANAGED"].

localityLbPolicies

Optional

list (object)

A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true.

localityLbPolicies[]

Optional

object

localityLbPolicies[].customPolicy

Optional

object

The configuration for a custom policy implemented by the user and deployed with the client.

localityLbPolicies[].customPolicy.data

Optional

string

An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.

localityLbPolicies[].customPolicy.name

Required*

string

Identifies the custom policy. The value should match the type the custom implementation is registered with on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (e.g. myorg.CustomLbPolicy). The maximum length is 256 characters. Note that specifying the same custom policy more than once for a backend is not a valid configuration and will be rejected.

localityLbPolicies[].policy

Optional

object

The configuration for a built-in load balancing policy.

localityLbPolicies[].policy.name

Required*

string

The name of a locality load balancer policy to be used. The value should be one of the predefined ones as supported by localityLbPolicy, although at the moment only ROUND_ROBIN is supported. This field should only be populated when the customPolicy field is not used. Note that specifying the same policy more than once for a backend is not a valid configuration and will be rejected. The possible values are: * 'ROUND_ROBIN': This is a simple policy in which each healthy backend is selected in round robin order. * 'LEAST_REQUEST': An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. * 'RING_HASH': The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. * 'RANDOM': The load balancer selects a random healthy host. * 'ORIGINAL_DESTINATION': Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. * 'MAGLEV': used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 Possible values: ["ROUND_ROBIN", "LEAST_REQUEST", "RING_HASH", "RANDOM", "ORIGINAL_DESTINATION", "MAGLEV"].

localityLbPolicy

Optional

string

The load balancing algorithm used within the scope of the locality. The possible values are: * 'ROUND_ROBIN': This is a simple policy in which each healthy backend is selected in round robin order. * 'LEAST_REQUEST': An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. * 'RING_HASH': The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. * 'RANDOM': The load balancer selects a random healthy host. * 'ORIGINAL_DESTINATION': Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. * 'MAGLEV': used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup 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 configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This field 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, 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 field set to true. Possible values: ["ROUND_ROBIN", "LEAST_REQUEST", "RING_HASH", "RANDOM", "ORIGINAL_DESTINATION", "MAGLEV", "WEIGHTED_MAGLEV"].

location

Required

string

Location represents the geographical location of the ComputeBackendService. Specify a region name or "global" for global resources. Reference: GCP definition of regions/zones (https://cloud.google.com/compute/docs/regions-zones/)

logConfig

Optional

object

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.

logConfig.enable

Optional

boolean

Whether to enable logging for the load balancer traffic served by this backend service.

logConfig.sampleRate

Optional

float

This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

networkRef

Optional

object

The network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.

networkRef.external

Optional

string

Allowed value: The `selfLink` field of a `ComputeNetwork` resource.

networkRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

networkRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

outlierDetection

Optional

object

Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED.

outlierDetection.baseEjectionTime

Optional

object

The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.

outlierDetection.baseEjectionTime.nanos

Optional

integer

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.

outlierDetection.baseEjectionTime.seconds

Required*

integer

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

outlierDetection.consecutiveErrors

Optional

integer

Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

outlierDetection.consecutiveGatewayFailure

Optional

integer

The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.

outlierDetection.enforcingConsecutiveErrors

Optional

integer

The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

outlierDetection.enforcingConsecutiveGatewayFailure

Optional

integer

The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

outlierDetection.enforcingSuccessRate

Optional

integer

The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

outlierDetection.interval

Optional

object

Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds.

outlierDetection.interval.nanos

Optional

integer

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.

outlierDetection.interval.seconds

Required*

integer

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

outlierDetection.maxEjectionPercent

Optional

integer

Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.

outlierDetection.successRateMinimumHosts

Optional

integer

The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

outlierDetection.successRateRequestVolume

Optional

integer

The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

outlierDetection.successRateStdevFactor

Optional

integer

This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

portName

Optional

string

Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

protocol

Optional

string

The protocol this BackendService uses to communicate with backends. The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and may result in errors if used with the GA API. **NOTE**: With protocol “UNSPECIFIED”, the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing with TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values: ["HTTP", "HTTPS", "HTTP2", "TCP", "SSL", "GRPC", "UNSPECIFIED"].

resourceID

Optional

string

Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.

securityPolicy

Optional

string

The security policy associated with this backend service.

securityPolicyRef

Optional

object

The security policy associated with this backend service.

securityPolicyRef.external

Optional

string

Allowed value: The `selfLink` field of a `ComputeSecurityPolicy` resource.

securityPolicyRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

securityPolicyRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

securitySettings

Optional

object

The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

securitySettings.clientTLSPolicyRef

Required*

object

ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.

securitySettings.clientTLSPolicyRef.external

Optional

string

Allowed value: The `name` field of a `NetworkSecurityClientTLSPolicy` resource.

securitySettings.clientTLSPolicyRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

securitySettings.clientTLSPolicyRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

securitySettings.subjectAltNames

Required*

list (string)

A list of alternate names to verify the subject identity in the certificate. If specified, the client will verify that the server certificate's subject alt name matches one of the specified values.

securitySettings.subjectAltNames[]

Required*

string

sessionAffinity

Optional

string

Type of session affinity to use. The default is NONE. Session affinity is not applicable if the protocol is UDP. Possible values: ["NONE", "CLIENT_IP", "CLIENT_IP_PORT_PROTO", "CLIENT_IP_PROTO", "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE"].

subsetting

Optional

object

Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing.

subsetting.policy

Required*

string

The algorithm used for subsetting. Possible values: ["CONSISTENT_HASH_SUBSETTING"].

timeoutSec

Optional

integer

How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].

* Field is required when parent field is specified

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
creationTimestamp: string
fingerprint: string
generatedId: integer
observedGeneration: integer
selfLink: string
Fields
conditions

list (object)

Conditions represent the latest available observation of the resource's current state.

conditions[]

object

conditions[].lastTransitionTime

string

Last time the condition transitioned from one status to another.

conditions[].message

string

Human-readable message indicating details about last transition.

conditions[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.

conditions[].status

string

Status is the status of the condition. Can be True, False, Unknown.

conditions[].type

string

Type is the type of the condition.

creationTimestamp

string

Creation timestamp in RFC3339 text format.

fingerprint

string

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.

generatedId

integer

The unique identifier for the resource. This identifier is defined by the server.

observedGeneration

integer

ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.

selfLink

string

Sample YAML(s)

External Load Balancing Backend Service

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeBackendService
metadata:
  name: computebackendservice-sample-externalloadbalancing
spec:
  description: External backend service with cookie-based session affinity.
  portName: cookie-cloud
  timeoutSec: 30
  healthChecks:
  - healthCheckRef:
      name: computebackendservice-dep-externalloadbalancing
  loadBalancingScheme: EXTERNAL
  location: global
  protocol: HTTPS
  affinityCookieTtlSec: 360
  connectionDrainingTimeoutSec: 60
  securityPolicyRef:
    name: computebackendservice-dep-externalloadbalancing
  sessionAffinity: GENERATED_COOKIE
  customRequestHeaders:
  - "Trailer: custom-trailer"
  logConfig:
    enable: true
    sampleRate: 0.5
  backend:
  - balancingMode: RATE
    capacityScaler: 1
    description: A network endpoint group serving this backend with all its available capacity, as calculated by number of simultaneous connections.
    maxRatePerEndpoint: 10
    group:
      networkEndpointGroupRef:
        name: computebackendservice-dep-externalloadbalancing
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeHealthCheck
metadata:
  name: computebackendservice-dep-externalloadbalancing
spec:
  httpsHealthCheck:
    port: 443
  location: global
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeInstanceGroup
metadata:
  name: computebackendservice-dep-externalloadbalancing
spec:
  namedPort:
  - name: cookie-cloud
    port: 8444
  zone: us-central1-a
  networkRef:
    name: computebackendservice-dep-externalloadbalancing
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeNetwork
metadata:
  name: computebackendservice-dep-externalloadbalancing
spec:
  routingMode: GLOBAL
  autoCreateSubnetworks: false
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeNetworkEndpointGroup
metadata:
  name: computebackendservice-dep-externalloadbalancing
spec:
  networkRef:
    name: computebackendservice-dep-externalloadbalancing
  subnetworkRef:
    name: computebackendservice-dep-externalloadbalancing
  location: us-west1-a
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeSecurityPolicy
metadata:
  name: computebackendservice-dep-externalloadbalancing
spec:
  rule:
  - action: deny(403)
    priority: 2147483647
    match:
      versionedExpr: SRC_IPS_V1
      config:
        srcIpRanges:
        - "*"
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeSubnetwork
metadata:
  name: computebackendservice-dep-externalloadbalancing
spec:
  ipCidrRange: 10.2.0.0/16
  region: us-west1
  networkRef:
    name: computebackendservice-dep-externalloadbalancing

Internal Managed Load Balancing Backend Service

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeBackendService
metadata:
  name: computebackendservice-sample-internalmanagedloadbalancing
spec:
  description: Internal managed backend service with Maglev session affinity.
  localityLbPolicy: MAGLEV
  timeoutSec: 86400
  consistentHash:
    httpHeaderName: "Hash string"
  healthChecks:
  - healthCheckRef:
      name: computebackendservice-dep-internalmanagedloadbalancing
  loadBalancingScheme: INTERNAL_MANAGED
  location: us-east1
  protocol: HTTP
  connectionDrainingTimeoutSec: 10
  sessionAffinity: HEADER_FIELD
  circuitBreakers:
    connectTimeout:
      nanos: 999999999
      seconds: 0
    maxConnections: 1024
    maxPendingRequests: 1024
    maxRequests: 1024
    maxRequestsPerConnection: 1
    maxRetries: 3
  logConfig:
    enable: false
  outlierDetection:
    consecutiveGatewayFailure: 5
    enforcingConsecutiveErrors: 100
    enforcingSuccessRate: 100
    successRateMinimumHosts: 5
    successRateRequestVolume: 100
    baseEjectionTime:
      nanos: 999999999
      seconds: 29
    consecutiveErrors: 5
    enforcingConsecutiveGatewayFailure: 0
    interval:
      nanos: 999999999
      seconds: 9
    maxEjectionPercent: 10
    successRateStdevFactor: 1900
  backend:
  - balancingMode: RATE
    capacityScaler: 0.9
    description: An instance group serving this backend with 90% of its capacity, as calculated by requests per second.
    maxRate: 10000
    group:
      instanceGroupRef:
        name: computebackendservice-dep-internalmanagedloadbalancing
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeHealthCheck
metadata:
  name: computebackendservice-dep-internalmanagedloadbalancing
spec:
  httpHealthCheck:
    port: 80
  location: global
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeInstanceGroup
metadata:
  name: computebackendservice-dep-internalmanagedloadbalancing
spec:
  zone: us-east1-c
  networkRef:
    name: computebackendservice-dep-internalmanagedloadbalancing
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeNetwork
metadata:
  name: computebackendservice-dep-internalmanagedloadbalancing
spec:
  routingMode: REGIONAL
  autoCreateSubnetworks: false

Oauth2clientid Backend Service

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeBackendService
metadata:
  name: computebackendservice-sample-oauth2clientid
spec:
  description: Internal managed backend service with Maglev session affinity.
  localityLbPolicy: MAGLEV
  timeoutSec: 86400
  consistentHash:
    httpHeaderName: "Hash string"
  healthChecks:
  - healthCheckRef:
      name: computebackendservice-dep-oauth2clientid
  loadBalancingScheme: INTERNAL_MANAGED
  location: us-east1
  protocol: HTTP
  connectionDrainingTimeoutSec: 10
  sessionAffinity: HEADER_FIELD
  circuitBreakers:
    connectTimeout:
      nanos: 999999999
      seconds: 0
    maxConnections: 1024
    maxPendingRequests: 1024
    maxRequests: 1024
    maxRequestsPerConnection: 1
    maxRetries: 3
  logConfig:
    enable: false
  outlierDetection:
    consecutiveGatewayFailure: 5
    enforcingConsecutiveErrors: 100
    enforcingSuccessRate: 100
    successRateMinimumHosts: 5
    successRateRequestVolume: 100
    baseEjectionTime:
      nanos: 999999999
      seconds: 29
    consecutiveErrors: 5
    enforcingConsecutiveGatewayFailure: 0
    interval:
      nanos: 999999999
      seconds: 9
    maxEjectionPercent: 10
    successRateStdevFactor: 1900
  backend:
  - balancingMode: RATE
    capacityScaler: 0.9
    description: An instance group serving this backend with 90% of its capacity, as calculated by requests per second.
    maxRate: 10000
    group:
      instanceGroupRef:
        name: computebackendservice-dep-oauth2clientid
  iap:
    oauth2ClientIdRef:
      external: computebackendservice-dep-oauth2clientid
    oauth2ClientSecret:
      value: "test-secret-value"
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeHealthCheck
metadata:
  name: computebackendservice-dep-oauth2clientid
spec:
  httpHealthCheck:
    port: 80
  location: global
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeInstanceGroup
metadata:
  name: computebackendservice-dep-oauth2clientid
spec:
  zone: us-east1-c
  networkRef:
    name: computebackendservice-dep-oauth2clientid
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeNetwork
metadata:
  name: computebackendservice-dep-oauth2clientid
spec:
  routingMode: REGIONAL
  autoCreateSubnetworks: false
---
apiVersion: iap.cnrm.cloud.google.com/v1beta1
kind: IAPBrand
metadata:
  name: computebackendservice-dep-oauth2clientid
spec:
  applicationTitle: "test brand"
  supportEmail: "support@example.com"
---
apiVersion: iap.cnrm.cloud.google.com/v1beta1
kind: IAPIdentityAwareProxyClient
metadata:
  name: computebackendservice-dep-oauth2clientid
spec:
  displayName: "Test Client"
  brandRef:
    name: computebackendservice-dep-oauth2clientid