Skip to content

Commit

Permalink
changes access management and setup keys docs and screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
juliaroesschen committed Mar 14, 2024
1 parent 84caef6 commit bb3bbe9
Show file tree
Hide file tree
Showing 7 changed files with 3 additions and 6 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/docs-static/img/how-to-guides/add-setup-key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/docs-static/img/how-to-guides/setup-key-created.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/docs-static/img/how-to-guides/setup-keys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/pages/how-to/manage-network-access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Policies act as rules governing how different resources (peers) can communicate

Policies are processed when the Management service shares a network map with all peers of your account. Because you can only create ALLOW policies, there is no processing order or priority. So, the decision to distribute peer information is based on its association with a group belonging to an existing policy.

Currently, communication between lists of groups in the source and destination fields of a policy is bidirectional for ALL and ICMP protocols. Additionally, for TCP and UDP protocols without port limitations defined, it is bidirectional, meaning that destinations can also initiate connections to a group of peers listed in the source field of the policy.
For ICMP and ALL protocols, as well as for TCP and UDP protocols **without** specific port restrictions, communication between groups listed in the source and destination fields is bidirectional. This means that both source and destination groups can initiate connections with each other. To establish one-way connections, you must specify a protocol (UDP or TCP), along with a port.

<Note>
If you need to allow peers from the same group to communicate with each other, you can do so by adding the same group to the `Source` and `Destination` lists.
Expand Down
7 changes: 2 additions & 5 deletions src/pages/how-to/register-machines-using-setup-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This makes it possible to run automated deployments with infrastructure-as-code
sudo netbird up --setup-key <SETUP KEY>
```

## Types of setup seys
## Types of setup keys

There are 2 types of setup keys:
* **One-off key**. This type of key can be used only once to authenticate a machine.
Expand Down Expand Up @@ -46,9 +46,6 @@ We recommend limiting the number of times the key can be used, e.g., set it to 3

## Peer Auto-grouping

<p>
<img src="/docs-static/img/architecture/peer-auto-tagging-setupkey.gif" alt="high-level-dia" className="imagewrapper"/>
</p>

NetBird offers a powerful [access control feature](/how-to/manage-network-access) 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.
Expand All @@ -71,7 +68,7 @@ Then use this key to enroll new machine.

## Create setup key

Click the `Add Key` button in the `Setup Keys'.
Go to the `Setup Keys` tab and click the `Create Setup Key` button
In the opened popup, give your new key an easily identifiable name, choose type, set usage limit, and assign auto groups.
The defaults should be suitable for most of the cases. We recommend using one-off keys for security reasons.

Expand Down

0 comments on commit bb3bbe9

Please sign in to comment.