Files
sencho/docs/features/stack-labels.mdx
T
Anso 1803512f70 feat: drop stack labels and network topology to Community tier (#995)
* feat(labels): drop tier gate to Community for organization endpoints

Stack Labels CRUD and per-stack assignment are now Community-tier features:
list, create, update, delete labels, and assign labels to a single stack.

The two automation surfaces stay Skipper+: per-label bulk deploy / stop /
restart (POST /api/labels/:id/action) and the Fleet Actions tab's
bulk-assign card (POST /api/fleet-actions/labels/bulk-assign). Tier story
is now organize free, automate paid.

Add a route-level test that proves the CRUD endpoints succeed on a Community
license while the bulk-action endpoint still returns 403. Update overview,
licensing, and stack-labels docs to reflect the new tier placement and to
note that bulk actions on a label still require Skipper or Admiral.

* feat(topology): drop tier gate to Community for network topology view

The Resources tab's Networks > Topology view is now available on every tier.
Drops requirePaid from GET /api/system/networks/topology, removes the
isPaid wrapper around the List | Topology toggle in ResourcesView, and
removes the PaidGate around the topology graph.

CapabilityGate stays in place so a node running on a build without the
network-topology capability still renders its lock card instead of the
graph. Add a route-level test that proves the endpoint returns 200 on a
Community license. Update licensing and resources docs to reflect the new
tier placement.

* fix(labels): expose Settings > Labels tab on Community tier

The settings registry entry for the Labels tab still carried tier:
'skipper', which kept the tab hidden in the Settings sidebar even though
the underlying CRUD endpoints now serve Community. Drop the tier flag so
Community users can discover and reach the section that backs the
already-Community-tier label endpoints.
2026-05-08 15:24:25 -04:00

101 lines
4.3 KiB
Plaintext

---
title: Stack Labels
description: Organize your stacks with colored labels for quick filtering, grouping, and bulk actions.
---
Stack Labels let you tag your Docker Compose stacks with custom colored labels like `production`, `staging`, or `media-server`. Once labeled, you can filter your stack list, identify stacks at a glance, and run bulk actions on entire groups.
<Frame>
<img src="/images/stack-labels/sidebar-with-labels.png" alt="Sidebar showing stacks with colored label dots and a label filter pill" />
</Frame>
## Creating labels
### From Settings
1. Open **Settings > Labels**
2. Click **+ New Label**
3. Enter a name and pick a color from the 10 available swatches
4. Click **Create**
<Frame>
<img src="/images/stack-labels/settings-labels.png" alt="Settings Labels section showing existing labels with assignment counts" />
</Frame>
The label list shows each label's color, name, and how many stacks are currently assigned to it. Hover over a label row to reveal **Edit** and **Delete** buttons.
<Frame>
<img src="/images/stack-labels/create-label-dialog.png" alt="Create Label dialog with name input and color picker" />
</Frame>
### From the stack context menu
You can also create labels without leaving the sidebar:
1. Right-click any stack in the sidebar
2. Hover over **Labels** to open the submenu
3. Click **Manage labels...** at the bottom to open the Labels section in Settings
### From the three-dot menu
1. Click the three-dot menu on any stack row in the sidebar
2. Click **Labels** to open the label assignment popover
3. Click **Create new label** at the bottom of the popover to create and assign in one step
## Assigning labels to stacks
There are two ways to assign labels:
**Right-click context menu:** Right-click a stack in the sidebar, hover over **Labels**, and click a label to toggle it on or off. A checkmark indicates the label is currently assigned.
<Frame>
<img src="/images/stack-labels/context-menu-labels.png" alt="Right-click context menu with Labels submenu showing assigned label with checkmark" />
</Frame>
**Three-dot menu popover:** Click the three-dot menu on a stack row, then click **Labels**. The popover shows all labels with checkmarks for assigned ones. Click any label to toggle it.
A stack can have multiple labels. Changes save immediately.
## Filtering by label
### Sidebar
When at least one label exists, a pill bar appears between the search box and the stack list. Click a label pill to filter: only stacks with that label are shown. Click multiple pills to see stacks matching **any** of the selected labels. Click an active pill again to deselect it.
<Frame>
<img src="/images/stack-labels/sidebar-filtered.png" alt="Sidebar filtered by the prod label showing only matching stacks" />
</Frame>
### Fleet View
The **Tags** filter in the [Fleet View](/features/fleet-view) toolbar lets you filter nodes by stack labels. Selecting a label filters to nodes that contain stacks with that label.
## Bulk actions
<Note>
Bulk actions on a label require a Sencho **Skipper** or **Admiral** license. Creating, assigning, and filtering by labels is available on every tier.
</Note>
Right-click a label pill in the sidebar to access bulk actions:
| Action | Effect |
|--------|--------|
| **Deploy all** | Runs deploy on every stack with that label |
| **Stop all** | Stops every stack with that label |
| **Restart all** | Restarts every stack with that label |
<Frame>
<img src="/images/stack-labels/bulk-actions-menu.png" alt="Right-click context menu on a label pill showing Deploy all, Stop all, and Restart all options" />
</Frame>
A confirmation dialog shows which stacks will be affected before executing. If any stacks fail during a bulk action, the error toast lists the specific stack names that failed. Only one bulk action can run at a time per node.
## Managing labels
Open **Settings > Labels** to view, edit, and delete your labels.
- **Edit**: Click the pencil icon on a label row to change its name or color
- **Delete**: Click the trash icon to remove the label. A confirmation dialog explains that the label will be removed from all stacks. This cannot be undone.
Label names must be unique per node. You can create up to 50 labels per node. There are 10 color options: teal, blue, purple, rose, amber, green, orange, pink, cyan, and slate.