Add Peer auto-grouping doc

This commit is contained in:
braginini
2022-09-13 19:51:36 +02:00
parent 430ed2a860
commit 137f65976a
5 changed files with 26 additions and 0 deletions

View File

@@ -30,6 +30,10 @@ Some characteristics of groups:
- They can only be deleted via API. - They can only be deleted via API.
- There is a default group called `All`. - There is a default group called `All`.
:::tip peer auto-grouping
You can assign groups automatically with the [peer auto-grouping feature](/overview/setup-keys#peer-auto-grouping).
:::
### The All Group ### The All Group
The `All` group is a default group to which every peer in your network is automatically added to. This group cannot be modified or deleted. The `All` group is a default group to which every peer in your network is automatically added to. This group cannot be modified or deleted.
### Rules ### Rules
@@ -92,6 +96,10 @@ You can do it by accessing the `Peers` tab and clicking the `Groups` column of a
<img src="/docs/img/overview/associate-peer-groups.png" alt="high-level-dia" width="300" style={{boxShadow: '0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.19)'}} /> <img src="/docs/img/overview/associate-peer-groups.png" alt="high-level-dia" width="300" style={{boxShadow: '0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.19)'}} />
</p> </p>
:::tip peer auto-grouping
You can assign groups automatically with the [peer auto-grouping feature](/overview/setup-keys#peer-auto-grouping).
:::
### Updating Rules ### Updating Rules
To update a rule, you can click on the rule's `Name` or on either `Sources` and `Destinations` columns. You could also click the menu To update a rule, you can click on the rule's `Name` or on either `Sources` and `Destinations` columns. You could also click the menu
button of a rule and select `View`. This will open the same screen where you can update rule groups, description, or status. button of a rule and select `View`. This will open the same screen where you can update rule groups, description, or status.

View File

@@ -34,3 +34,21 @@ When revoking a key, all machines authenticated with this key will remain connec
### Expiration ### Expiration
Setup keys are set to expire after 30 days. When expired, the setup key can't be used anymore. Setup keys are set to expire after 30 days. When expired, the setup key can't be used anymore.
### Peer Auto-grouping
NetBird offers a powerful [Access Control feature](/overview/acls) that allows easy access management of your resources.
In a basic scenario, you would create multiple groups of peers and create access rules to define what groups can access each other.
Adding peers to groups might become time-consuming in large networks with dozens of machines.
<p align="center">
<img src="/docs/img/architecture/netbird-peer-auto-tagging-newkey.png" alt="high-level-dia" width="600" style={{boxShadow: '0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.19)'}} />
</p>
Starting NetBird [v0.9.2](https://github.com/netbirdio/netbird/releases), when creating or updating a setup key,
it is possible to specify a list of auto-assign groups. Every peer registered with this key will be automatically added
to these groups. All the access control rules enabled for these groups will apply automatically.
<p align="center">
<img src="/docs/img/architecture/peer-auto-tagging-setupkey.gif" alt="high-level-dia" width="800" style={{boxShadow: '0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.19)'}} />
</p>

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.0 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 70 KiB