Skip to content

docs: restructure deployment guide#310

Open
ma-hartma wants to merge 32 commits into
mainfrom
deployment-guide-restructure
Open

docs: restructure deployment guide#310
ma-hartma wants to merge 32 commits into
mainfrom
deployment-guide-restructure

Conversation

@ma-hartma

@ma-hartma ma-hartma commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Description

We had a discussion in the team about restructuring the deployment guide.
Parts of the concept area do not belong there, but should go under the deployment guide.
For the guide not to get too bloated, this PR splits the guide into sub pages and moves parts from the concepts area to the regarding sub pages.

The concepts should come before the deployment guide, so there is a separate issue:
#312

Please do only merge this together with the concepts PR, as the changes are heavily intertwined.

Used AI-Tools ✨

  • Qwen3.6-35B (local)

References:

@metal-robot metal-robot Bot added the area: documentation Affects the documentation area. label Jun 30, 2026
@netlify

netlify Bot commented Jun 30, 2026

Copy link
Copy Markdown

Deploy Preview for metal-stack-io ready!

Name Link
🔨 Latest commit 55af781
🔍 Latest deploy log https://app.netlify.com/projects/metal-stack-io/deploys/6a5a3b7b426c58000789a2d8
😎 Deploy Preview https://deploy-preview-310--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.

Comment thread docs/04-For Operators/03-Deployment/03_control-plane.mdx
@ma-hartma
ma-hartma marked this pull request as ready for review July 1, 2026 01:47
@ma-hartma
ma-hartma requested a review from a team as a code owner July 1, 2026 01:47
@ma-hartma
ma-hartma requested a review from l0wl3vel July 1, 2026 01:49
Comment thread docs/04-For Operators/03-Deployment/02_bootstrap-infrastructure.md
Comment thread docs/04-For Operators/03-Deployment/01_guide.md Outdated
Comment thread docs/04-For Operators/03-Deployment/02_initial-cluster.md Outdated
Comment thread docs/04-For Operators/03-Deployment/03_control-plane.mdx
Comment thread docs/04-For Operators/03-Deployment/03_control-plane.mdx
Comment thread docs/04-For Operators/03-Deployment/03_control-plane.mdx
Comment thread docs/04-For Operators/03-Deployment/05_gardener.md Outdated
@ma-hartma

Copy link
Copy Markdown
Contributor Author

Thanks for all the review @simcod and @majst01!

@ma-hartma
ma-hartma force-pushed the deployment-guide-restructure branch from c534aa8 to bdb6362 Compare July 1, 2026 12:01
@ma-hartma
ma-hartma force-pushed the deployment-guide-restructure branch from 82b6b06 to a2164b5 Compare July 1, 2026 21:11
Comment thread docs/04-For Operators/03-Deployment/03_control-plane.mdx Outdated
@ma-hartma

Copy link
Copy Markdown
Contributor Author

Still working on the guide, now streamlining and connecting this to an overhauled concepts section PR.
I'll request another review once I'm finished. Thanks for the review for now!

Comment thread docs/04-For Operators/03-Deployment/01_guide.md
Comment thread docs/04-For Operators/03-Deployment/02_initial-cluster.md Outdated
@ma-hartma
ma-hartma requested review from majst01, simcod and vknabel July 7, 2026 12:33
@ma-hartma

ma-hartma commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

I am now ready for a nitpicky review. @vknabel @majst01 @simcod @l0wl3vel

I tried to improve depth and consistency. There are still blind spots like the deployment guide, but there are separate issues for that, like #247.

Just imagine a great concepts part already to be there, explaining the birds-eye-view - because this is what I am now working on. It will be the next PR to review. This PR focuses on deployment and tries not to double information, that should be under concepts.

Comment thread docs/04-For Operators/03-Deployment/01_guide.md Outdated
Comment thread docs/04-For Operators/03-Deployment/01_guide.md
Comment thread docs/04-For Operators/03-Deployment/02_bootstrap-infrastructure.md Outdated
Comment thread docs/04-For Operators/03-Deployment/02_bootstrap-infrastructure.md Outdated
Comment thread docs/04-For Operators/03-Deployment/02_bootstrap-infrastructure.md Outdated
Comment thread docs/04-For Operators/03-Deployment/05_kclm.md Outdated
Comment thread docs/04-For Operators/03-Deployment/05_kclm.md Outdated
Comment thread docs/04-For Operators/03-Deployment/05_kclm.md Outdated
Comment thread docs/04-For Operators/03-Deployment/05_kclm.md Outdated
Comment thread docs/04-For Operators/03-Deployment/05_kclm.md Outdated
Comment thread docs/04-For Operators/03-Deployment/04_partition.md

@iljarotar iljarotar 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 partition deployment looks much better already. Left a few minor remarks.

One thing I'm not sure about is whether we should include management spines and management leaves in the reference topology. There are metal-stack environments that simply have management switches without any differentiation. The role of any management switch is to relay OR answer DHCP requests from the productive switches' management interfaces as well as from the worker machines' IPMI interfaces. And they provide access to the management interfaces and IPMI interfaces. Whether or not they are split into spines and leafs is not that important.

Comment thread docs/04-For Operators/03-Deployment/04_partition.md
Comment thread docs/04-For Operators/03-Deployment/04_partition.md Outdated
- Provide destination NAT to the management server and its IPMI interface
- Provide DHCP options for Onie Boot and ZTP of the management spine
- Provide DHCP management addresses for the management spine, management server, and IPMI interfaces
- Perform Hairpin-NAT so the management server can access itself via its public IP (required by the CI runner to delegate jobs)

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.

Not sure a mgmtserver can access its public IP. I'll try that.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Came from the existing docs, just let me know.

Comment thread docs/04-For Operators/03-Deployment/04_partition.md Outdated
Comment thread docs/04-For Operators/03-Deployment/04_partition.md Outdated
Comment thread docs/04-For Operators/03-Deployment/04_partition.md
Comment thread docs/04-For Operators/03-Deployment/04_partition.md
Comment thread docs/04-For Operators/03-Deployment/04_partition.md Outdated
Comment thread docs/04-For Operators/03-Deployment/04_partition.md Outdated
Comment thread docs/04-For Operators/03-Deployment/04_partition.md Outdated
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.

5 participants