Skip to main content

Node groups

A node group is a set of nodes you pick. A project given one or more groups runs only on their nodes; a project with none runs on All, every enabled node of your organization. This page lists what the Groups tab and a group's page show. How to use groups is in Run a project on some nodes only.

A node may sit in several groups. A project runs on any node in any of its groups.

Plan and access​

Plan: node groups are on the Business plan. On other plans the Groups tab isn't shown, and a group's page shows only Not on your plan: "Your plan doesn't include node groups." An Org Owner or Admin sees a See plans button under it; anyone else reads "Ask an admin to change the plan."

The Not on your plan panel: Your plan doesn't include node groups, with a See plans button

The other screens on this page aren't pictured: the organization the screenshots come from isn't on the Business plan.

Access: the tab and a group's page need the permission to view nodes. Making, changing and deleting a group needs the permission to edit nodes. Without it, New group is hidden (or greyed out with the reason, on an empty list) and a group's page only reads.

The Groups tab​

Open it from the sidebar: select Directory, then Machines, then the Groups tab. New group sits at the right end of the tab strip and opens an empty group's page.

The list has one row per group, with All pinned on top:

ColumnMeaning
NameThe group's name. Select it to open the group's page. All has no page: it's built in and can't be changed.
NodesHow many nodes are in the group, then up to three of their names and +N for the rest.
ProjectsHow many projects use the group, and their names. Empty for All.
DescriptionWhat the group is for. All reads Every node.

On a phone or a narrow pane, each row keeps its name and node count only.

With no group yet, the list shows All and the line No node groups yet. Group nodes to choose where each project runs., with its own New group button.

A group's page​

The page opens beside the list. Its breadcrumb reads Nodes › Groups › the group's name (New group on a new one). A saved group has Delete at the top right.

FieldMeaning
NameRequired. Shown wherever projects and nodes pick a group. Two groups can't share a name, and no group can be named All; the field says why it refuses one.
DescriptionOptional. What the group is for.
MembersThe nodes this group's projects run on. Type in Add a node to pick one; each member is a chip with × to remove it. A disabled node reads Disabled beside its name. Hosts that run nodes aren't offered, and a shared Easy Mode node is refused.
ProjectsRead only: the projects that use this group, each a link to its page. No projects when none does. A project's groups change on the project's own page.

Name and Description are saved with Save; a short Saved. note confirms it. Cancel goes back to the Groups tab. Leaving with unsaved changes asks first: This group has changes that have not been saved. Save them before leaving?

A change to Members applies at once, with no Save. When removing nodes would stop projects from using nodes that run tasks right now, Jaah asks first, in Stop using 1 node? (or Stop using N nodes?). It lists each node with its running tasks and notes Running tasks finish first. Select Change groups to go ahead.

On New group, all three fields are a draft until you select Create, which opens the saved group. Create is greyed out until there's a name.

Delete opens Delete "name"?. It lists the projects that lose the group under These projects lose it: and notes Any left with no group runs on All., or reads No project uses it. Select Delete to confirm. Running tasks are never stopped.

Without the permission to edit nodes, the page shows Name, Description (when set) and Members (or None) as text, and Projects, with no buttons.