23. Instance Groups

An Instance Group groups the instances that run jobs; its policies decide which instances belong to it and how many jobs it runs at the same time. Open Automation Execution > Infrastructure > Instance Groups to see the instance groups and container groups, with their type, their instances and their used capacity:

The Instance Groups list with the controlplane and default groups and the example groups

In Koios Automation Platform on OpenShift or Kubernetes, the controlplane instance group holds the control nodes of automation controller, and the default group is a container group: jobs run in pods of the cluster, not on the control nodes. A regular instance group runs jobs only on the execution nodes (or hybrid nodes) associated with it; see Managing Capacity With Instances to add execution nodes. For more information about the policies and capacity of instance groups, see Instance Groups; for container groups, see Container Groups.

23.1. Create an instance group

To create a new instance group:

  1. Open Automation Execution > Infrastructure > Instance Groups.

  2. Click Create group and select Create instance group.

The Create instance group form

  1. Enter the appropriate details into the following fields:

  • Name (required). Names must be unique. The default and controlplane groups cannot be renamed.

  • Policy instance minimum. The minimum number of instances to automatically assign to this group when new instances come online.

  • Policy instance percentage. The minimum percentage of instances to automatically assign to this group when new instances come online.

  • Max concurrent jobs. The maximum number of jobs that can run at the same time on this instance group.

  • Max forks. The maximum number of forks that the jobs running on this instance group can use in total.

Note

All these fields except Name default to 0. For Max concurrent jobs and Max forks, 0 means no limit. See Instance group capacity limits for more detail.

  1. Click Create instance group.

The Details tab of the new instance group opens; click Edit instance group to change it. The Instances tab lists its instances, Team Access and User Access control who can use it, and Jobs lists the jobs that ran on it.

Details of the Example Instance Group with its tabs

23.1.1. Associate instances to an instance group

To associate instances to an instance group:

  1. Open the Instances tab of the instance group and click Associate instance.

  2. Select one or more instances in the Select instances window and click Confirm. Only execution and hybrid nodes that are not in the group yet are offered; control and hop nodes cannot be associated, so in a platform without execution nodes the list is empty, as in this example.

The Select instances window, empty because there are no execution nodes

The Instances tab shows each instance with its status, node type, capacity and used capacity. From this view you can adjust the capacity of an instance with its slider, enable or disable it with its switch, run a health check of execution nodes, and disassociate execution nodes from the group. Control and hop nodes cannot change their instance group membership, and hybrid nodes cannot leave controlplane, so those actions are disabled for the control node of this example:

The Instances tab of the controlplane group with the capacity slider, the enable switch and the health check action

23.1.2. View jobs associated with an instance group

To view the jobs that ran on the instance group, open its Jobs tab. Expand a job to see more details about it.

The Jobs tab of the default container group with an expanded job

Each job displays its ID, name, status and type, and, expanded, who launched it and the resources it used, such as the template, inventory, project and execution environment.

The instances are run in accordance with instance group policies. Refer to Instance Group Policies.