Updated on 2024-11-14 GMT+08:00

Creating an Agent Pool

Scenario

You can use built-in or custom executors to perform check, build, deployment, pipeline, and API test tasks in CodeArts.

Agent pools are used to connect custom executors. You can add your own execution resources to an agent pool so that you can use them to execute tasks. Agent pools help improve efficiency and remove dependency on public execution resources.

Creating an Agent Pool

  1. Go to the CodeArts homepage.

    1. Log in to the CodeArts console, click , and select a region.
    2. Click Access Service.

  2. Click the username on the navigation bar and choose All Account Settings.
  3. Choose Agent Pool > Agent Pool.
  4. Click Create Pool.
  5. Configure the agent pool and click Save.

    Table 1 Creating an agent pool

    Configuration Item

    Mandatory

    Description

    Pool Name

    Yes

    Enter a maximum of 50 characters, including digits, letters, periods (.), underscores (_), and hyphens (-).

    Pool Type

    Yes

    Supported pool types:

    • LINUX: Tasks are executed on a Linux VM.
    • LINUX_DOCKER: A Linux Docker container is started and tasks are executed in the container.
    • WINDOWS: Tasks are executed on a Windows VM.
    • MAC: The agent registration command is run on a MAC host.

    Description

    No

    Enter a maximum of 1,024 characters.

    This pool can be used by all users of the current account.

    No

    If this parameter is selected, all users of the current account can use the pool.

  6. View the new record after the creation is successful.

Follow-up Operations

After creating an agent pool, you can perform the following management operations on it.

Table 2 Managing an agent pool

Operation

Description

Viewing agent pool details

Click the Pool Details tab, and view the detailed information, including the owner, pool type, creation time, and description.

Managing agent pool permissions

Click the Permissions tab, and manage the permissions for using the agent pool.

  • Specifying managers: Managers have full permissions for an agent pool, including viewing, using, configuring, and modifying the agent pool.
    • Click Add next to Manager, select a user from the drop-down list, and click .
    • To cancel the manager role of a user, click next to the username.

  • Specifying users: Users can view the pool details, operation records, and agent list, and use agents in the pool to execute tasks.
    • Click the switch to grant the user role to all users in your account.
    • Click Add next to Projects, select a project name from the drop-down list box, and click to set all members in the selected project as agent pool users.
    • To cancel the authorization for members in a project, click next to the project name.

Viewing agent pool operation records

Click the Operation Records tab, and view the operation records.

Setting notification rules

Click the Notify tab, and configure notifications for different operations. You can determine whether to send service updates or emails to permission managers when the following operations are triggered:

  • Create agent
  • Delete agent
  • Disable agent
  • Enable agent
  • Bring agent offline
  • Bring agent online