An auto-scaling policy defines the threshold values pertaining to scaling up and scaling down decisions. Autoscaler will refer to the auto-scaling policy that is defined by DevOps. A sample auto-scaling policy definition, together with information on all the properties that can be added in an auto-scaling policy definition JSON are as follows:
Table of Contents | ||
---|---|---|
|
Sample auto-scaling policy definition JSON
The following are sample configurations that can be used to define an auto-scaling policy:
Excerpt | ||
---|---|---|
|
Property definitions
All the properties that correspond to the auto-scaling resource are explained as follows:
Main property definitions
Property | Description | Data Type | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
JSON | UI | ||||||||||||||
| Auto Scale policy ID | √ | √ | Unique ID of the autoscaling policy | Yes | N/A | String | economy | |||||||
| √ | √ | No | N/A | String | ||||||||||
| Description | √ | √ | A summarized description of the auto-scaling policy | No | N/A | String | Values for economy auto-scaling policy. | |||||||
| Load Thresholds | √ | √ | The autoscaling load threshold is determined based on the requests in flight, memory consumption, and load average. For more information on the sub-properties, see loadThresholds. | Yes | N/A | LoadThresholds | N/A |
Sub-property definitions
loadThresholds
Property | Description | Data Type | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
JSON | UI | |||||||||||||||
| Requests In Flight | √ | √ | The number of requests the load balancer received, but are yet to be processed. For more information on the sub-properties, see requestsInFlight.
| No | N/A | requestsInFlight | |||||||||
| Memory Consumption | √ | √ | The memory usage of a cartridge process, which is considered as a percentage of the total available RAM. This is a percentage and cannot go beyond 100, since a process cannot take more than total physical memory. For more information on the sub-properties, see memoryConsumption.
| Yes | N/A | memoryConsumption | |||||||||
loadAverage | Load Average | √ | √ | The average system load over a period of time. (System load is a measure of the amount of computational work that a computer system performs.) This a percentage and it can go beyond 100%. For more information on the sub-properties, see loadAverage.
| Yes | N/A | loadAverage |
requestsInFlight
Property | Description | Data Type | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
JSON | UI | ||||||||||||||
threshold | Threshold | √ | √ | The maximum requests in-flight limit. | No | N/A | Float | 30 |
memoryConsumption
Property | Description | Data type | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
JSON | UI | ||||||||||||||
threshold | Threshold | √ | √ | The maximum memory usage limit. | No | N/A | Float | 80 |
loadAverage
Property | Description | Data Type | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
JSON | UI | ||||||||||||||
threshold | Threshold | √ | √ | The maximum limit of an average system load over a period of time. | Yes | N/A | Float | 100 |