Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation for Adding Standard HPA resource metrics to KEDA #188

Merged
merged 13 commits into from
Jul 10, 2020
Merged

Documentation for Adding Standard HPA resource metrics to KEDA #188

Changes from 7 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
c97fd17
Documentation for Adding Standard HPA resource metrics to KEDA
Jun 10, 2020
9c712ff
Changing the name of hpaConfig to HorizontalPodAutoscalerConfig
Jun 15, 2020
c3e64d0
Adding advanced section to docs
Jun 26, 2020
7798162
Adding array to resource metrics
Jun 26, 2020
bd5ab76
Adding array to resource metrics docs
Jun 26, 2020
f3e0426
Correcting the array
Jun 28, 2020
4f700c3
Correcting the docs for resource metrics
Jun 28, 2020
fc8d130
Adding the review feedback for doc as a text instead of yaml
Jun 29, 2020
27c52b5
Adding description of standard resources
Jun 29, 2020
3b6716d
Merge branch 'master' of github.com:kedacore/keda-docs into resourceM…
Jun 29, 2020
b2b0607
Removing bold from docs
Jun 29, 2020
2a2d822
Adding bullet points to hpaconfig
Jul 10, 2020
dfac39e
Correcting indentation in hpaconfig
Jul 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 41 additions & 4 deletions content/docs/2.0/concepts/scaling-deployments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,20 @@ spec:
scaleTargetRef:
deploymentName: {deployment-name} # must be in the same namespace as the ScaledObject
containerName: {container-name} #Optional. Default: deployment.spec.template.spec.containers[0]
pollingInterval: 30 # Optional. Default: 30 seconds
cooldownPeriod: 300 # Optional. Default: 300 seconds
minReplicaCount: 0 # Optional. Default: 0
maxReplicaCount: 100 # Optional. Default: 100
pollingInterval: 30 # Optional. Default: 30 seconds
cooldownPeriod: 300 # Optional. Default: 300 seconds
minReplicaCount: 0 # Optional. Default: 0
maxReplicaCount: 100 # Optional. Default: 100
advanced:
horizontalPodAutoscalerConfig: # Optional. If not set, KEDA won't scale based on resource utilization
resourceMetrics:
- name: cpu/memory # Name of the resource to be targeted
target:
type: value/ utilization/ averagevalue
value: 60 # Optional
averageValue: 40 # Optional
averageUtilization: 50 # Optional
behavior:
triggers:
# {list of triggers to activate the deployment}
```
Expand Down Expand Up @@ -93,6 +103,33 @@ Minimum number of replicas KEDA will scale the deployment down to. By default it

This setting is passed to the HPA definition that KEDA will create for a given deployment.

---

```yaml
advanced:
horizontalPodAutoscalerConfig:
resourceMetrics:
- name: cpu/memory
target:
type: value/ utilization/ averagevalue
value: 60 # Optional
averageValue: 40 # Optional
averageUtilization: 50 # Optional
behavior:
```
advanced:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it's better to follow the approach from the guidance above where it's more of a fluent text rather than annotated YAML?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made the changes and pushed. But github is not reflecting that commit and changes. Figuring out why

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They are having some service issues, maybe it's related

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

now its shown :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tomkerkhove The new line doesn't get shown in the rich view. Could you help how I can make it look exactly like the pr?

horizontalPodAutoscalerConfig:
resourceMetrics:
- name: This is the name of the resource to be targeted as a metric (cpu, memory etc)
target:
type: type represents whether the metric type is utilization, value, or averagevalue.
value: value is the target value of the metric (as a quantity).
averageValue: averageValue is the target value of the average of the metric across all relevant pods (quantity)
averageUtilization: averageUtilization is the target value of the average of the resource metric across all
relevant pods, represented as a percentage of the requested value of the resource for the
pods. Currently only valid for Resource metric source type.
behavior:

## Long-running executions

One important consideration to make is how this pattern can work with long running executions. Imagine a deployment triggers on a RabbitMQ queue message. Each message takes 3 hours to process. It's possible that if many queue messages arrive, KEDA will help drive scaling out to many replicas - let's say 4. Now the HPA makes a decision to scale down from 4 replicas to 2. There is no way to control which of the 2 replicas get terminated to scale down. That means the HPA may attempt to terminate a replica that is 2.9 hours into processing a 3 hour queue message.
Expand Down