Add docs for new group page (#469)

This commit is contained in:
Eduard Gert
2025-11-12 19:11:06 +01:00
committed by GitHub
parent 7eb683f617
commit d5914d893d
7 changed files with 88 additions and 9 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 128 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 120 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 147 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB

View File

@@ -1,3 +1,4 @@
import {Note} from "../../components/mdx";
# Managing Access with NetBird: Groups and Access Policies
NetBird empowers administrators to effectively manage and control access between resources (referred to as peers) using groups and access policies.
@@ -31,9 +32,9 @@ Here are some key attributes of groups:
- A single group can have multiple peers.
- Peers can be part of multiple groups simultaneously.
- Groups can be included in the 'Source' and 'Destination' lists of policies.
- Groups are generated within the 'Access Control' or 'Peers' tabs.
- Groups can be deleted in Settings > Groups
- There exists a default group called 'All'.
- Groups can be created either in `Access Control > Groups` or in places where a group input field is provided. Type the preferred group name into the input and press 'Enter' to create the new group. [Learn more](#creating-groups)
- Groups can be deleted in `Access Control > Groups` [Learn more](#deleting-groups)
- There exists a default group called `All` which cannot be deleted or renamed.
<Note>
You can assign groups automatically with the [peer auto-grouping feature](/how-to/register-machines-using-setup-keys#peer-auto-grouping).
@@ -112,12 +113,6 @@ You can assign a peer to a group by accessing the `Peers` section. Then, choose
You can assign groups automatically with the [peer auto-grouping feature](/how-to/register-machines-using-setup-keys#peer-auto-grouping).
</Note>
### Deleting Groups
You can review where groups are used and delete old ones in Settings > User Groups.
<p>
<img src="/docs-static/img/overview/delete-groups.png" alt="high-level-dia" className="imagewrapper"/>
</p>
### Updating Policies
To update a policy, just click on its name and customize it according to your requirements. This action will open the same screen where you can update policy groups, descriptions, and status, or modify allowed traffic direction, protocols with ports, and posture checks, similar to the information described in the "Creating Policies" section above.
@@ -135,3 +130,87 @@ To delete a policy, click on `Delete` in the table, and confirm the message that
<img src="/docs-static/img/overview/delete-rule-menu.png" alt="high-level-dia" className="imagewrapper"/>
</p>
## Managing Groups
### Creating Groups
You can create groups in two ways:
**Quick Creation (Inline)**<br/>
When you see a group input field anywhere in the dashboard (e.g. such as when creating policies), you can create groups directly from the input field.
1. Type your preferred group name into the input field
2. Press 'Enter' to create the new group
<p>
<img src="/docs-static/img/groups/create-group-input.png" alt="Create group inline" className="imagewrapper"/>
</p>
**From Groups Page**<br/>
1. Navigate to `Access Control` > `Groups`
2. Click the `Create Group` button
3. Provide a name for your new group
<p>
<img src="/docs-static/img/groups/create-group.png" alt="Create group from groups page" className="imagewrapper"/>
</p>
### Viewing Groups
**Groups Overview**<br/>
Navigate to `Access Control` > `Groups` to view all groups in your organization. This page shows:
- All existing groups
- Associated objects (peers, users, policies, etc.)
- Usage status (used/unused groups)
<p>
<img src="/docs-static/img/groups/view-groups.png" alt="Groups overview page" className=""/>
</p>
**Group Details**<br/>
Navigate to `Access Control` > `Groups` and then click on any group name to view detailed information and manage associated objects:
- **Users**: View, assign, or invite users to this group
- **Peers**: Manage which peers are assigned to this group
- **Policies**: See policies where this group is used as a source or destination
- **Network Resources**: View associated resources from networks
- **Network Routes**: See network routes using this group (either part of the distribution, access control, or routing peer group)
- **Nameservers**: View nameservers using this group as a distribution group
- **Setup Keys**: See setup keys with this group as an auto-assigned group
<p>
<img src="/docs-static/img/groups/view-group-detail.png" alt="Group details page" className=""/>
</p>
### Renaming Groups
1. Navigate to `Access Control` > `Groups`
2. Click the dropdown button (⋮) next to the group you want to rename
3. Select `Rename`
4. Enter the new name and click `Save`
<Note>
Groups synchronized from Identity Providers (Google Workspace, Entra ID, etc.) cannot be renamed.
</Note>
<p>
<img src="/docs-static/img/groups/rename-group.png" alt="Rename group" className=""/>
</p>
### Deleting Groups
1. Navigate to `Access Control` > `Groups`
2. Click the dropdown button (⋮) next to the group you want to delete
3. Select `Delete`
4. Confirm the action by clicking `Delete` in the confirmation dialog
<Note>
Groups synchronized from Identity Providers (Google Workspace, Entra ID, etc.) cannot be deleted.
</Note>
<Note>
Groups with active dependencies cannot be deleted. First remove all dependencies in order to delete the group.
</Note>
<p>
<img src="/docs-static/img/groups/delete-group.png" alt="Delete group" className=""/>
</p>