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

Clarify that autoscaling.keda.sh/paused annotation value is not important. Only prescence is checked #1266

Closed
wants to merge 2 commits into from
Closed

Clarify that autoscaling.keda.sh/paused annotation value is not important. Only prescence is checked #1266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4918395
Clarify that autoscaling.keda.sh/paused annotation value is not impor…
nappelson Nov 27, 2023
8fda5b6
Update content/docs/2.11/concepts/scaling-jobs.md
nappelson Nov 27, 2023
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
6 changes: 3 additions & 3 deletions content/docs/2.11/concepts/scaling-jobs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ kind: ScaledJob
metadata:
name: {scaled-job-name}
annotations:
autoscaling.keda.sh/paused: true # Optional. Use to pause autoscaling of Jobs
autoscaling.keda.sh/paused: any-value # Optional. Use to pause autoscaling of Jobs
spec:
jobTargetRef:
parallelism: 1 # [max number of desired pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
Expand Down Expand Up @@ -251,10 +251,10 @@ You can enable this by adding the below annotation to your `ScaledJob` definitio
```yaml
metadata:
annotations:
autoscaling.keda.sh/paused: true
autoscaling.keda.sh/paused: any-value
```

The above annotation will pause autoscaling. To enable autoscaling again, simply remove the annotation from the `ScaledJob` definition.
The above annotation will pause autoscaling. To enable autoscaling again, simply remove the annotation from the `ScaledJob` definition. Note, the annotation value is not important, only the presence of the annotation is used to determine if autoscaling is paused or not.

# Sample

Expand Down
6 changes: 3 additions & 3 deletions content/docs/2.12/concepts/scaling-jobs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ kind: ScaledJob
metadata:
name: {scaled-job-name}
annotations:
autoscaling.keda.sh/paused: true # Optional. Use to pause autoscaling of Jobs
autoscaling.keda.sh/paused: any-value # Optional. Use to pause autoscaling of Jobs
spec:
jobTargetRef:
parallelism: 1 # [max number of desired pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
Expand Down Expand Up @@ -251,10 +251,10 @@ You can enable this by adding the below annotation to your `ScaledJob` definitio
```yaml
metadata:
annotations:
autoscaling.keda.sh/paused: true
autoscaling.keda.sh/paused: any-value
```

The above annotation will pause autoscaling. To enable autoscaling again, simply remove the annotation from the `ScaledJob` definition.
The above annotation will pause autoscaling. To enable autoscaling again, simply remove the annotation from the `ScaledJob` definition. Note, the annotation value is not important, only the presence of the annotation is used to determine if autoscaling is paused or not.

# Sample

Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.13/concepts/scaling-deployments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ metadata:
annotations:
scaledobject.keda.sh/transfer-hpa-ownership: "true" # Optional. Use to transfer an existing HPA ownership to this ScaledObject
autoscaling.keda.sh/paused-replicas: "0" # Optional. Use to pause autoscaling of objects
autoscaling.keda.sh/paused: "true" # Optional. Use to pause autoscaling of objects explicitly
autoscaling.keda.sh/paused: "any-value" # Optional. Use to pause autoscaling of objects explicitly
spec:
scaleTargetRef:
apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
Expand Down Expand Up @@ -275,7 +275,7 @@ It can be useful to instruct KEDA to pause autoscaling of objects, if you want t
metadata:
annotations:
autoscaling.keda.sh/paused-replicas: "0"
autoscaling.keda.sh/paused: "true"
autoscaling.keda.sh/paused: "any-value"
```

The presence of these annotations will pause autoscaling no matter what number of replicas is provided.
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.13/concepts/scaling-jobs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ metadata:
labels:
my-label: {my-label-value} # Optional. ScaledJob labels are applied to child Jobs
annotations:
autoscaling.keda.sh/paused: true # Optional. Use to pause autoscaling of Jobs
autoscaling.keda.sh/paused: any-value # Optional. Use to pause autoscaling of Jobs
my-annotation: {my-annotation-value} # Optional. ScaledJob annotations are applied to child Jobs
spec:
jobTargetRef:
Expand Down Expand Up @@ -254,7 +254,7 @@ You can enable this by adding the below annotation to your `ScaledJob` definitio
```yaml
metadata:
annotations:
autoscaling.keda.sh/paused: true
autoscaling.keda.sh/paused: any-value
```

The above annotation will pause autoscaling. To enable autoscaling again, simply remove the annotation from the `ScaledJob` definition.
Expand Down