19. Instance Groups
An Instance Group provides the ability to group instances in a clustered environment. Additionally, policies dictate how instance groups behave and how jobs are executed. The following view displays the capacity levels based on policy algorithms:
19.1. Create an instance group
To create a new instance group:
- Click the icon from the left navigation menu to open the Instance Groups configuration window.
- Click the button.
- Enter the appropriate details into the following fields:
- Name. Names must be unique and must not be named tower.
- Policy Instance Minimum. Enter the minimum number of instances to automatically assign to this group when new instances come online.
- Policy Instance Percentage. Use the slider to select a minimum percentage of instances to automatically assign to this group when new instances come online.
- Policy Instance List. Specify instances you want to assign to this group.
Policy Instance fields are not required to create a new instance group. If you do not specify values, then the Policy Instance Minimum and Policy Instance Percentage default to 0.
- Click Save.
Once the instance group is successfully created, the Details tab of the newly created instance group remains, which allows you to review and edit your instance group information. This is the same menu that is opened if the Edit () button is clicked from the Instance Group link. You can also edit Instances and review Jobs associated with this instance group.
19.1.1. Associate instances to an instance group
To associate instances to an instance group:
- Click the Instances tab of the Instance Group window and click the button.
- Click the checkbox next to one or more available instances from the list to select the instance(s) you want to add to the instance group.
- In the following example, the instances added to the instance group displays along with information about their capacity.
This view also allows you to edit some key attributes associated with the instances in your instance group:
19.1.2. View jobs associated with an instance group
To view the jobs associated with the instance group:
- Click the Jobs tab of the Instance Group window.
- Each job displays the job status, ID, and name; type of job, time started and completed, who started the job; and which template, inventory, and credential were used.
The instances are run in accordance with instance group policies. Refer to Instance Group Policies in the Ansible Tower Administration Guide.