|
| 1 | +# The `HTTPScaledObject` |
| 2 | + |
| 3 | +>This document reflects the specification of the `HTTPScaledObject` resource for the `v0.10.0` version. |
| 4 | +
|
| 5 | +Each `HTTPScaledObject` looks approximately like the below: |
| 6 | + |
| 7 | +```yaml |
| 8 | +kind: HTTPScaledObject |
| 9 | +apiVersion: http.keda.sh/v1alpha1 |
| 10 | +metadata: |
| 11 | + name: xkcd |
| 12 | + annotations: |
| 13 | + httpscaledobject.keda.sh/skip-scaledobject-creation: "false" |
| 14 | +spec: |
| 15 | + hosts: |
| 16 | + - myhost.com |
| 17 | + pathPrefixes: |
| 18 | + - /test |
| 19 | + scaleTargetRef: |
| 20 | + name: xkcd |
| 21 | + kind: Deployment |
| 22 | + apiVersion: apps/v1 |
| 23 | + service: xkcd |
| 24 | + port: 8080 |
| 25 | + replicas: |
| 26 | + min: 5 |
| 27 | + max: 10 |
| 28 | + scaledownPeriod: 300 |
| 29 | + scalingMetric: # requestRate and concurrency are mutually exclusive |
| 30 | + requestRate: |
| 31 | + granularity: 1s |
| 32 | + targetValue: 100 |
| 33 | + window: 1m |
| 34 | + concurrency: |
| 35 | + targetValue: 100 |
| 36 | +``` |
| 37 | +
|
| 38 | +This document is a narrated reference guide for the `HTTPScaledObject`. |
| 39 | + |
| 40 | +## `httpscaledobject.keda.sh/skip-scaledobject-creation` annotation |
| 41 | + |
| 42 | +This annotation will disable the ScaledObject generation and management but keeping the routing and metrics available. This is done removing the current ScaledObject if it has been already created, allowing to use user managed ScaledObjects pointing the add-on scaler directly (supporting all the ScaledObject configurations and multiple triggers). You can read more about this [here](./../../walkthrough.md#integrating-http-add-on-scaler-with-other-keda-scalers) |
| 43 | + |
| 44 | + |
| 45 | +## `hosts` |
| 46 | + |
| 47 | +These are the hosts to apply this scaling rule to. All incoming requests with one of these values in their `Host` header will be forwarded to the `Service` and port specified in the below `scaleTargetRef`, and that same `scaleTargetRef`'s workload will be scaled accordingly. |
| 48 | + |
| 49 | +## `pathPrefixes` |
| 50 | + |
| 51 | +>Default: "/" |
| 52 | + |
| 53 | +These are the paths to apply this scaling rule to. All incoming requests with one of these values as path prefix will be forwarded to the `Service` and port specified in the below `scaleTargetRef`, and that same `scaleTargetRef`'s workload will be scaled accordingly. |
| 54 | + |
| 55 | +## `scaleTargetRef` |
| 56 | + |
| 57 | +This is the primary and most important part of the `spec` because it describes: |
| 58 | + |
| 59 | +1. The incoming host to apply this scaling rule to. |
| 60 | +2. What workload to scale. |
| 61 | +3. The service to which to route HTTP traffic. |
| 62 | + |
| 63 | +### `name` |
| 64 | + |
| 65 | +This is the name of the workload to scale. It must exist in the same namespace as this `HTTPScaledObject` and shouldn't be managed by any other autoscaling system. This means that there should not be any `ScaledObject` already created for this workload. The HTTP Add-on will manage a `ScaledObject` internally. |
| 66 | + |
| 67 | +### `kind` |
| 68 | + |
| 69 | +This is the kind of the workload to scale. |
| 70 | + |
| 71 | +### `apiVersion` |
| 72 | + |
| 73 | +This is the apiVersion of the workload to scale. |
| 74 | + |
| 75 | +### `service` |
| 76 | + |
| 77 | +This is the name of the service to route traffic to. The add-on will create autoscaling and routing components that route to this `Service`. It must exist in the same namespace as this `HTTPScaledObject` and should route to the same `Deployment` as you entered in the `deployment` field. |
| 78 | + |
| 79 | +### `port` |
| 80 | + |
| 81 | +This is the port to route to on the service that you specified in the `service` field. It should be exposed on the service and should route to a valid `containerPort` on the workload you gave. |
| 82 | + |
| 83 | +### `portName` |
| 84 | + |
| 85 | +Alternatively, the port can be referenced using it's `name` as defined in the `Service`. |
| 86 | + |
| 87 | +### `scaledownPeriod` |
| 88 | + |
| 89 | +>Default: 300 |
| 90 | + |
| 91 | +The period to wait after the last reported active before scaling the resource back to 0. |
| 92 | + |
| 93 | +> Note: This time is measured on KEDA side based on in-flight requests, so workloads with few and random traffic could have unexpected scale to 0 cases. In those case we recommend to extend this period to ensure it doesn't happen. |
| 94 | + |
| 95 | + |
| 96 | +## `scalingMetric` |
| 97 | + |
| 98 | +This is the second most important part of the `spec` because it describes how the workload has to scale. This section contains 2 nested sections (`requestRate` and `concurrency`) which are mutually exclusive between themselves. |
| 99 | + |
| 100 | +### `requestRate` |
| 101 | + |
| 102 | +This section enables scaling based on the request rate. |
| 103 | + |
| 104 | +> **NOTE**: Requests information is stored in memory, aggragating long periods (longer than 5 minutes) or too fine granularity (less than 1 second) could produce perfomance issues or memory usage increase. |
| 105 | + |
| 106 | +> **NOTE 2**: Although updating `window` and/or `granularity` is something doable, the process just replaces all the stored request count infomation. This can produce unexpected scaling behaviours until the window is populated again. |
| 107 | + |
| 108 | +#### `targetValue` |
| 109 | + |
| 110 | +>Default: 100 |
| 111 | + |
| 112 | +This is the target value for the scaling configuration. |
| 113 | + |
| 114 | +#### `window` |
| 115 | + |
| 116 | +>Default: "1m" |
| 117 | + |
| 118 | +This value defines the aggregation window for the request rate calculation. |
| 119 | + |
| 120 | +#### `granularity` |
| 121 | + |
| 122 | +>Default: "1s" |
| 123 | + |
| 124 | +This value defines the granualarity of the aggregated requests for the request rate calculation. |
| 125 | + |
| 126 | +### `concurrency` |
| 127 | + |
| 128 | +This section enables scaling based on the request concurrency. |
| 129 | + |
| 130 | +> **NOTE**: This is the only scaling behaviour before v0.8.0 |
| 131 | + |
| 132 | +#### `targetValue` |
| 133 | + |
| 134 | +>Default: 100 |
| 135 | + |
| 136 | +This is the target value for the scaling configuration. |
0 commit comments