Configuring worker zones

Required global permission: Manage environment settings

On a self-hosted instance, you can configure a list of zones to assign Structural workers to. Each zone can contain one or more workers.

When zones are available, each workspace can be assigned a zone. When a workspace is assigned to a zone, then the workspace jobs are always routed to a worker in that zone. Workspaces that are not assigned to a zone are routed to a worker that is not in a zone.

Worker zones allow you to manage the job traffic on your instance.

Displaying the list of zones

The list of zones is on the Zones tab of Structural Settings.

Zones tab on Structural Settings with the list of worker zones

For each zone, the list includes:

• The zone identifier. You use the identifier to assign workers to the zone.
• The zone name.
• The zone description.
• The number of workspaces that use the zone.
• When the zone was added.

Adding a zone

To add a worker zone:

1. Click Create Zone.

Create Zone panel to create a new worker zone

1. On the zone details panel:

   1. In the Zone Name field, provide a name for the zone.
   2. In the Description field, provide a longer description of the zone.
2. Click Save.

Structural generates an identifier for the zone and adds the zone to the list.

Editing a zone

For an existing zone, you can edit the name and description. The identifier does not change.

To edit a zone:

1. In the zone list, click the edit icon for the zone.
2. On the zone details panel, make the edits to zone configuration.
3. Click Save.

Assigning workers to zones

On each worker, to assign the worker to a zone, set the environment setting TONIC_WORKER_ZONE_ID to the identifier of the zone.

The zone identifier is displayed on the Zones list.

Deleting a zone

To delete a zone:

1. In the zone list, click the delete icon for the zone.
2. On the confirmation panel, click Yes, delete zone.

When you delete a zone, any workspaces that used that zone are updated to not use a zone.