diff --git a/docs/overview/acls.md b/docs/overview/acls.md index cc4dcc35..46c191d0 100644 --- a/docs/overview/acls.md +++ b/docs/overview/acls.md @@ -30,6 +30,10 @@ Some characteristics of groups: - They can only be deleted via API. - 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 is a default group to which every peer in your network is automatically added to. This group cannot be modified or deleted. ### Rules @@ -92,6 +96,10 @@ You can do it by accessing the `Peers` tab and clicking the `Groups` column of a high-level-dia

+:::tip peer auto-grouping +You can assign groups automatically with the [peer auto-grouping feature](/overview/setup-keys#peer-auto-grouping). +::: + ### 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 button of a rule and select `View`. This will open the same screen where you can update rule groups, description, or status. diff --git a/docs/overview/setup-keys.md b/docs/overview/setup-keys.md index b095ae20..cae43e31 100644 --- a/docs/overview/setup-keys.md +++ b/docs/overview/setup-keys.md @@ -34,3 +34,28 @@ When revoking a key, all machines authenticated with this key will remain connec ### Expiration Setup keys are set to expire after 30 days. When expired, the setup key can't be used anymore. + +### Peer Auto-grouping + +

+ high-level-dia +

+ +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. + +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. + +To add `Auto-assign groups`, open the `Setup Keys` tab and create or update any existing setup key. +The use this key to enroll new machine. + +

+ high-level-dia +

+ +:::note +Auto-assign groups will apply only to newly registered machines. +::: \ No newline at end of file diff --git a/static/img/architecture/netbird-peer-auto-tagging-newkey.png b/static/img/architecture/netbird-peer-auto-tagging-newkey.png new file mode 100644 index 00000000..5be065eb Binary files /dev/null and b/static/img/architecture/netbird-peer-auto-tagging-newkey.png differ diff --git a/static/img/architecture/peer-auto-tagging-setupkey.gif b/static/img/architecture/peer-auto-tagging-setupkey.gif new file mode 100644 index 00000000..e9902166 Binary files /dev/null and b/static/img/architecture/peer-auto-tagging-setupkey.gif differ diff --git a/static/img/architecture/setup-keys.png b/static/img/architecture/setup-keys.png index 661701fb..1b703d86 100644 Binary files a/static/img/architecture/setup-keys.png and b/static/img/architecture/setup-keys.png differ