projectcontour.io / v1alpha1 / ExtensionService

• string

  .apiVersion

  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

• string

  .kind

  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

• object

  .metadata

• object

  .spec

  ExtensionServiceSpec defines the desired state of an ExtensionService resource.

• object

  .spec .circuitBreakerPolicy

  CircuitBreakerPolicy specifies the circuit breaker budget across the extension service. If defined this overrides the global circuit breaker budget.

• integer

  .spec .circuitBreakerPolicy .maxConnections

  The maximum number of connections that a single Envoy instance allows to the Kubernetes Service; defaults to 1024.

• integer

  .spec .circuitBreakerPolicy .maxPendingRequests

  The maximum number of pending requests that a single Envoy instance allows to the Kubernetes Service; defaults to 1024.

• integer

  .spec .circuitBreakerPolicy .maxRequests

  The maximum parallel requests a single Envoy instance allows to the Kubernetes Service; defaults to 1024

• integer

  .spec .circuitBreakerPolicy .maxRetries

  The maximum number of parallel retries a single Envoy instance allows to the Kubernetes Service; defaults to 3.

• integer

  .spec .circuitBreakerPolicy .perHostMaxConnections

  PerHostMaxConnections is the maximum number of connections that Envoy will allow to each individual host in a cluster.

• object

  .spec .loadBalancerPolicy

  The policy for load balancing GRPC service requests. Note that the Cookie and RequestHash load balancing strategies cannot be used here.

• array

  .spec .loadBalancerPolicy .requestHashPolicies

  RequestHashPolicies contains a list of hash policies to apply when the RequestHash load balancing strategy is chosen. If an element of the supplied list of hash policies is invalid, it will be ignored. If the list of hash policies is empty after validation, the load balancing strategy will fall back to the default RoundRobin.

• boolean

  .spec .loadBalancerPolicy .requestHashPolicies[] .hashSourceIP

  HashSourceIP should be set to true when request source IP hash based load balancing is desired. It must be the only hash option field set, otherwise this request hash policy object will be ignored.

• object

  .spec .loadBalancerPolicy .requestHashPolicies[] .headerHashOptions

  HeaderHashOptions should be set when request header hash based load balancing is desired. It must be the only hash option field set, otherwise this request hash policy object will be ignored.

• string required

  .spec .loadBalancerPolicy .requestHashPolicies[] .headerHashOptions .headerName

  HeaderName is the name of the HTTP request header that will be used to calculate the hash key. If the header specified is not present on a request, no hash will be produced.

• object

  .spec .loadBalancerPolicy .requestHashPolicies[] .queryParameterHashOptions

  QueryParameterHashOptions should be set when request query parameter hash based load balancing is desired. It must be the only hash option field set, otherwise this request hash policy object will be ignored.

• string required

  .spec .loadBalancerPolicy .requestHashPolicies[] .queryParameterHashOptions .parameterName

  ParameterName is the name of the HTTP request query parameter that will be used to calculate the hash key. If the query parameter specified is not present on a request, no hash will be produced.

• boolean

  .spec .loadBalancerPolicy .requestHashPolicies[] .terminal

  Terminal is a flag that allows for short-circuiting computing of a hash for a given request. If set to true, and the request attribute specified in the attribute hash options is present, no further hash policies will be used to calculate a hash for the request.

• string

  .spec .loadBalancerPolicy .strategy

  Strategy specifies the policy used to balance requests across the pool of backend pods. Valid policy names are Random, RoundRobin, WeightedLeastRequest, Cookie, and RequestHash. If an unknown strategy name is specified or no policy is supplied, the default RoundRobin policy is used.

• string

  .spec .protocol

  Protocol may be used to specify (or override) the protocol used to reach this Service. Values may be h2 or h2c. If omitted, protocol-selection falls back on Service annotations.

• string

  .spec .protocolVersion

  This field sets the version of the GRPC protocol that Envoy uses to send requests to the extension service. Since Contour always uses the v3 Envoy API, this is currently fixed at “v3”. However, other protocol options will be available in future.

• array required

  .spec .services

  Services specifies the set of Kubernetes Service resources that receive GRPC extension API requests. If no weights are specified for any of the entries in this array, traffic will be spread evenly across all the services. Otherwise, traffic is balanced proportionally to the Weight field in each entry.

