Scaling Definitions (scalingDefinitions)

Defines the policies for the scaling controller

defaultScalingPolicy
Description: Defines default criteria for starting or stopping Liberty servers based on demand for resources
Required: false
Data type:
Attribute name Data type Default value Description
enabled boolean true Indicates whether the scaling policy is enabled
max int

Minimum: -1

-1 Maximum number of cluster members that can be running at the same time
min int

Minimum: 0

2 Minimum number of cluster members to start
name
  • vertical
  • horizontal
horizontal Indicates whether to scale horizontally or vertically.
vertical
Vertical
horizontal
Horizontal
defaultScalingPolicy > hostGroup
Description: Defines criteria for determining which hosts can be used to provision new cluster members.
Required: false
Data type:
Attribute name Data type Default value 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
Description: Defines detailed controls for reducing the number of servers
Required: false
Data type:
Attribute name Data type Default value Description
amount int

Minimum: 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. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
units
  • percentage
  • instance
instance The units by which to scale.
percentage
Amount is a percentage relative to the current number of instances.
instance
Amount is a number of instances.
defaultScalingPolicy > metric
Description: Defines resource usage criteria for starting or removing a server
Required: false
Data type:
Attribute name Data type Default value Description
id string   A unique configuration ID.
max int

Minimum: 0

Maximum: 100

90 The average percentage of the metric above which to scale out
min int

Minimum: 0

Maximum: 100

30 The average percentage of the metric below which to scale in
name
  • heap
  • cpu
  • memory
  Name of the scaling policy
heap
Heap
cpu
CPU
memory
Memory
defaultScalingPolicy > out
Description: Defines detailed controls for increasing the number of servers
Required: false
Data type:
Attribute name Data type Default value Description
amount int

Minimum: 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. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
units
  • percentage
  • instance
instance The units by which to scale.
percentage
Amount is a percentage relative to the current number of instances.
instance
Amount is a number of instances.
scalingPolicy
Description: Defines criteria for starting or stopping Liberty servers based on demand for resources
Required: false
Data type:
Attribute name Data type Default value Description
enabled boolean true Indicates whether the scaling policy is enabled
id string   A unique configuration ID.
max int

Minimum: -1

-1 Maximum number of cluster members that can be running at the same time
min int

Minimum: 0

2 Minimum number of cluster members to start
name
  • vertical
  • horizontal
horizontal Indicates whether to scale horizontally or vertically.
vertical
Vertical
horizontal
Horizontal
scalingPolicy > bind
Description: Defines the names of the clusters to which the policy is applied
Required: false
Data type:
Attribute name Data type Default value 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
Description: Defines criteria for determining which hosts can be used to provision new cluster members.
Required: false
Data type:
Attribute name Data type Default value 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
Description: Defines detailed controls for reducing the number of servers
Required: false
Data type:
Attribute name Data type Default value Description
amount int

Minimum: 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. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
units
  • percentage
  • instance
instance The units by which to scale.
percentage
Amount is a percentage relative to the current number of instances.
instance
Amount is a number of instances.
scalingPolicy > metric
Description: Defines resource usage criteria for starting or removing a server
Required: false
Data type:
Attribute name Data type Default value Description
id string   A unique configuration ID.
max int

Minimum: 0

Maximum: 100

  The average percentage of the metric above which to scale out
min int

Minimum: 0

Maximum: 100

  The average percentage of the metric below which to scale in
name
  • heap
  • cpu
  • memory
  Name of the scaling policy
heap
Heap
cpu
CPU
memory
Memory
scalingPolicy > out
Description: Defines detailed controls for increasing the number of servers
Required: false
Data type:
Attribute name Data type Default value Description
amount int

Minimum: 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. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
units
  • percentage
  • instance
instance The units by which to scale.
percentage
Amount is a percentage relative to the current number of instances.
instance
Amount is a number of instances.

Icon that indicates the type of topic Reference topic



Timestamp icon Last updated: Monday, 5 December 2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=rwlp_config_scalingDefinitions
File name: rwlp_config_scalingDefinitions.html