scalingDefinitions - Scaling Definitions (scalingDefinitions)

Defines the policies for the scaling controller

Defines default criteria for starting or stopping Liberty servers based on demand for resources

NameTypeDefaultDescription
enabledbooleantrueIndicates whether the scaling policy is enabled
minint
Min: 0
2Minimum number of cluster members to start
maxint
Min: -1
-1Maximum number of cluster members that can be running at the same time
name
  • horizontal
  • vertical
horizontalIndicates whether to scale horizontally or vertically.
horizontal
Horizontal
vertical
Vertical

defaultScalingPolicy > metric

Defines resource usage criteria for starting or removing a server

NameTypeDefaultDescription
idstringA unique configuration ID.
name
  • memory
  • cpu
  • heap
Name of the scaling policy
memory
Memory
cpu
CPU
heap
Heap
minint
Min: 0

Max: 100
30The average percentage of the metric below which to scale in
maxint
Min: 0

Max: 100
90The average percentage of the metric above which to scale out

defaultScalingPolicy > in

Defines detailed controls for reducing the number of servers

NameTypeDefaultDescription
amountint
Min: 1
1The amount by which to scale, in the units defined by the units attribute.
units
  • instance
  • percentage
instanceThe units by which to scale.
instance
Amount is a number of instances.
percentage
Amount is a percentage relative to the current number of instances.
minIntervalA period of time with millisecond precision15mThe minimum amount of time between a scaling change. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

defaultScalingPolicy > out

Defines detailed controls for increasing the number of servers

NameTypeDefaultDescription
amountint
Min: 1
1The amount by which to scale, in the units defined by the units attribute.
units
  • instance
  • percentage
instanceThe units by which to scale.
instance
Amount is a number of instances.
percentage
Amount is a percentage relative to the current number of instances.
minIntervalA period of time with millisecond precision5mThe minimum amount of time between a scaling change. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

defaultScalingPolicy > hostGroup

Defines criteria for determining which hosts can be used to provision new cluster members.

NameTypeDefaultDescription
tagsstringA space-delimited list of administrative metadata tags. A host is eligible to provision new cluster members if it has one of the tags.

scalingPolicy

Defines criteria for starting or stopping Liberty servers based on demand for resources

NameTypeDefaultDescription
idstringA unique configuration ID.
enabledbooleantrueIndicates whether the scaling policy is enabled
minint
Min: 0
2Minimum number of cluster members to start
maxint
Min: -1
-1Maximum number of cluster members that can be running at the same time
name
  • horizontal
  • vertical
horizontalIndicates whether to scale horizontally or vertically.
horizontal
Horizontal
vertical
Vertical

scalingPolicy > metric

Defines resource usage criteria for starting or removing a server

NameTypeDefaultDescription
idstringA unique configuration ID.
name
  • memory
  • cpu
  • heap
Name of the scaling policy
memory
Memory
cpu
CPU
heap
Heap
minint
Min: 0

Max: 100
The average percentage of the metric below which to scale in
maxint
Min: 0

Max: 100
The average percentage of the metric above which to scale out

scalingPolicy > bind

Defines the names of the clusters to which the policy is applied

NameTypeDefaultDescription
clustersstringA comma-separated list of cluster names. A cluster name can be wildcarded with an asterisk at the end of the name only.

scalingPolicy > in

Defines detailed controls for reducing the number of servers

NameTypeDefaultDescription
amountint
Min: 1
1The amount by which to scale, in the units defined by the units attribute.
units
  • instance
  • percentage
instanceThe units by which to scale.
instance
Amount is a number of instances.
percentage
Amount is a percentage relative to the current number of instances.
minIntervalA period of time with millisecond precision15mThe minimum amount of time between a scaling change. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

scalingPolicy > out

Defines detailed controls for increasing the number of servers

NameTypeDefaultDescription
amountint
Min: 1
1The amount by which to scale, in the units defined by the units attribute.
units
  • instance
  • percentage
instanceThe units by which to scale.
instance
Amount is a number of instances.
percentage
Amount is a percentage relative to the current number of instances.
minIntervalA period of time with millisecond precision5mThe minimum amount of time between a scaling change. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

scalingPolicy > hostGroup

Defines criteria for determining which hosts can be used to provision new cluster members.

NameTypeDefaultDescription
tagsstringA space-delimited list of administrative metadata tags. A host is eligible to provision new cluster members if it has one of the tags.