• string required

  .spec .services[] .name

  Name is the name of Kubernetes service that will accept service traffic.

• integer required

  .spec .services[] .port

  Port (defined as Integer) to proxy traffic to since a service can have multiple defined.

• integer

  .spec .services[] .weight

  Weight defines proportion of traffic to balance to the Kubernetes Service.

• object

  .spec .timeoutPolicy

  The timeout policy for requests to the services.

• string

  .spec .timeoutPolicy .idle

  Timeout for how long the proxy should wait while there is no activity during single request/response (for HTTP/1.1) or stream (for HTTP/2). Timeout will not trigger while HTTP/1.1 connection is idle between two consecutive requests. If not specified, there is no per-route idle timeout, though a connection manager-wide stream_idle_timeout default of 5m still applies.

• string

  .spec .timeoutPolicy .idleConnection

  Timeout for how long connection from the proxy to the upstream service is kept when there are no active requests. If not supplied, Envoy’s default value of 1h applies.

• string

  .spec .timeoutPolicy .response

  Timeout for receiving a response from the server after processing a request from client. If not supplied, Envoy’s default value of 15s applies.

• object

  .spec .validation

  UpstreamValidation defines how to verify the backend service’s certificate

• string required

  .spec .validation .caSecret

  Name or namespaced name of the Kubernetes secret used to validate the certificate presented by the backend. The secret must contain key named ca.crt. The name can be optionally prefixed with namespace “namespace/name”. When cross-namespace reference is used, TLSCertificateDelegation resource must exist in the namespace to grant access to the secret. Max length should be the actual max possible length of a namespaced name (63 + 253 + 1 = 317)

• string required

  .spec .validation .subjectName

  Key which is expected to be present in the ‘subjectAltName’ of the presented certificate. Deprecated: migrate to using the plural field subjectNames.

• array

  .spec .validation .subjectNames

  List of keys, of which at least one is expected to be present in the ‘subjectAltName of the presented certificate.

• object

  .status

  ExtensionServiceStatus defines the observed state of an ExtensionService resource.

• array

  .status .conditions

  Conditions contains the current status of the ExtensionService resource. Contour will update a single condition, Valid, that is in normal-true polarity. Contour will not modify any other Conditions set in this block, in case some other controller wants to add a Condition.

• array

  .status .conditions[] .errors

  Errors contains a slice of relevant error subconditions for this object. Subconditions are expected to appear when relevant (when there is a error), and disappear when not relevant. An empty slice here indicates no errors.

• string required

  .status .conditions[] .errors[] .message

  Message is a human readable message indicating details about the transition. This may be an empty string.

• string required

  .status .conditions[] .errors[] .reason

  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.

• string required

  .status .conditions[] .errors[] .status

  Status of the condition, one of True, False, Unknown.

• string required

  .status .conditions[] .errors[] .type

  Type of condition in CamelCase or in foo.example.com/CamelCase. This must be in abnormal-true polarity, that is, ErrorFound or controller.io/ErrorFound. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

• string required

  .status .conditions[] .lastTransitionTime

  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.

• string required

  .status .conditions[] .message

  message is a human readable message indicating details about the transition. This may be an empty string.

• integer

  .status .conditions[] .observedGeneration

  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.

• string required

  .status .conditions[] .reason

  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.

• string required

  .status .conditions[] .status

  status of the condition, one of True, False, Unknown.

• string required

  .status .conditions[] .type

  type of condition in CamelCase or in foo.example.com/CamelCase.

• array

  .status .conditions[] .warnings

  Warnings contains a slice of relevant warning subconditions for this object. Subconditions are expected to appear when relevant (when there is a warning), and disappear when not relevant. An empty slice here indicates no warnings.

• string required

  .status .conditions[] .warnings[] .message

  Message is a human readable message indicating details about the transition. This may be an empty string.

• string required

  .status .conditions[] .warnings[] .reason

  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.

• string required

  .status .conditions[] .warnings[] .status

  Status of the condition, one of True, False, Unknown.

• string required

  .status .conditions[] .warnings[] .type

  Type of condition in CamelCase or in foo.example.com/CamelCase. This must be in abnormal-true polarity, that is, ErrorFound or controller.io/ErrorFound. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)