KongUpstreamPolicy
configuration.konghq.com / v1beta1
apiVersion: configuration.konghq.com/v1beta1
kind: KongUpstreamPolicy
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
Spec contains the configuration of the Kong upstream.
algorithm
string
Algorithm is the load balancing algorithm to use.
Accepted values are: "round-robin", "consistent-hashing", "least-connections", "latency".
enum:
round-robin, consistent-hashing, least-connections, latencyhashOn object
HashOn defines how to calculate hash for consistent-hashing load balancing algorithm.
Algorithm must be set to "consistent-hashing" for this field to have effect.
cookie
string
Cookie is the name of the cookie to use as hash input.
cookiePath
string
CookiePath is cookie path to set in the response headers.
header
string
Header is the name of the header to use as hash input.
input
string
Input allows using one of the predefined inputs (ip, consumer, path).
For other parametrized inputs, use one of the fields below.
enum:
ip, consumer, path
queryArg
string
QueryArg is the name of the query argument to use as hash input.
uriCapture
string
URICapture is the name of the URI capture group to use as hash input.
hashOnFallback object
HashOnFallback defines how to calculate hash for consistent-hashing load balancing algorithm if the primary hash
function fails.
Algorithm must be set to "consistent-hashing" for this field to have effect.
cookie
string
Cookie is the name of the cookie to use as hash input.
cookiePath
string
CookiePath is cookie path to set in the response headers.
header
string
Header is the name of the header to use as hash input.
input
string
Input allows using one of the predefined inputs (ip, consumer, path).
For other parametrized inputs, use one of the fields below.
enum:
ip, consumer, path
queryArg
string
QueryArg is the name of the query argument to use as hash input.
uriCapture
string
URICapture is the name of the URI capture group to use as hash input.
healthchecks object
Healthchecks defines the health check configurations in Kong.
active object
Active configures active health check probing.
concurrency
integer
Concurrency is the number of targets to check concurrently.
minimum:
1
headers
object
Headers is a list of HTTP headers to add to the probe request.
healthy object
Healthy configures thresholds and HTTP status codes to mark targets healthy for an upstream.
httpStatuses
[]integer
HTTPStatuses is a list of HTTP status codes that Kong considers a success.
interval
integer
Interval is the interval between active health checks for an upstream in seconds when in a healthy state.
minimum:
0
successes
integer
Successes is the number of successes to consider a target healthy.
minimum:
0
httpPath
string
HTTPPath is the path to use in GET HTTP request to run as a probe.
pattern:
^/.*$
httpsSni
string
HTTPSSNI is the SNI to use in GET HTTPS request to run as a probe.
httpsVerifyCertificate
boolean
HTTPSVerifyCertificate is a boolean value that indicates if the certificate should be verified.
timeout
integer
Timeout is the probe timeout in seconds.
minimum:
0
type
string
Type determines whether to perform active health checks using HTTP or HTTPS, or just attempt a TCP connection.
Accepted values are "http", "https", "tcp", "grpc", "grpcs".
enum:
http, https, tcp, grpc, grpcsunhealthy object
Unhealthy configures thresholds and HTTP status codes to mark targets unhealthy for an upstream.
httpFailures
integer
HTTPFailures is the number of failures to consider a target unhealthy.
minimum:
0
httpStatuses
[]integer
HTTPStatuses is a list of HTTP status codes that Kong considers a failure.
interval
integer
Interval is the interval between active health checks for an upstream in seconds when in an unhealthy state.
minimum:
0
tcpFailures
integer
TCPFailures is the number of TCP failures in a row to consider a target unhealthy.
minimum:
0
timeouts
integer
Timeouts is the number of timeouts in a row to consider a target unhealthy.
minimum:
0passive object
Passive configures passive health check probing.
healthy object
Healthy configures thresholds and HTTP status codes to mark targets healthy for an upstream.
httpStatuses
[]integer
HTTPStatuses is a list of HTTP status codes that Kong considers a success.
interval
integer
Interval is the interval between active health checks for an upstream in seconds when in a healthy state.
minimum:
0
successes
integer
Successes is the number of successes to consider a target healthy.
minimum:
0
type
string
Type determines whether to perform passive health checks interpreting HTTP/HTTPS statuses,
or just check for TCP connection success.
Accepted values are "http", "https", "tcp", "grpc", "grpcs".
enum:
http, https, tcp, grpc, grpcsunhealthy object
Unhealthy configures thresholds and HTTP status codes to mark targets unhealthy.
httpFailures
integer
HTTPFailures is the number of failures to consider a target unhealthy.
minimum:
0
httpStatuses
[]integer
HTTPStatuses is a list of HTTP status codes that Kong considers a failure.
interval
integer
Interval is the interval between active health checks for an upstream in seconds when in an unhealthy state.
minimum:
0
tcpFailures
integer
TCPFailures is the number of TCP failures in a row to consider a target unhealthy.
minimum:
0
timeouts
integer
Timeouts is the number of timeouts in a row to consider a target unhealthy.
minimum:
0
threshold
integer
Threshold is the minimum percentage of the upstream’s targets’ weight that must be available for the whole
upstream to be considered healthy.
slots
integer
Slots is the number of slots in the load balancer algorithm.
If not set, the default value in Kong for the algorithm is used.
minimum:
10maximum:
65536status object
Status defines the current state of KongUpstreamPolicy
ancestors []object required
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. When this policy attaches to a parent, the controller that
manages the parent and the ancestors MUST add an entry to this list when
the controller first sees the policy and SHOULD update the entry as
appropriate when the relevant ancestor is modified.
Note that choosing the relevant ancestor is left to the Policy designers;
an important part of Policy design is designing the right object level at
which to namespace this status.
Note also that implementations MUST ONLY populate ancestor status for
the Ancestor resources they are responsible for. Implementations MUST
use the ControllerName field to uniquely identify the entries in this list
that they are responsible for.
Note that to achieve this, the list of PolicyAncestorStatus structs
MUST be treated as a map with a composite key, made up of the AncestorRef
and ControllerName fields combined.
A maximum of 16 ancestors will be represented in this list. An empty list
means the Policy is not relevant for any ancestors.
If this slice is full, implementations MUST NOT add further entries.
Instead they MUST consider the policy unimplementable and signal that
on any related resources such as the ancestor that would be referenced
here. For example, if this list was full on BackendTLSPolicy, no
additional Gateways would be able to reference the Service targeted by
the BackendTLSPolicy.
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:
253No matches. Try .spec.algorithm for an exact path