Prepare release 0.9.0 (#1226)
Signed-off-by: Jorge Turrado <jorge_turrado@hotmail.es>
This commit is contained in:
Jorge Turrado Ferrero
GitHub
parent
4bfcd9fc6d
commit
87e713c8e7
|
|
@ -52,12 +52,9 @@ body:
|
|||
label: "HTTP Add-on Version"
|
||||
description: "What version of the KEDA HTTP Add-on are you running?"
|
||||
options:
|
||||
- "0.9.0"
|
||||
- "0.8.0"
|
||||
- "0.7.0"
|
||||
- "0.6.0"
|
||||
- "0.5.0"
|
||||
- "0.4.0"
|
||||
- "0.3.0"
|
||||
- "Other"
|
||||
validations:
|
||||
required: false
|
||||
|
|
|
|||
30
CHANGELOG.md
30
CHANGELOG.md
|
|
@ -10,6 +10,7 @@ This changelog keeps track of work items that have been completed and are ready
|
|||
## History
|
||||
|
||||
- [Unreleased](#unreleased)
|
||||
- [v0.9.0](#v090)
|
||||
- [v0.8.0](#v080)
|
||||
- [v0.7.0](#v070)
|
||||
- [v0.6.0](#v060)
|
||||
|
|
@ -19,24 +20,18 @@ This changelog keeps track of work items that have been completed and are ready
|
|||
|
||||
### Breaking Changes
|
||||
|
||||
- **General**: Drop support for deprecated field `spec.scaleTargetRef.deployment` ([#1061](https://github.com/kedacore/http-add-on/issues/1061))
|
||||
- **General**: TODO ([#TODO](https://github.com/kedacore/http-add-on/issues/TODO))
|
||||
|
||||
### New
|
||||
|
||||
- **General**: Support portName in HTTPScaledObject service scaleTargetRef ([#1174](https://github.com/kedacore/http-add-on/issues/1174))
|
||||
- **General**: Support setting multiple TLS certs for different domains on the interceptor proxy ([#1116](https://github.com/kedacore/http-add-on/issues/1116))
|
||||
- **General**: TODO ([#TODO](https://github.com/kedacore/http-add-on/issues/TODO))
|
||||
|
||||
- **Interceptor**: Add support for for AWS ELB healthcheck probe ([#1198](https://github.com/kedacore/http-add-on/issues/1198))
|
||||
|
||||
### Improvements
|
||||
|
||||
- **General**: TODO ([#TODO](https://github.com/kedacore/http-add-on/issues/TODO))
|
||||
|
||||
### Fixes
|
||||
|
||||
- **General**: Align the interceptor metrics env var configuration with the OTEL spec ([#1031](https://github.com/kedacore/http-add-on/issues/1031))
|
||||
- **General**: Include trailing 0 window buckets in RPS calculation ([#1075](https://github.com/kedacore/http-add-on/issues/1075))
|
||||
- **General**: TODO ([#TODO](https://github.com/kedacore/http-add-on/issues/TODO))
|
||||
|
||||
### Deprecations
|
||||
|
|
@ -45,6 +40,27 @@ This changelog keeps track of work items that have been completed and are ready
|
|||
|
||||
### Other
|
||||
|
||||
- **General**: TODO ([#TODO](https://github.com/kedacore/http-add-on/issues/TODO))
|
||||
|
||||
## v0.9.0
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- **General**: Drop support for deprecated field `spec.scaleTargetRef.deployment` ([#1061](https://github.com/kedacore/http-add-on/issues/1061))
|
||||
|
||||
### New
|
||||
|
||||
- **General**: Support portName in HTTPScaledObject service scaleTargetRef ([#1174](https://github.com/kedacore/http-add-on/issues/1174))
|
||||
- **General**: Support setting multiple TLS certs for different domains on the interceptor proxy ([#1116](https://github.com/kedacore/http-add-on/issues/1116))
|
||||
- **Interceptor**: Add support for for AWS ELB healthcheck probe ([#1198](https://github.com/kedacore/http-add-on/issues/1198))
|
||||
|
||||
### Fixes
|
||||
|
||||
- **General**: Align the interceptor metrics env var configuration with the OTEL spec ([#1031](https://github.com/kedacore/http-add-on/issues/1031))
|
||||
- **General**: Include trailing 0 window buckets in RPS calculation ([#1075](https://github.com/kedacore/http-add-on/issues/1075))
|
||||
|
||||
### Other
|
||||
|
||||
- **General**: Sign images with Cosign ([#1062](https://github.com/kedacore/http-add-on/issues/1062))
|
||||
|
||||
## v0.8.0
|
||||
|
|
|
|||
|
|
@ -89,7 +89,7 @@ K9s integrates Hey, a CLI tool to benchmark HTTP endpoints similar to AB bench.
|
|||
```
|
||||
- You'll need to clone the repository to get access to this chart. If you have your own Deployment and Service installed, you can go right to creating an HTTPScaledObject. We use the provided sample HTTPScaledObject -
|
||||
```
|
||||
$ kubectl create -n $NAMESPACE -f examples/v0.3.0/httpscaledobject.yaml
|
||||
$ kubectl apply -n $NAMESPACE -f examples/v0.9.0/httpscaledobject.yaml
|
||||
```
|
||||
- Testing Your Installation using k9s:
|
||||
```
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ Add the new released version to the list in `KEDA Version` dropdown in [2_bug_re
|
|||
Update the links to current version within the file `walkthrough.md`
|
||||
|
||||
> ```console
|
||||
> kubectl create -n $NAMESPACE -f examples/v0.7.0/httpscaledobject.yaml
|
||||
> kubectl apply -n $NAMESPACE -f examples/v0.9.0/httpscaledobject.yaml
|
||||
> ```
|
||||
|
||||
> >If you'd like to learn more about this object, please see the [`HTTPScaledObject` reference](THE REFERENCE).
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# The `HTTPScaledObject`
|
||||
|
||||
>This document reflects the specification of the `HTTPScaledObject` resource for the `v0.8.1` version.
|
||||
>This document reflects the specification of the `HTTPScaledObject` resource for the `v0.9.0` version.
|
||||
|
||||
Each `HTTPScaledObject` looks approximately like the below:
|
||||
|
||||
|
|
@ -60,10 +60,6 @@ This is the primary and most important part of the `spec` because it describes:
|
|||
2. What workload to scale.
|
||||
3. The service to which to route HTTP traffic.
|
||||
|
||||
### `deployment` (DEPRECTATED: removed as part of v0.9.0)
|
||||
|
||||
This is the name of the `Deployment` 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 `Deployment`. The HTTP Add-on will manage a `ScaledObject` internally.
|
||||
|
||||
### `name`
|
||||
|
||||
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.
|
||||
|
|
@ -82,20 +78,12 @@ This is the name of the service to route traffic to. The add-on will create auto
|
|||
|
||||
### `port`
|
||||
|
||||
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 `Deployment` you gave in the `deployment` field.
|
||||
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.
|
||||
|
||||
### `portName`
|
||||
|
||||
Alternatively, the port can be referenced using it's `name` as defined in the `Service`.
|
||||
|
||||
### `targetPendingRequests` (DEPRECTATED: removed as part of v0.9.0)
|
||||
|
||||
>Default: 100
|
||||
|
||||
This is the number of _pending_ (or in-progress) requests that your application needs to have before the HTTP Add-on will scale it. Conversely, if your application has below this number of pending requests, the HTTP add-on will scale it down.
|
||||
|
||||
For example, if you set this field to 100, the HTTP Add-on will scale your app up if it sees that there are 200 in-progress requests. On the other hand, it will scale down if it sees that there are only 20 in-progress requests. Note that it will _never_ scale your app to zero replicas unless there are _no_ requests in-progress. Even if you set this value to a very high number and only have a single in-progress request, your app will still have one replica.
|
||||
|
||||
### `scaledownPeriod`
|
||||
|
||||
>Default: 300
|
||||
|
|
@ -0,0 +1,136 @@
|
|||
# The `HTTPScaledObject`
|
||||
|
||||
>This document reflects the specification of the `HTTPScaledObject` resource for the `vX.X.X` version.
|
||||
|
||||
Each `HTTPScaledObject` looks approximately like the below:
|
||||
|
||||
```yaml
|
||||
kind: HTTPScaledObject
|
||||
apiVersion: http.keda.sh/v1alpha1
|
||||
metadata:
|
||||
name: xkcd
|
||||
annotations:
|
||||
httpscaledobject.keda.sh/skip-scaledobject-creation: "false"
|
||||
spec:
|
||||
hosts:
|
||||
- myhost.com
|
||||
pathPrefixes:
|
||||
- /test
|
||||
scaleTargetRef:
|
||||
name: xkcd
|
||||
kind: Deployment
|
||||
apiVersion: apps/v1
|
||||
service: xkcd
|
||||
port: 8080
|
||||
replicas:
|
||||
min: 5
|
||||
max: 10
|
||||
scaledownPeriod: 300
|
||||
scalingMetric: # requestRate and concurrency are mutually exclusive
|
||||
requestRate:
|
||||
granularity: 1s
|
||||
targetValue: 100
|
||||
window: 1m
|
||||
concurrency:
|
||||
targetValue: 100
|
||||
```
|
||||
|
||||
This document is a narrated reference guide for the `HTTPScaledObject`.
|
||||
|
||||
## `httpscaledobject.keda.sh/skip-scaledobject-creation` annotation
|
||||
|
||||
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)
|
||||
|
||||
|
||||
## `hosts`
|
||||
|
||||
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.
|
||||
|
||||
## `pathPrefixes`
|
||||
|
||||
>Default: "/"
|
||||
|
||||
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.
|
||||
|
||||
## `scaleTargetRef`
|
||||
|
||||
This is the primary and most important part of the `spec` because it describes:
|
||||
|
||||
1. The incoming host to apply this scaling rule to.
|
||||
2. What workload to scale.
|
||||
3. The service to which to route HTTP traffic.
|
||||
|
||||
### `name`
|
||||
|
||||
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.
|
||||
|
||||
### `kind`
|
||||
|
||||
This is the kind of the workload to scale.
|
||||
|
||||
### `apiVersion`
|
||||
|
||||
This is the apiVersion of the workload to scale.
|
||||
|
||||
### `service`
|
||||
|
||||
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.
|
||||
|
||||
### `port`
|
||||
|
||||
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.
|
||||
|
||||
### `portName`
|
||||
|
||||
Alternatively, the port can be referenced using it's `name` as defined in the `Service`.
|
||||
|
||||
### `scaledownPeriod`
|
||||
|
||||
>Default: 300
|
||||
|
||||
The period to wait after the last reported active before scaling the resource back to 0.
|
||||
|
||||
> 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.
|
||||
|
||||
|
||||
## `scalingMetric`
|
||||
|
||||
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.
|
||||
|
||||
### `requestRate`
|
||||
|
||||
This section enables scaling based on the request rate.
|
||||
|
||||
> **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.
|
||||
|
||||
> **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.
|
||||
|
||||
#### `targetValue`
|
||||
|
||||
>Default: 100
|
||||
|
||||
This is the target value for the scaling configuration.
|
||||
|
||||
#### `window`
|
||||
|
||||
>Default: "1m"
|
||||
|
||||
This value defines the aggregation window for the request rate calculation.
|
||||
|
||||
#### `granularity`
|
||||
|
||||
>Default: "1s"
|
||||
|
||||
This value defines the granualarity of the aggregated requests for the request rate calculation.
|
||||
|
||||
### `concurrency`
|
||||
|
||||
This section enables scaling based on the request concurrency.
|
||||
|
||||
> **NOTE**: This is the only scaling behaviour before v0.8.0
|
||||
|
||||
#### `targetValue`
|
||||
|
||||
>Default: 100
|
||||
|
||||
This is the target value for the scaling configuration.
|
||||
|
|
@ -32,10 +32,10 @@ You'll need to clone the repository to get access to this chart. If you have you
|
|||
You interact with the operator via a CRD called `HTTPScaledObject`. This CRD object instructs interceptors to forward requests for a given host to your app's backing `Service`. To get an example app up and running, read the notes below and then run the subsequent command from the root of this repository.
|
||||
|
||||
```console
|
||||
kubectl apply -n $NAMESPACE -f examples/v0.8.0/httpscaledobject.yaml
|
||||
kubectl apply -n $NAMESPACE -f examples/v0.9.0/httpscaledobject.yaml
|
||||
```
|
||||
|
||||
>If you'd like to learn more about this object, please see the [`HTTPScaledObject` reference](./ref/v0.8.0/http_scaled_object.md).
|
||||
>If you'd like to learn more about this object, please see the [`HTTPScaledObject` reference](./ref/v0.9.0/http_scaled_object.md).
|
||||
|
||||
## Testing Your Installation
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue