Package v1 contains API Schema definitions for the networking.gke.io ServicePolicy v1 API group.
Resource TypesCommonHTTPHealthCheck holds all the fields that are common across all HTTP health checks.
Appears in: - HTTP2HealthCheck - HTTPHealthCheck - HTTPSHealthCheck
Field Description Default Validationhost
string Host is the value of the host header in the HTTP health check request. This
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
requestPath
string The request path of the HTTP health check request.
\/[A-Za-z0-9\/\-._~%!?$&'()*+,;=:]*$
proxyHeader
ProxyHeaderType Specifies the type of proxy header to append before sending data to the backend,
response
string The string to match anywhere in the first 1024 bytes of the response body.
[\x00-\xFF]+
CommonHealthCheck holds all the fields that are common across all protocol health checks.
Appears in: - GRPCHealthCheck - HTTP2HealthCheck - HTTPHealthCheck - HTTPSHealthCheck - TCPHealthCheck
Field Description Default ValidationportSpecification
PortSpecificationType Specifies how port is selected for health checking, can be one of following values:
USE_FIXED_PORT: The port number in port is used for health checking.
If not specified, Protocol health check follows behavior specified in port and portName fields.
port
integer The TCP port number for the health check request. Valid values are 1 through 65535. Maximum: 65535
portName
string Port name as defined in InstanceGroup#NamedPort#name.
[a-z]([-a-z0-9]*[a-z0-9])?
ConnectionDraining contains configuration for connection draining
Appears in: - GCPBackendPolicyConfig
Field Description Default ValidationdrainingTimeoutSec
integer DrainingTimeoutSec is a BackendService parameter.
GCPBackendPolicy provides a way to apply LoadBalancer policy configuration with the GKE implementation of the Gateway API.
Appears in: - GCPBackendPolicyList
Field Description Default ValidationapiVersion
string networking.gke.io/v1
kind
string GCPBackendPolicy
metadata
ObjectMeta Refer to Kubernetes API documentation for fields of metadata
. spec
GCPBackendPolicySpec Spec defines the desired state of GCPBackendPolicy. status
GCPBackendPolicyStatus Status defines the current state of GCPBackendPolicy. GCPBackendPolicyConfig
GCPBackendPolicyConfig contains LoadBalancer policy configuration.
Appears in: - GCPBackendPolicySpec
Field Description Default Validationlogging
LoggingConfig sessionAffinity
SessionAffinityConfig connectionDraining
ConnectionDraining timeoutSec
integer TimeoutSec is a BackendService parameter.
securityPolicy
string SecurityPolicy is a reference to a GCP Cloud Armor SecurityPolicy resource. iap
IdentityAwareProxyConfig IAP contains the configurations for Identity-Aware Proxy.
GCPBackendPolicyList contains a list of GCPBackendPolicy.
Field Description Default ValidationapiVersion
string networking.gke.io/v1
kind
string GCPBackendPolicyList
metadata
ListMeta Refer to Kubernetes API documentation for fields of metadata
. items
GCPBackendPolicy array GCPBackendPolicySpec
GCPBackendPolicySpec defines the desired state of GCPBackendPolicy.
Appears in: - GCPBackendPolicy
Field Description Default ValidationtargetRef
PolicyTargetReference TargetRef identifies an API object to apply policy to. default
GCPBackendPolicyConfig Default defines default policy configuration for the targeted resource. GCPBackendPolicyStatus
GCPBackendPolicyStatus defines the observed state of GCPBackendPolicy.
Appears in: - GCPBackendPolicy
Field Description Default Validationconditions
Condition array Conditions describe the current conditions of the GCPBackendPolicy. MaxItems: 8
GCPGatewayPolicy provides a way to apply SSL policy and other configuration to the GKE Gateway.
Appears in: - GCPGatewayPolicyList
Field Description Default ValidationapiVersion
string networking.gke.io/v1
kind
string GCPGatewayPolicy
metadata
ObjectMeta Refer to Kubernetes API documentation for fields of metadata
. spec
GCPGatewayPolicySpec Spec defines the desired state of GCPGatewayPolicy. status
GCPGatewayPolicyStatus Status defines the current state of GCPGatewayPolicy. GCPGatewayPolicyConfig
GCPGatewayPolicyConfig contains gateway policy configuration.
Appears in: - GCPGatewayPolicySpec
Field Description Default ValidationsslPolicy
string allowGlobalAccess
boolean region
string Region allows to specify load balancer's region for Multi-cluster Gateway. GCPGatewayPolicyList
GCPGatewayPolicyList contains a list of GCPGatewayPolicies.
Field Description Default ValidationapiVersion
string networking.gke.io/v1
kind
string GCPGatewayPolicyList
metadata
ListMeta Refer to Kubernetes API documentation for fields of metadata
. items
GCPGatewayPolicy array GCPGatewayPolicySpec
GCPGatewayPolicySpec defines the desired state of GCPGatewayPolicy.
Appears in: - GCPGatewayPolicy
Field Description Default ValidationtargetRef
PolicyTargetReference TargetRef identifies an API object to apply policy to. default
GCPGatewayPolicyConfig Default defines default gateway policy configuration for the targeted resource. GCPGatewayPolicyStatus
GCPGatewayPolicyStatus defines the observed state of GCPGatewayPolicy.
Appears in: - GCPGatewayPolicy
Field Description Default Validationconditions
Condition array Conditions describe the current conditions of the GatewayPolicy. MaxItems: 8
GCPSessionAffinityFilter provides a way to configure session affinity for a RouteAction.
Appears in: - GCPSessionAffinityFilterList
Field Description Default ValidationapiVersion
string networking.gke.io/v1
kind
string GCPSessionAffinityFilter
metadata
ObjectMeta Refer to Kubernetes API documentation for fields of metadata
. spec
GCPSessionAffinitySpec Spec defines the desired state of GCPSessionAffinityFilter. status
GCPSessionAffinityFilterStatus Status defines the current state of GCPSessionAffinityFilter. GCPSessionAffinityFilterList
GCPSessionAffinityFilterList contains a list of GCPSessionAffinityFilter.
Field Description Default ValidationapiVersion
string networking.gke.io/v1
kind
string GCPSessionAffinityFilterList
metadata
ListMeta Refer to Kubernetes API documentation for fields of metadata
. items
GCPSessionAffinityFilter array GCPSessionAffinityFilterStatus
GCPSessionAffinityFilterStatus defines the observed state of GCPSessionAffinityFilter.
Appears in: - GCPSessionAffinityFilter
Field Description Default Validationconditions
Condition array Conditions describe the current conditions of the GCPSessionAffinityFilter. MaxItems: 8
GCPSessionAffinityPolicy provides a way to apply session affinity policy configuration.
Appears in: - GCPSessionAffinityPolicyList
Field Description Default ValidationapiVersion
string networking.gke.io/v1
kind
string GCPSessionAffinityPolicy
metadata
ObjectMeta Refer to Kubernetes API documentation for fields of metadata
. spec
GCPSessionAffinityPolicySpec Spec defines the desired state of GCPSessionAffinityPolicy. status
GCPSessionAffinityPolicyStatus Status defines the current state of GCPSessionAffinityPolicy. GCPSessionAffinityPolicyList
GCPSessionAffinityPolicyList contains a list of GCPSessionAffinityPolicy.
Field Description Default ValidationapiVersion
string networking.gke.io/v1
kind
string GCPSessionAffinityPolicyList
metadata
ListMeta Refer to Kubernetes API documentation for fields of metadata
. items
GCPSessionAffinityPolicy array GCPSessionAffinityPolicySpec
GCPSessionAffinityPolicySpec defines the desired state of GCPSessionAffinityPolicy.
Appears in: - GCPSessionAffinityPolicy
GCPSessionAffinityPolicyStatusGCPSessionAffinityPolicyStatus defines the observed state of GCPSessionAffinityPolicy.
Appears in: - GCPSessionAffinityPolicy
Field Description Default Validationconditions
Condition array Conditions describe the current conditions of the GCPSessionAffinityPolicy. MaxItems: 8
GCPSessionAffinitySpec defines the desired state of GCPSessionAffinityFilter and is shared with GCPSessionAffinityPolicy.
Appears in: - GCPSessionAffinityFilter - GCPSessionAffinityPolicySpec
GRPCHealthCheckGRPCHealthCheck is the health check configuration of type GRPC
Appears in: - HealthCheck
Field Description Default ValidationportSpecification
PortSpecificationType Specifies how port is selected for health checking, can be one of following values:
USE_FIXED_PORT: The port number in port is used for health checking.
If not specified, Protocol health check follows behavior specified in port and portName fields.
port
integer The TCP port number for the health check request. Valid values are 1 through 65535. Maximum: 65535
portName
string Port name as defined in InstanceGroup#NamedPort#name.
[a-z]([-a-z0-9]*[a-z0-9])?
grpcServiceName
string The gRPC service name for the health check. This field is optional.
[\x00-\xFF]+
HTTP2HealthCheck is the health check configuration of type HTTP2
Appears in: - HealthCheck
Field Description Default ValidationportSpecification
PortSpecificationType Specifies how port is selected for health checking, can be one of following values:
USE_FIXED_PORT: The port number in port is used for health checking.
If not specified, Protocol health check follows behavior specified in port and portName fields.
port
integer The TCP port number for the health check request. Valid values are 1 through 65535. Maximum: 65535
portName
string Port name as defined in InstanceGroup#NamedPort#name.
[a-z]([-a-z0-9]*[a-z0-9])?
host
string Host is the value of the host header in the HTTP health check request. This
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
requestPath
string The request path of the HTTP health check request.
\/[A-Za-z0-9\/\-._~%!?$&'()*+,;=:]*$
proxyHeader
ProxyHeaderType Specifies the type of proxy header to append before sending data to the backend,
response
string The string to match anywhere in the first 1024 bytes of the response body.
[\x00-\xFF]+
HTTPHealthCheck is the health check configuration of type HTTP
Appears in: - HealthCheck
Field Description Default ValidationportSpecification
PortSpecificationType Specifies how port is selected for health checking, can be one of following values:
USE_FIXED_PORT: The port number in port is used for health checking.
If not specified, Protocol health check follows behavior specified in port and portName fields.
port
integer The TCP port number for the health check request. Valid values are 1 through 65535. Maximum: 65535
portName
string Port name as defined in InstanceGroup#NamedPort#name.
[a-z]([-a-z0-9]*[a-z0-9])?
host
string Host is the value of the host header in the HTTP health check request. This
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
requestPath
string The request path of the HTTP health check request.
\/[A-Za-z0-9\/\-._~%!?$&'()*+,;=:]*$
proxyHeader
ProxyHeaderType Specifies the type of proxy header to append before sending data to the backend,
response
string The string to match anywhere in the first 1024 bytes of the response body.
[\x00-\xFF]+
HTTPSHealthCheck is the health check configuration of type HTTPS
Appears in: - HealthCheck
Field Description Default ValidationportSpecification
PortSpecificationType Specifies how port is selected for health checking, can be one of following values:
USE_FIXED_PORT: The port number in port is used for health checking.
If not specified, Protocol health check follows behavior specified in port and portName fields.
port
integer The TCP port number for the health check request. Valid values are 1 through 65535. Maximum: 65535
portName
string Port name as defined in InstanceGroup#NamedPort#name.
[a-z]([-a-z0-9]*[a-z0-9])?
host
string Host is the value of the host header in the HTTP health check request. This
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
requestPath
string The request path of the HTTP health check request.
\/[A-Za-z0-9\/\-._~%!?$&'()*+,;=:]*$
proxyHeader
ProxyHeaderType Specifies the type of proxy header to append before sending data to the backend,
response
string The string to match anywhere in the first 1024 bytes of the response body.
[\x00-\xFF]+
HealthCheck is a union struct that contains per protocol (i.e. HTTP, HTTPS, HTTP2, TCP, GRPC) configuration.
Validation: - MaxProperties: 2 - MinProperties: 2
Appears in: - HealthCheckPolicyConfig
Field Description Default Validationtype
HealthCheckType Specifies the type of the healthCheck, either TCP, HTTP, HTTPS, HTTP2 or GRPC.
tcpHealthCheck
TCPHealthCheck TCP is the health check configuration of type TCP. httpHealthCheck
HTTPHealthCheck HTTP is the health check configuration of type HTTP. httpsHealthCheck
HTTPSHealthCheck HTTPS is the health check configuration of type HTTPS. http2HealthCheck
HTTP2HealthCheck HTTP2 is the health check configuration of type HTTP2. grpcHealthCheck
GRPCHealthCheck GRPC is the health check configuration of type GRPC. HealthCheckPolicy
HealthCheckPolicy provides a way to create and attach a HealthCheck to a BackendService with the GKE implementation of the Gateway API. This policy can only be attached to a BackendService.
Appears in: - HealthCheckPolicyList
Field Description Default ValidationapiVersion
string networking.gke.io/v1
kind
string HealthCheckPolicy
metadata
ObjectMeta Refer to Kubernetes API documentation for fields of metadata
. spec
HealthCheckPolicySpec Spec defines the desired state of HealthCheckPolicy. status
HealthCheckPolicyStatus Status defines the current state of HealthCheckPolicy. HealthCheckPolicyConfig
HealthCheckPolicyConfig contains HealthCheck policy configuration.
Appears in: - HealthCheckPolicySpec
Field Description Default ValidationcheckIntervalSec
integer How often (in seconds) to send a health check.
timeoutSec
integer How long (in seconds) to wait before claiming failure.
unhealthyThreshold
integer A so-far healthy instance will be marked unhealthy after this many consecutive failures.
healthyThreshold
integer A so-far unhealthy instance will be marked healthy after this many consecutive successes.
config
HealthCheck Specifies the type of the healthCheck, either TCP, HTTP, HTTPS, HTTP2 or GRPC.
logConfig
LogConfig LogConfig configures logging on this health check. HealthCheckPolicyList
HealthCheckPolicyList contains a list of HealthCheckPolicy.
Field Description Default ValidationapiVersion
string networking.gke.io/v1
kind
string HealthCheckPolicyList
metadata
ListMeta Refer to Kubernetes API documentation for fields of metadata
. items
HealthCheckPolicy array HealthCheckPolicySpec
HealthCheckPolicySpec defines the desired state of HealthCheckPolicy.
Appears in: - HealthCheckPolicy
Field Description Default ValidationtargetRef
PolicyTargetReference TargetRef identifies an API object to apply policy to. default
HealthCheckPolicyConfig Default defines default policy configuration for the targeted resource. HealthCheckPolicyStatus
HealthCheckPolicyStatus defines the observed state of HealthCheckPolicy.
Appears in: - HealthCheckPolicy
Field Description Default Validationconditions
Condition array Conditions describe the current conditions of the HealthCheckPolicy. MaxItems: 8
Underlying type: string
HealthCheckType is the HealthCheck protocol type.
Appears in: - HealthCheck
IdentityAwareProxyConfigIdentityAwareProxyConfig contains the configurations for Identity-Aware Proxy. 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. See https://cloud.google.com/compute/docs/reference/rest/v1/backendServices
Appears in: - GCPBackendPolicyConfig
Field Description Default Validationenabled
boolean Enabled denotes whether the serving infrastructure will authenticate and authorize all incoming requests.
oauth2ClientSecret
Oauth2ClientSecret Oauth2ClientSecret contains the OAuth2 client secret to use for the authentication flow.
clientID
string ClientID is the OAuth2 client ID to use for the authentication flow.
LogConfig configures logging on this health check.
Appears in: - HealthCheckPolicyConfig
Field Description Default Validationenabled
boolean Enabled indicates whether or not to export health check logs. If not
LoggingConfig contains configuration for logging.
Appears in: - GCPBackendPolicyConfig
Field Description Default Validationenabled
boolean Enabled denotes whether to enable logging for the load balancer traffic
sampleRate
integer This field can only be specified if logging is enabled for this backend
Oauth2ClientSecret contains the OAuth2 client secret to use for the authentication flow. See https://cloud.google.com/compute/docs/reference/rest/v1/backendServices
Appears in: - IdentityAwareProxyConfig
Field Description Default Validationname
string Name is the reference to the secret resource. PortSpecificationType
Underlying type: string
PortSpecificationType is the PortSpecification type.
Appears in: - CommonHealthCheck - GRPCHealthCheck - HTTP2HealthCheck - HTTPHealthCheck - HTTPSHealthCheck - TCPHealthCheck
Underlying type: string
ProxyHeaderType is the ProxyHeader type.
Appears in: - CommonHTTPHealthCheck - HTTP2HealthCheck - HTTPHealthCheck - HTTPSHealthCheck - TCPHealthCheck
SessionAffinityConfigSessionAffinityConfig contains configuration for stickiness parameters.
Appears in: - GCPBackendPolicyConfig
Field Description Default Validationtype
string Type specifies the type of session affinity to use. If not specified, this
cookieTtlSec
integer CookieTTLSec specifies the lifetime of cookies in seconds. This setting
StatefulGeneratedCookieConfig defines cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name "GSSA" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy. GCP will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next.
Appears in: - GCPSessionAffinityPolicySpec - GCPSessionAffinitySpec
Field Description Default ValidationcookieTtlSeconds
integer The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the
TCPHealthCheck is the health check configuration of type TCP
Appears in: - HealthCheck
Field Description Default ValidationportSpecification
PortSpecificationType Specifies how port is selected for health checking, can be one of following values:
USE_FIXED_PORT: The port number in port is used for health checking.
If not specified, Protocol health check follows behavior specified in port and portName fields.
port
integer The TCP port number for the health check request. Valid values are 1 through 65535. Maximum: 65535
portName
string Port name as defined in InstanceGroup#NamedPort#name.
[a-z]([-a-z0-9]*[a-z0-9])?
request
string The application data to send once the TCP connection has been established. If not specified,
[\x00-\xFF]+
response
string The bytes to match against the beginning of the response data.
[\x00-\xFF]+
proxyHeader
ProxyHeaderType Specifies the type of proxy header to append before sending data to the backend,
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4