HealthCheckPolicy

networking.gke.io / v1

apiVersion: networking.gke.io/v1 kind: HealthCheckPolicy 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 HealthCheckPolicy.

default object

Default defines default policy configuration for the targeted resource.

checkIntervalSec integer

How often (in seconds) to send a health check. If not specified, a default value of 5 seconds will be used.

format: int64

minimum: 1

maximum: 300

config object

Specifies the type of the healthCheck, either TCP, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check field must be specified, which must match type field. Config contains per protocol (i.e. HTTP, HTTPS, HTTP2, TCP, GRPC) configuration. If not specified, health check type defaults to HTTP.

grpcHealthCheck object

GRPC is the health check configuration of type GRPC.

grpcServiceName string

The gRPC service name for the health check. This field is optional. The value of grpcServiceName has the following meanings by convention: - Empty serviceName means the overall status of all services at the backend. - Non-empty serviceName means the health of that gRPC service, as defined by the owner of the service. The grpcServiceName can only be ASCII.

pattern: ^[\x00-\xFF]+$

maxLength: 1024

port integer

The TCP port number for the health check request. Valid values are 1 through 65535.

format: int64

minimum: 1

maximum: 65535

portName string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$

maxLength: 63

portSpecification string

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. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, Protocol health check follows behavior specified in port and portName fields. If neither Port nor PortName is specified, this defaults to USE_SERVING_PORT.

enum: USE_FIXED_PORT, USE_NAMED_PORT, USE_SERVING_PORT

http2HealthCheck object

HTTP2 is the health check configuration of type HTTP2.

host string

Host is the value of the host header in the HTTP health check request. This matches the RFC 1123 definition of a hostname with 1 notable exception that numeric IP addresses are not allowed. If not specified or left empty, the IP on behalf of which this health check is performed will be used.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 2048

port integer

The TCP port number for the health check request. Valid values are 1 through 65535.

format: int64

minimum: 1

maximum: 65535

portName string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$

maxLength: 63

portSpecification string

enum: USE_FIXED_PORT, USE_NAMED_PORT, USE_SERVING_PORT

proxyHeader string

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. If not specified, this defaults to NONE.

enum: NONE, PROXY_V1

requestPath string

The request path of the HTTP health check request. If not specified or left empty, a default value of "/" is used.

pattern: ^\/[A-Za-z0-9\/\-._~%!?$&'()*+,;=:]*$

maxLength: 2048

response string

The string to match anywhere in the first 1024 bytes of the response body. If not specified or left empty, the status code determines health. The response data can only be ASCII.

pattern: ^[\x00-\xFF]+$

maxLength: 1024

httpHealthCheck object

HTTP is the health check configuration of type HTTP.

host string

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 2048

port integer

The TCP port number for the health check request. Valid values are 1 through 65535.

format: int64

minimum: 1

maximum: 65535

portName string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$

maxLength: 63

portSpecification string

enum: USE_FIXED_PORT, USE_NAMED_PORT, USE_SERVING_PORT

proxyHeader string

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. If not specified, this defaults to NONE.

enum: NONE, PROXY_V1

requestPath string

The request path of the HTTP health check request. If not specified or left empty, a default value of "/" is used.

pattern: ^\/[A-Za-z0-9\/\-._~%!?$&'()*+,;=:]*$

maxLength: 2048

response string

The string to match anywhere in the first 1024 bytes of the response body. If not specified or left empty, the status code determines health. The response data can only be ASCII.

pattern: ^[\x00-\xFF]+$

maxLength: 1024

httpsHealthCheck object

HTTPS is the health check configuration of type HTTPS.

host string

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 2048

port integer

The TCP port number for the health check request. Valid values are 1 through 65535.

format: int64

minimum: 1

maximum: 65535

portName string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$

maxLength: 63

portSpecification string

enum: USE_FIXED_PORT, USE_NAMED_PORT, USE_SERVING_PORT

proxyHeader string

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. If not specified, this defaults to NONE.

enum: NONE, PROXY_V1

requestPath string

The request path of the HTTP health check request. If not specified or left empty, a default value of "/" is used.

pattern: ^\/[A-Za-z0-9\/\-._~%!?$&'()*+,;=:]*$

maxLength: 2048

response string

The string to match anywhere in the first 1024 bytes of the response body. If not specified or left empty, the status code determines health. The response data can only be ASCII.

pattern: ^[\x00-\xFF]+$

maxLength: 1024

tcpHealthCheck object

TCP is the health check configuration of type TCP.

port integer

The TCP port number for the health check request. Valid values are 1 through 65535.

format: int64

minimum: 1

maximum: 65535

portName string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$

maxLength: 63

portSpecification string

enum: USE_FIXED_PORT, USE_NAMED_PORT, USE_SERVING_PORT

proxyHeader string

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. If not specified, this defaults to NONE.

enum: NONE, PROXY_V1

request string

The application data to send once the TCP connection has been established. If not specified, this defaults to empty. If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

pattern: ^[\x00-\xFF]+$

maxLength: 1024

response string

The bytes to match against the beginning of the response data. If not specified or left empty, any response will indicate health. The response data can only be ASCII.

pattern: ^[\x00-\xFF]+$

maxLength: 1024

type string required

Specifies the type of the healthCheck, either TCP, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check field must be specified, which must match type field.

enum: TCP, HTTP, HTTPS, HTTP2, GRPC

healthyThreshold integer

A so-far unhealthy instance will be marked healthy after this many consecutive successes. If not specified, a default value of 2 will be used.

format: int64

minimum: 1

maximum: 10

logConfig object

LogConfig configures logging on this health check.

enabled boolean

Enabled indicates whether or not to export health check logs. If not specified, this defaults to false, which means health check logging will be disabled.

timeoutSec integer

How long (in seconds) to wait before claiming failure. If not specified, a default value of 5 seconds will be used. It is invalid for timeoutSec to have greater value than checkIntervalSec.

format: int64

minimum: 1

maximum: 300

unhealthyThreshold integer

A so-far healthy instance will be marked unhealthy after this many consecutive failures. If not specified, a default value of 2 will be used.

format: int64

minimum: 1

maximum: 10

targetRef 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: 1

maxLength: 63

name string required

Name is the name of the target resource.

minLength: 1

maxLength: 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: 1

maxLength: 63

status object

Status defines the current state of HealthCheckPolicy.

conditions []object

Conditions describe the current conditions of the HealthCheckPolicy.

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: int64

minimum: 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: 1

maxLength: 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. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

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

No matches. Try .spec.default for an exact path