KongIngress
configuration.konghq.com / v1
apiVersion: configuration.konghq.com/v1
kind: KongIngress
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
proxy object
Proxy defines additional connection options for the routes to be configured in the
Kong Gateway, e.g. `connection_timeout`, `retries`, etc.
connect_timeout
integer
The timeout in milliseconds for establishing a connection to the upstream server.
Deprecated: use Service's "konghq.com/connect-timeout" annotation instead.
minimum:
0
path
string
(optional) The path to be used in requests to the upstream server.
Deprecated: use Service's "konghq.com/path" annotation instead.
pattern:
^/.*$
protocol
string
The protocol used to communicate with the upstream.
Deprecated: use Service's "konghq.com/protocol" annotation instead.
enum:
http, https, grpc, grpcs, tcp, tls, udp
read_timeout
integer
The timeout in milliseconds between two successive read operations
for transmitting a request to the upstream server.
Deprecated: use Service's "konghq.com/read-timeout" annotation instead.
minimum:
0
retries
integer
The number of retries to execute upon failure to proxy.
Deprecated: use Service's "konghq.com/retries" annotation instead.
minimum:
0
write_timeout
integer
The timeout in milliseconds between two successive write operations
for transmitting a request to the upstream server.
Deprecated: use Service's "konghq.com/write-timeout" annotation instead.
minimum:
0route object
Route define rules to match client requests.
Each Route is associated with a Service,
and a Service may have multiple Routes associated to it.
headers
object
Headers contains one or more lists of values indexed by header name
that will cause this Route to match if present in the request.
The Host header cannot be used with this attribute.
Deprecated: use Ingress' "konghq.com/headers" annotation instead.
https_redirect_status_code
integer
HTTPSRedirectStatusCode is the status code Kong responds with
when all properties of a Route match except the protocol.
Deprecated: use Ingress' "ingress.kubernetes.io/force-ssl-redirect" or
"konghq.com/https-redirect-status-code" annotations instead.
methods
[]string
Methods is a list of HTTP methods that match this Route.
Deprecated: use Ingress' "konghq.com/methods" annotation instead.
path_handling
string
PathHandling controls how the Service path, Route path and requested path
are combined when sending a request to the upstream.
Deprecated: use Ingress' "konghq.com/path-handling" annotation instead.
enum:
v0, v1
preserve_host
boolean
PreserveHost sets When matching a Route via one of the hosts domain names,
use the request Host header in the upstream request headers.
If set to false, the upstream Host header will be that of the Service’s host.
Deprecated: use Ingress' "konghq.com/preserve-host" annotation instead.
protocols
[]string
Protocols is an array of the protocols this Route should allow.
Deprecated: use Ingress' "konghq.com/protocols" annotation instead.
regex_priority
integer
RegexPriority is a number used to choose which route resolves a given request
when several routes match it using regexes simultaneously.
Deprecated: use Ingress' "konghq.com/regex-priority" annotation instead.
request_buffering
boolean
RequestBuffering sets whether to enable request body buffering or not.
Deprecated: use Ingress' "konghq.com/request-buffering" annotation instead.
response_buffering
boolean
ResponseBuffering sets whether to enable response body buffering or not.
Deprecated: use Ingress' "konghq.com/response-buffering" annotation instead.
snis
[]string
SNIs is a list of SNIs that match this Route when using stream routing.
Deprecated: use Ingress' "konghq.com/snis" annotation instead.
strip_path
boolean
StripPath sets When matching a Route via one of the paths
strip the matching prefix from the upstream request URL.
Deprecated: use Ingress' "konghq.com/strip-path" annotation instead.
upstream object
Upstream represents a virtual hostname and can be used to loadbalance
incoming requests over multiple targets (e.g. Kubernetes `Services` can
be a target, OR `Endpoints` can be targets).
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, latency
hash_fallback
string
HashFallback defines What to use as hashing input
if the primary hash_on does not return a hash.
Accepted values are: "none", "consumer", "ip", "header", "cookie".
hash_fallback_header
string
HashFallbackHeader is the header name to take the value from as hash input.
Only required when "hash_fallback" is set to "header".
hash_fallback_query_arg
string
HashFallbackQueryArg is the "hash_fallback" version of HashOnQueryArg.
hash_fallback_uri_capture
string
HashFallbackURICapture is the "hash_fallback" version of HashOnURICapture.
hash_on
string
HashOn defines what to use as hashing input.
Accepted values are: "none", "consumer", "ip", "header", "cookie", "path", "query_arg", "uri_capture".
hash_on_cookie
string
The cookie name to take the value from as hash input.
Only required when "hash_on" or "hash_fallback" is set to "cookie".
hash_on_cookie_path
string
The cookie path to set in the response headers.
Only required when "hash_on" or "hash_fallback" is set to "cookie".
hash_on_header
string
HashOnHeader defines the header name to take the value from as hash input.
Only required when "hash_on" is set to "header".
hash_on_query_arg
string
HashOnQueryArg is the query string parameter whose value is the hash input when "hash_on" is set to "query_arg".
hash_on_uri_capture
string
HashOnURICapture is the name of the capture group whose value is the hash input when "hash_on" is set to
"uri_capture".
healthchecks object
Healthchecks defines the health check configurations in Kong.
active object
ActiveHealthcheck configures active health check probing.
concurrency
integer
minimum:
1
headers
object
healthy object
Healthy configures thresholds and HTTP status codes
to mark targets healthy for an upstream.
http_statuses
[]integer
interval
integer
minimum:
0
successes
integer
minimum:
0
http_path
string
pattern:
^/.*$
https_sni
string
https_verify_certificate
boolean
timeout
integer
minimum:
0
type
string
unhealthy object
Unhealthy configures thresholds and HTTP status codes
to mark targets unhealthy.
http_failures
integer
minimum:
0
http_statuses
[]integer
interval
integer
minimum:
0
tcp_failures
integer
minimum:
0
timeouts
integer
minimum:
0passive object
PassiveHealthcheck configures passive checks around
passive health checks.
healthy object
Healthy configures thresholds and HTTP status codes
to mark targets healthy for an upstream.
http_statuses
[]integer
interval
integer
minimum:
0
successes
integer
minimum:
0
type
string
unhealthy object
Unhealthy configures thresholds and HTTP status codes
to mark targets unhealthy.
http_failures
integer
minimum:
0
http_statuses
[]integer
interval
integer
minimum:
0
tcp_failures
integer
minimum:
0
timeouts
integer
minimum:
0
threshold
number
host_header
string
HostHeader is The hostname to be used as Host header
when proxying requests through Kong.
slots
integer
Slots is the number of slots in the load balancer algorithm.
minimum:
10No matches. Try .proxy.connect_timeout for an exact path