Scaling Definitions (scalingDefinitions)

Define the policies for the scaling controller

defaultScalingPolicy

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

Name	Type	Default	Description
enabled	boolean	true	Indicates whether the scaling policy is enabled
max	int Min: -1	-1	Maximum number of cluster members that can be running at the same time
min	int Min: 0	2	Minimum number of cluster members to start
name	horizontal vertical	horizontal	Indicates whether to scale horizontally or vertically.

defaultScalingPolicy > hostGroup

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

Name	Type	Default	Description
tags	string		A space-delimited list of administrative metadata tags. A host is eligible to provision new cluster members if it has one of the tags.

defaultScalingPolicy > in

Defines detailed controls for reducing the number of servers

Name	Type	Default	Description
amount	int Min: 1	1	The amount by which to scale, in the units defined by the units attribute.
minInterval	A period of time with millisecond precision	15m	The 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
units	instance percentage	instance	The units by which to scale. instance Amount is a number of instances. percentage Amount is a percentage relative to the current number of instances.

defaultScalingPolicy > metric

Defines resource usage criteria for starting or removing a server

Name	Type	Default	Description
id	string		A unique configuration ID.
max	int Min: 0 Max: 100	90	The average percentage of the metric above which to scale out
min	int Min: 0 Max: 100	30	The average percentage of the metric below which to scale in
name	cpu heap memory		Name of the scaling policy

defaultScalingPolicy > out

Defines detailed controls for increasing the number of servers

Name	Type	Default	Description
amount	int Min: 1	1	The amount by which to scale, in the units defined by the units attribute.
minInterval	A period of time with millisecond precision	5m	The 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
units	instance percentage	instance	The units by which to scale. instance Amount is a number of instances. percentage Amount is a percentage relative to the current number of instances.

scalingPolicy

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

Name	Type	Default	Description
enabled	boolean	true	Indicates whether the scaling policy is enabled
id	string		A unique configuration ID.
max	int Min: -1	-1	Maximum number of cluster members that can be running at the same time
min	int Min: 0	2	Minimum number of cluster members to start
name	horizontal vertical	horizontal	Indicates whether to scale horizontally or vertically.

scalingPolicy > bind

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

Name	Type	Default	Description
clusters	string		A comma-separated list of cluster names. A cluster name can be wildcarded with an asterisk at the end of the name only.

scalingPolicy > hostGroup

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

Name	Type	Default	Description
tags	string		A space-delimited list of administrative metadata tags. A host is eligible to provision new cluster members if it has one of the tags.

scalingPolicy > in

Defines detailed controls for reducing the number of servers

Name	Type	Default	Description
amount	int Min: 1	1	The amount by which to scale, in the units defined by the units attribute.
minInterval	A period of time with millisecond precision	15m	The 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
units	instance percentage	instance	The units by which to scale. instance Amount is a number of instances. percentage Amount is a percentage relative to the current number of instances.

scalingPolicy > metric

Defines resource usage criteria for starting or removing a server

Name	Type	Default	Description
id	string		A unique configuration ID.
max	int Min: 0 Max: 100		The average percentage of the metric above which to scale out
min	int Min: 0 Max: 100		The average percentage of the metric below which to scale in
name	cpu heap memory		Name of the scaling policy

scalingPolicy > out

Defines detailed controls for increasing the number of servers

Name	Type	Default	Description
amount	int Min: 1	1	The amount by which to scale, in the units defined by the units attribute.
minInterval	A period of time with millisecond precision	5m	The 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
units	instance percentage	instance	The units by which to scale. instance Amount is a number of instances. percentage Amount is a percentage relative to the current number of instances.