GCPBackendPolicy
networking.gke.io / v1
apiVersion: networking.gke.io/v1
kind: GCPBackendPolicy
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object required
Spec defines the desired state of GCPBackendPolicy.
default object
Default defines default policy configuration for the targeted resource.
backendPreference
string
BackendPreference indicates whether the backend should be fully
utilized before sending traffic to backends with default preference.
Can only be configured for multi-cluster service backends when
GCPBackendPolicy targets ServiceExport.
The default value is DEFAULT.
enum:
DEFAULT, PREFERRED
balancingMode
string
BalancingMode specifies how to determine whether the backend of a load balancer can handle
additional traffic or is fully loaded.
Can be set as RATE, UTILIZATION, CUSTOM_METRICS or IN_FLIGHT.
enum:
RATE, UTILIZATION, CUSTOM_METRICS, IN_FLIGHT
capacityScalerPercent
integer
CapacityScalerPercent is a multiplier applied to the backend's target capacity of its balancing
mode. The field is a percentage value in the range [0, 100] with the default value being 100.
This means the group serves 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.
format:
int64minimum:
0maximum:
100connectionDraining object
ConnectionDraining contains configuration for connection draining
drainingTimeoutSec
integer
DrainingTimeoutSec is a BackendService parameter.
It is used during removal of VMs from instance groups. This guarantees that for
the specified time all existing connections to a VM will remain untouched,
but no new connections will be accepted. Set timeout to zero to disable
connection draining. Enable the feature by specifying a timeout of up to
one hour. If the field is omitted, a default value (0s) will be used.
See https://cloud.google.com/compute/docs/reference/rest/v1/backendServices
format:
int64minimum:
0maximum:
3600customMetrics []object
CustomMetrics contains configuration for custom backend load reporting metrics.
maxItems:
2
dryRun
boolean required
DryRun specifies whether the metric should be used to determine load of the backend.
maxUtilizationPercent
integer
MaxUtilizationPercent specifies a target capacity for the Custom Metrics utilization balancing mode.
Default value for GCE resource is 80.
format:
int32minimum:
0maximum:
100
name
string required
Specifies the name associated with the custom metric.
pattern:
^[a-z]([-_.:a-z0-9]*[a-z0-9])?$minLength:
1maxLength:
63iap object
IAP contains the configurations for Identity-Aware Proxy.
See https://cloud.google.com/compute/docs/reference/rest/v1/backendServices
Identity-Aware Proxy manages access control policies for backend services associated with a HTTPRoute,
so they can be accessed only by authenticated users or applications with correct Identity and Access Management (IAM) role.
clientID
string
ClientID is the OAuth2 client ID to use for the authentication flow.
See iap.oauth2ClientId in https://cloud.google.com/compute/docs/reference/rest/v1/backendServices
To use a custom OAuth client, provide both ClientID and Oauth2ClientSecret. If neither is provided, Google managed OAuth is the default.
enabled
boolean
Enabled denotes whether the serving infrastructure will authenticate and authorize all incoming requests.
If true, the ClientID and Oauth2ClientSecret fields must be non-empty.
If not specified, this defaults to false, which means Identity-Aware Proxy is disabled by default.
oauth2ClientSecret object
Oauth2ClientSecret contains the OAuth2 client secret to use for the authentication flow.
To use a custom OAuth client, provide both ClientID and Oauth2ClientSecret. If neither is provided, Google managed OAuth is the default.
name
string
Name is the reference to the secret resource.
logging object
LoggingConfig contains configuration for logging.
enabled
boolean
Enabled denotes whether to enable logging for the load balancer traffic
served by this backend service. If not specified, this defaults to false,
which means logging is disabled by default.
optionalFields
[]string
List of optional fields to include in the log entries (such as "tls.cipher" or
"orca_load_report", for example).
The list of supported fields is maintained in
http://google3/gfe/gics/cloud_rcth/translation/constants.h
We don't validate individual values here, as it would be difficult to keep in sync
and coordinate rollouts, but we do have some basic validation rules for field names
and max number of fields.
maxItems:
30
optionalMode
string
Specifies whether to log all optional fields, none, or a subset configured
by the optionalFields.
enum:
EXCLUDE_ALL_OPTIONAL, INCLUDE_ALL_OPTIONAL, CUSTOM
sampleRate
integer
This field can only be specified if logging is enabled for this backend
service. The value of the field must be in range [0, 1e6]. This is
converted to a floating point value in the range [0, 1] by dividing by 1e6
for use with the GCE api and interpreted as the proportion of requests that
will be logged. By default all requests will be logged.
format:
int32minimum:
0maximum:
1e+06
maxInFlightRequestsPerEndpoint
integer
MaxInFlightRequestsPerEndpoint configures the maximum number of concurrent requests that can be
in-flight on an endpoint at a given time. Not available if backend’s balancing mode is RATE
or CONNECTION.
If the field is omitted, a default value (1e8) will be used.
format:
int64minimum:
1maximum:
1e+09
maxRatePerEndpoint
integer
MaxRatePerEndpoint configures the target capacity for backends.
If the field is omitted, a default value (1e8) will be used.
In the future we may add selector based settings for MaxRatePerEndpoint but they will co-exist
format:
int64minimum:
1maximum:
1e+09scopes []object
Scopes contains LoadBalancer policy configuration per cluster.
maxItems:
16
backendPreference
string
BackendPreference indicates whether the backend should be fully
utilized before sending traffic to backends with default preference.
Can only be configured for multi-cluster service backends when
GCPBackendPolicy targets ServiceExport.
The default value is DEFAULT.
Cannot be specified if the top-level(default) backendPreference is specified.
enum:
DEFAULT, PREFERRED
balancingMode
string
BalancingMode specifies how to determine whether the backend of a load balancer can handle
additional traffic or is fully loaded.
Can be set as RATE, UTILIZATION, CUSTOM_METRICS or IN_FLIGHT.
enum:
RATE, UTILIZATION, CUSTOM_METRICS, IN_FLIGHT
capacityScalerPercent
integer
CapacityScalerPercent is a multiplier applied to the backend's target capacity of its balancing
mode. The field is a percentage value in the range [0, 100] with the default value being 100.
This means the group serves 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.
format:
int64minimum:
0maximum:
100customMetrics []object
CustomMetrics contains configuration for custom backend load reporting metrics.
maxItems:
2
dryRun
boolean required
DryRun specifies whether the metric should be used to determine load of the backend.
maxUtilizationPercent
integer
MaxUtilizationPercent specifies a target capacity for the Custom Metrics utilization balancing mode.
Default value for GCE resource is 80.
format:
int32minimum:
0maximum:
100
name
string required
Specifies the name associated with the custom metric.
pattern:
^[a-z]([-_.:a-z0-9]*[a-z0-9])?$minLength:
1maxLength:
63
maxInFlightRequestsPerEndpoint
integer
MaxInFlightRequestsPerEndpoint configures the maximum number of concurrent requests that can be
in-flight on an endpoint at a given time. Not available if backend’s balancing mode is RATE
or CONNECTION.
If the field is omitted, a default value (1e8) will be used.
format:
int64minimum:
1maximum:
1e+09
maxRatePerEndpoint
integer
MaxRatePerEndpoint configures the target capacity for backends.
If the field is omitted, a default value (1e8) will be used.
Cannot be specified if the top-level(default) maxRatePerEndpoint is specified.
format:
int64minimum:
1maximum:
1e+09
selector
object
Selector is a map of labels that identifies the backend service to apply the policy to.
The selector keys can be one of gke.io/zone, gke.io/region or gke.io/cluster-name.
trafficDuration
string
Specifies the expected traffic duration for this service. The possible values are:
SHORT: Most requests are expected to finish with a sub-second latency.
LONG: Most of the requests are expected to take more than multiple seconds to finish.
The default value is SHORT.
When it is LONG, compatible balancing modes are IN_FLIGHT/UTILIZATION/CUSTOM_METRICS
When it is SHORT, compatible balancing modes are RATE/UTILIZATION/CUSTOM_METRICS
Can be set as SHORT or LONG.
enum:
SHORT, LONG
securityPolicy
string
SecurityPolicy is a reference to a GCP Cloud Armor SecurityPolicy resource.
sessionAffinity object
SessionAffinityConfig contains configuration for stickiness parameters supported via
GCPBackendPolicy.
cookieTtlSec
integer
CookieTTLSec specifies the lifetime of cookies in seconds. This setting
requires GENERATED_COOKIE or HTTP_COOKIE session affinity. 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 is two weeks
(1,209,600).
format:
int64minimum:
0maximum:
1.2096e+06
type
string
Type specifies the type of session affinity to use. If not specified, this
defaults to NONE.
enum:
CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, HTTP_COOKIE, NONE
timeoutSec
integer
TimeoutSec is a BackendService parameter.
See https://cloud.google.com/compute/docs/reference/rest/v1/backendServices.
If the field is omitted, a default value (30s) will be used.
format:
int64minimum:
1maximum:
2.147483647e+09
trafficDuration
string
Specifies the expected traffic duration for this service. The possible values are:
SHORT: Most requests are expected to finish with a sub-second latency.
LONG: Most of the requests are expected to take more than multiple seconds to finish.
The default value is SHORT.
When it is LONG, compatible balancing modes are IN_FLIGHT/UTILIZATION/CUSTOM_METRICS
When it is SHORT, compatible balancing modes are RATE/UTILIZATION/CUSTOM_METRICS
Can be set as SHORT or LONG.
enum:
SHORT, LONGtargetRef object required
TargetRef identifies an API object to apply policy to.
group
string required
Group is the group of the target resource.
pattern:
^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$maxLength:
253
kind
string required
Kind is kind of the target resource.
pattern:
^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$minLength:
1maxLength:
63
name
string required
Name is the name of the target resource.
minLength:
1maxLength:
253
namespace
string
Namespace is the namespace of the referent. When unspecified, the local
namespace is inferred. Even when policy targets a resource in a different
namespace, it MUST only apply to traffic originating from the same
namespace as the policy.
pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$minLength:
1maxLength:
63status object
Status defines the current state of GCPBackendPolicy.
ancestors []object
Ancestors is a list of ancestor resources (usually Gateways) that are
associated with the policy, and the status of the policy with respect to
each ancestor.
maxItems:
16ancestorRef object required
AncestorRef corresponds with a ParentRef in the spec that this
PolicyAncestorStatus struct describes the status of.
group
string
Group is the group of the referent.
When unspecified, "gateway.networking.k8s.io" is inferred.
To set the core API group (such as for a "Service" kind referent),
Group must be explicitly set to "" (empty string).
Support: Core
pattern:
^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$maxLength:
253
kind
string
Kind is kind of the referent.
There are two kinds of parent resources with "Core" support:
* Gateway (Gateway conformance profile)
* Service (Mesh conformance profile, ClusterIP Services only)
Support for other resources is Implementation-Specific.
pattern:
^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$minLength:
1maxLength:
63
name
string required
Name is the name of the referent.
Support: Core
minLength:
1maxLength:
253
namespace
string
Namespace is the namespace of the referent. When unspecified, this refers
to the local namespace of the Route.
Note that there are specific rules for ParentRefs which cross namespace
boundaries. Cross-namespace references are only valid if they are explicitly
allowed by something in the namespace they are referring to. For example:
Gateway has the AllowedRoutes field, and ReferenceGrant provides a
generic way to enable any other kind of cross-namespace reference.
<gateway:experimental:description>
ParentRefs from a Route to a Service in the same namespace are "producer"
routes, which apply default routing rules to inbound connections from
any namespace to the Service.
ParentRefs from a Route to a Service in a different namespace are
"consumer" routes, and these routing rules are only applied to outbound
connections originating from the same namespace as the Route, for which
the intended destination of the connections are a Service targeted as a
ParentRef of the Route.
</gateway:experimental:description>
Support: Core
pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$minLength:
1maxLength:
63
port
integer
Port is the network port this Route targets. It can be interpreted
differently based on the type of parent resource.
When the parent resource is a Gateway, this targets all listeners
listening on the specified port that also support this kind of Route(and
select this Route). It's not recommended to set `Port` unless the
networking behaviors specified in a Route must apply to a specific port
as opposed to a listener(s) whose port(s) may be changed. When both Port
and SectionName are specified, the name and port of the selected listener
must match both specified values.
<gateway:experimental:description>
When the parent resource is a Service, this targets a specific port in the
Service spec. When both Port (experimental) and SectionName are specified,
the name and port of the selected port must match both specified values.
</gateway:experimental:description>
Implementations MAY choose to support other parent resources.
Implementations supporting other types of parent resources MUST clearly
document how/if Port is interpreted.
For the purpose of status, an attachment is considered successful as
long as the parent resource accepts it partially. For example, Gateway
listeners can restrict which Routes can attach to them by Route kind,
namespace, or hostname. If 1 of 2 Gateway listeners accept attachment
from the referencing Route, the Route MUST be considered successfully
attached. If no Gateway listeners accept attachment from this Route,
the Route MUST be considered detached from the Gateway.
Support: Extended
format:
int32minimum:
1maximum:
65535
sectionName
string
SectionName is the name of a section within the target resource. In the
following resources, SectionName is interpreted as the following:
* Gateway: Listener name. When both Port (experimental) and SectionName
are specified, the name and port of the selected listener must match
both specified values.
* Service: Port name. When both Port (experimental) and SectionName
are specified, the name and port of the selected listener must match
both specified values.
Implementations MAY choose to support attaching Routes to other resources.
If that is the case, they MUST clearly document how SectionName is
interpreted.
When unspecified (empty string), this will reference the entire resource.
For the purpose of status, an attachment is considered successful if at
least one section in the parent resource accepts it. For example, Gateway
listeners can restrict which Routes can attach to them by Route kind,
namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from
the referencing Route, the Route MUST be considered successfully
attached. If no Gateway listeners accept attachment from this Route, the
Route MUST be considered detached from the Gateway.
Support: Core
pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$minLength:
1maxLength:
253conditions []object
Conditions describes the status of the Policy with respect to the given Ancestor.
minItems:
1maxItems:
8
lastTransitionTime
string required
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format:
date-time
message
string required
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format:
int64minimum:
0
reason
string required
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern:
^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$maxLength:
316
controllerName
string required
ControllerName is a domain/path string that indicates the name of the
controller that wrote this status. This corresponds with the
controllerName field on GatewayClass.
Example: "example.net/gateway-controller".
The format of this field is DOMAIN "/" PATH, where DOMAIN and PATH are
valid Kubernetes names
(https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).
Controllers MUST populate this field when writing status. Controllers should ensure that
entries to status populated with their ControllerName are cleaned up when they are no
longer necessary.
pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$minLength:
1maxLength:
253conditions []object
Conditions describe the current conditions of the GCPBackendPolicy.
maxItems:
8
lastTransitionTime
string required
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format:
date-time
message
string required
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format:
int64minimum:
0
reason
string required
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern:
^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$maxLength:
316No matches. Try .spec.default for an exact path