Skip to content

Commit

Permalink
Add scaling target update to docs (#166)
Browse files Browse the repository at this point in the history
  • Loading branch information
jthomperoo committed Mar 26, 2022
1 parent 8518330 commit 85a91f8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/reference/scaling-targets.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
# Scaling targets

Custom Pod Autoscalers can target any resource that the Horizontal Pod Autoscaler can target:
Custom Pod Autoscalers can target any resource that the Horizontal Pod Autoscaler can target, for example:

* Deployments
* ReplicaSets
* StatefulSets
* ReplicationControllers

Beyond this the CPA can target any other resource that your cluster supports as long as the resource implements the
scale subresource API. For example this means support for:

* Argo Rollouts
* Other third party resources.

## Scale target reference

To tell a Custom Pod Autoscaler which resource to target, provide a `scaleTargetRef` - a description of the resource to target. Within a Custom Pod Autoscaler definition it looks like this:
To tell a Custom Pod Autoscaler which resource to target, provide a `scaleTargetRef` - a description of the resource to
target. Within a Custom Pod Autoscaler definition it looks like this:

```yaml
apiVersion: custompodautoscaler.com/v1
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
mkdocs==1.2.3
jinja2==3.0.0
mdx-truly-sane-lists==1.2
mkdocs-material==5.5.5
mkdocs-material-extensions==1.0

0 comments on commit 85a91f8

Please sign in to comment.