HTTPScaledObject
http.keda.sh / v1alpha1
apiVersion: http.keda.sh/v1alpha1
kind: HTTPScaledObject
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
HTTPScaledObjectSpec defines the desired state of HTTPScaledObject
coldStartTimeoutFailoverRef object
(optional) The name of the failover service to route HTTP requests to when the target is not available
port
integer
The port to route to
format:
int32
portName
string
The port to route to referenced by name
service
string required
The name of the service to route to
timeoutSeconds
integer
The timeout in seconds to wait before routing to the failover service (Default 30)
format:
int32headers []object
The custom headers used to route. Once Hosts and PathPrefixes have been matched,
it will look for requests which have headers that match all the headers defined
in .spec.headers, it will be routed to the Service and Port specified in
the scaleTargetRef. Interceptor will take precedence for most specific header match.
If the headers can't be matched, then use first one without .spec.headers supplied
If that doesn't exist then routing will fail.
name
string required
minLength:
1
value
string
hosts
[]string
The hosts to route. All requests which the "Host" header
matches any .spec.hosts (and the Request Target matches any
.spec.pathPrefixes) will be routed to the Service and Port specified in
the scaleTargetRef.
initialCooldownPeriod
integer
(optional) Initial period before scaling
format:
int32
pathPrefixes
[]string
The paths to route. All requests which the Request Target matches any
.spec.pathPrefixes (and the "Host" header matches any .spec.hosts)
will be routed to the Service and Port specified in
the scaleTargetRef.
replicas object
(optional) Replica information
max
integer
Maximum amount of replicas to have in the deployment (Default 100)
format:
int32
min
integer
Minimum amount of replicas to have in the deployment (Default 0)
format:
int32scaleTargetRef object required
The name of the deployment to route HTTP requests to (and to autoscale).
Including validation as a requirement to define either the PortName or the Port
apiVersion
string
kind
string
name
string
port
integer
The port to route to
format:
int32
portName
string
The port to route to referenced by name
service
string required
The name of the service to route to
scaledownPeriod
integer
(optional) Cooldown period value
format:
int32scalingMetric object
(optional) Configuration for the metric used for scaling
concurrency object
Scaling based on concurrent requests for a given target
targetValue
integer
Target value for rate scaling
requestRate object
Scaling based the average rate during an specific time window for a given target
granularity
string
Time granularity for rate calculation
targetValue
integer
Target value for rate scaling
window
string
Time window for rate calculation
targetPendingRequests
integer
(optional) DEPRECATED (use ScalingMetric instead) Target metric value
format:
int32timeouts object
(optional) Timeouts that override the global ones
conditionWait
string
How long to wait for the backing workload to have 1 or more replicas before connecting and sending the HTTP request (Default is set by the KEDA_CONDITION_WAIT_TIMEOUT environment variable)
responseHeader
string
How long to wait between when the HTTP request is sent to the backing app and when response headers need to arrive (Default is set by the KEDA_RESPONSE_HEADER_TIMEOUT environment variable)
status object
HTTPScaledObjectStatus defines the observed state of HTTPScaledObject
conditions []object
Conditions of the HTTPScaledObject.
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
targetService
string
TargetService reflects details about the scaled service.
targetWorkload
string
TargetWorkload reflects details about the scaled workload.
No matches. Try .spec.coldStartTimeoutFailoverRef for an exact path