Skip to content

feat: add firewall explanation#286

Open
l0wl3vel wants to merge 12 commits into
mainfrom
feat/firewall-explanation
Open

feat: add firewall explanation#286
l0wl3vel wants to merge 12 commits into
mainfrom
feat/firewall-explanation

Conversation

@l0wl3vel

Copy link
Copy Markdown

Signed-off-by: Benjamin Ritter benjamin.ritter@x-cellent.com

Description

add firewall explanation

Used AI-Tools ✨

  • none used for generation

@l0wl3vel l0wl3vel requested a review from a team as a code owner June 10, 2026 15:20
@metal-robot metal-robot Bot added the area: documentation Affects the documentation area. label Jun 10, 2026
@l0wl3vel l0wl3vel force-pushed the feat/firewall-explanation branch from c3587e1 to b5c304a Compare June 10, 2026 15:25
@netlify

netlify Bot commented Jun 10, 2026

Copy link
Copy Markdown

Deploy Preview for metal-stack-io ready!

Name Link
🔨 Latest commit c3587e1
🔍 Latest deploy log https://app.netlify.com/projects/metal-stack-io/deploys/6a2980bb9406c900085df333
😎 Deploy Preview https://deploy-preview-286--metal-stack-io.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Jun 10, 2026

Copy link
Copy Markdown

Deploy Preview for metal-stack-io ready!

Name Link
🔨 Latest commit a7d4c03
🔍 Latest deploy log https://app.netlify.com/projects/metal-stack-io/deploys/6a2ffb02324a150008b6d2e1
😎 Deploy Preview https://deploy-preview-286--metal-stack-io.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@vknabel vknabel left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where possible try to avoid we and you. Try to document the facts and concepts :)

Comment thread docs/05-Concepts/03-Network/02-firewalls.md Outdated
Comment thread docs/05-Concepts/03-Network/02-firewalls.md
Comment thread docs/05-Concepts/03-Network/02-firewalls.md Outdated
Comment thread docs/05-Concepts/03-Network/02-firewalls.md Outdated
Comment thread docs/05-Concepts/03-Network/02-firewalls.md
Comment thread docs/05-Concepts/03-Network/02-firewalls.md Outdated
Comment thread docs/05-Concepts/03-Network/02-firewalls.md
l0wl3vel and others added 6 commits June 11, 2026 10:38
Signed-off-by: Benjamin Ritter <benjamin.ritter@x-cellent.com>
Co-authored-by: Valentin Knabel <dev@vknabel.com>
Co-authored-by: Valentin Knabel <dev@vknabel.com>
Co-authored-by: Valentin Knabel <dev@vknabel.com>
Signed-off-by: Benjamin Ritter <benjamin.ritter@x-cellent.com>
Signed-off-by: Benjamin Ritter <benjamin.ritter@x-cellent.com>
@l0wl3vel l0wl3vel force-pushed the feat/firewall-explanation branch from cfd2c45 to 630d4d7 Compare June 11, 2026 10:38
Signed-off-by: Benjamin Ritter <benjamin.ritter@x-cellent.com>
@l0wl3vel l0wl3vel force-pushed the feat/firewall-explanation branch from 8d610ab to 5a22d9e Compare June 11, 2026 14:24
@l0wl3vel l0wl3vel requested review from simcod and vknabel June 11, 2026 14:26
Signed-off-by: Benjamin Ritter <benjamin.ritter@x-cellent.com>
@l0wl3vel l0wl3vel force-pushed the feat/firewall-explanation branch from 5a22d9e to f89c57b Compare June 11, 2026 14:27
@l0wl3vel

Copy link
Copy Markdown
Author

Where possible try to avoid we and you. Try to document the facts and concepts :)

The Gardener project handles docs the same way

I think their reasoning, that active voice and conversational style increases readability, is sound. And looking at their docs they also mix active and passive.

Active voice is used when talking about opinions, suggestions, calls for action, task descriptions, where clarity on who the actor is important.

While they use passive when talking about facts or make statements.

@simcod simcod left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The section is not appearing in the rendered output.


In short, to offer comparable features to our current solution, we would need to disable ASIC offloading and either punt all traffic to either the weak main switch CPU, causing unpredictable performance or use specialized DPUs.

## Creating a Firewall

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea! I suggest creating an issue and leaving it out in order to merge this PR.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we remove the TODOs from the docs? I think it is sufficient to have them as issues in our repository - also for the VPN integration.

@l0wl3vel l0wl3vel Jun 15, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to keep them instead of omitting them. It shows readers that there are things missing and where the tracking issue is (with in-development changes)

Comment thread docs/05-Concepts/03-Network/02-firewalls.md Outdated
Comment thread docs/05-Concepts/03-Network/02-firewalls.md Outdated
l0wl3vel added 3 commits June 15, 2026 08:41
Signed-off-by: Benjamin Ritter <benjamin.ritter@x-cellent.com>
Signed-off-by: Benjamin Ritter <benjamin.ritter@x-cellent.com>
Signed-off-by: Benjamin Ritter <benjamin.ritter@x-cellent.com>
Comment thread docs/05-Concepts/03-Network/02-firewalls.md Outdated
@majst01

majst01 commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Nicely done already !

Comment thread docs/05-Concepts/03-Network/02-firewalls.md Outdated
Signed-off-by: Benjamin Ritter <benjamin.ritter@x-cellent.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: documentation Affects the documentation area.

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

4 participants