This is a hostname like name that can be referenced in an upstream_url
field of an api
or the host
of a service.
Optionally add tags to the Upstream
What to use as hashing input: none
, consumer
, ip
, header
or cookie
(defaults to none
resulting in a weighted-round-robin scheme).
What to use as hashing input if the primary hash_on
does not return a hash (eg. header is missing, or no consumer identified)
The header name to take the value from as hash input. Only required when hash_on
is set to header
.
The header name to take the value from as hash input. Only required when hash_fallback
is set to header
.
The cookie name to take the value from as hash input.
Only required when hash_on
or hash_fallback
is set to cookie
.
If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
The cookie path to set in the response headers.
Only required when hash_on
or hash_fallback
is set to cookie. Defaults to "/"
.
The number of slots in the loadbalancer algorithm (10-65536
, defaults to 1000
).
A list of sequential, but randomly ordered, integer numbers that determine the distribution of the slots in the balancer. If omitted it will be generated. If given, it must have exactly slots
number of entries.
Whether to check the validity of the SSL certificate of the remote host
when performing active health checks using HTTPS.
Defaults to true
.
Tip: Press Enter
to accept a value.
An array of HTTP statuses to consider a failure, indicating unhealthiness, when returned by a probe in active health checks.
Defaults to [429, 404, 500, 501, 502, 503, 504, 505]
Number of TCP failures in active probes to consider a target unhealthy.
Number of timeouts in active probes to consider a target unhealthy.
Number of HTTP failures in active probes (as defined by healthchecks.active.unhealthy.http_statuses
) to consider a target
unhealthy.
Interval between active health checks for unhealthy targets (in seconds). A value of zero indicates that active probes for healthy targets should not be performed.
The path that should be used when issuing the HTTP GET request to the target. The default value is /
.
The connection timeout limit for the HTTP GET request of the probe. The default value is 1 second.
Tip: Press Enter
to accept a value.
An array of HTTP statuses to consider a success, indicating healthiness, when returned by a probe in active health checks.
Defaults to [200, 302]
.
Interval between active health checks for healthy targets (in seconds). A value of zero indicates that active probes for healthy targets should not be performed.
Number of successes in active probes (as defined by healthchecks.active.healthy.http_statuses
) to consider a target healthy.
The hostname to use as an SNI (Server Name Identification) when performing active health checks using HTTPS. This is particularly useful when Targets are configured using IPs, so that the target host’s certificate can be verified with the proper SNI.
Number of targets to check concurrently in active health checks.
Whether to perform active health checks using HTTP
or HTTPS
, or just attempt a TCP
connection.
Possible values are tcp, http or https. Defaults to "http".
Number of HTTP failures in passive probes (as defined by healthchecks.passive.unhealthy.http_statuses
)
to consider a target unhealthy, as observed by passive health checks.
Tip: Press Enter
to accept a value.
An array of HTTP statuses which represent unhealthiness when produced by proxied traffic, as observed by passive health checks.
Number of TCP failures in passive probes to consider a target unhealthy.
Number of timeouts in proxied traffic to consider a target unhealthy, as observed by passive health checks.
Whether to perform passive health checks using HTTP
or HTTPS
, or just attempt a TCP
connection.
Possible values are tcp, http or https. Defaults to "http".
Number of successes in passive probes (as defined by healthchecks.passive.healthy.http_statuses
) to consider a target healthy.
Tip: Press Enter
to accept a value.
An array of HTTP statuses which represent healthiness when produced by proxied traffic, as observed by passive health checks.