Creating and managing agent pools

Similar to resource groups, agent pools help you organize and manage agents that are installed in different environments.

You can use an agent pool to spread the deployment processing work among participating agents and provide relief to otherwise overburdened agents. Users assign agents to pools and pools are assigned to resources, just like lone agents. When an agent pool is assigned to a resource, work items are sent to eligible agents. If you don't use a pool, then the agent that is assigned to the resource is assigned all the processing work regardless of its current workload. Such a workload might lead to bottlenecks.
Note: The agent pool algorithm will assign the workload to the most available agents in the pool. Most available agents are determined by which agents have the minimum running plugin steps in the agent pool. If there are multiple agents in the pool with the same plugin step count, the agents the database returns first will be assigned the workload.

Creating an agent pool

Procedure

To create an agent pool, specify the agents that are the members of the pool.
  1. From the Resources tab, click Agent Pools.
  2. From the Agent Pools pane, click Create Agent Pool.
    The Create Agent Pool window opens.
  3. Specify the pool name.
  4. Optional: Enter a description in the Description field.
  5. Optional: To manage the teams that can access the agent pool, click the plus icon by Teams.
  6. To add agents to the pool, click the Add Agents field.
    A list of the available agents appears.
  7. Select the agent or agents to add to the pool.
    You can filter the listed agents by entering search text into the field.
  8. When you are finished, click Save.

Managing agent pools

Procedure

You can manage agent pools from the web interface.
  1. To display the Agent Pools pane, click Resources > Agent Pools.
  2. Click an action link for the pool.
    Actions are described in the following table.
    Action Description
    Edit With this option, you can add or remove agents and edit the pool's name and description.
    Copy Creates a pool with the same agents as the selected pool.
    Delete Removes the agent pool.
    To deploy a resource to an agent pool, the resource must be a child of the agent pool.

Agent pools for containers

Procedure

Agent pools can be used to provide efficiency with your use of HCL Launch licenses. You can take advantage of running your agents in a Kubernetes-based environment where you can spin agent instances up and down quickly.

Follow these steps in order to achieve this efficiency:

  1. Build the application resource tree using an Agent Pool instead of using the Agent directly. .
  2. Deploy an instance of the HCL Launch Agent to your Kubernetes cluster. See Deploying Agent in Kubernetes Cluster.
  3. The agent will be automatically get a license per the system setting on licensing agent.
  4. Use the REST API to add the agent into the specified Agent Pool. See Add an agent to an agent pool.
  5. Run your deployment.
  6. Use the REST API to remove the agent from the specified Agent Pool. See Remove an agent from an agent pool.
  7. The license will be removed if you are using server-agent license model; license will be released 15 minutes later if you are using Simultaneous Session license model.
  8. Delete the instance of the HCL Launch Agent from the Kubernetes cluster.