yusheng-guo/kube-metrics-adapter
1
0
Fork 1
mirror of https://github.com/zalando-incubator/kube-metrics-adapter.git synced 2025-01-03 07:40:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for multi hostnames per metric and weight param

Browse Source 
Signed-off-by: Lucas Thiesen <lucas.thiesen@zalando.de>
This commit is contained in:
Lucas Thiesen
2023-05-05 15:19:21 +02:00
parent b8532b756b
commit d6a33fed63
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -414,11 +414,11 @@ box so users don't have to define those manually.
| Metric | Description | Type | Kind | K8s Versions | | Metric | Description | Type | Kind | K8s Versions |
| ------------ | -------------- | ------- | -- | -- | | ------------ | -------------- | ------- | -- | -- |
| `hostname-rps` | Scale based on requests per second for a certain hostname. | External | | `>=1.12` | | `requests-per-second` | Scale based on requests per second for a certain hostname. | External | | `>=1.12` |
### Example: External Metric ### Example: External Metric
This is an example of an HPA that will scale based on `hostname-rps` for the RPS measured in the hostname called `www.example.com`. This is an example of an HPA that will scale based on `requests-per-second` for the RPS measured in the hostnames called: `www.example1.com` and `www.example2.com`; and weighted by 42%.
```yaml ```yaml
apiVersion: autoscaling/v2beta2 apiVersion: autoscaling/v2beta2
@ -426,7 +426,8 @@ kind: HorizontalPodAutoscaler
metadata: metadata:
name: myapp-hpa name: myapp-hpa
annotations: annotations:
metric-config.external.example-rps.hostname-rps/hostname: www.example.com metric-config.external.example-rps.requests-per-second/hostname: www.example1.com,www.example2.com
metric-config.external.example-rps.requests-per-second/weight: 42
spec: spec:
scaleTargetRef: scaleTargetRef:
apiVersion: apps/v1 apiVersion: apps/v1
@ -441,11 +442,23 @@ spec:
name: example-rps name: example-rps
selector: selector:
matchLabels: matchLabels:
type: hostname-rps type: requests-per-second
target: target:
type: AverageValue type: AverageValue
averageValue: "42" averageValue: "42"
``` ```
### Multiple hostnames per metric
This metric supports a relation of n:1 with metrics. The way it works is the measured RPS is the sum of the RPS rate of each of the specified hostnames. This value is further modified by the weight parameter explained bellow.
### Metric weighting based on backend
There are ingress-controllers, like skipper-ingress, that supports sending traffic to different backends based on some kind of configuration, in case of skipper annotations
present on the `Ingress` object, or weights on the RouteGroup backends. By
default the number of replicas will be calculated based on the full traffic
served by these components. If however only the traffic being routed to
a specific hostname should be used then the weight for the configured hostname(s) might be specified via the `weight` annotation `metric-config.external.<metric-name>.request-per-second/weight` for the metric being configured.
## InfluxDB collector ## InfluxDB collector