Add TLS configuration and hardening page to the user guide - #726
Open
migiFi wants to merge 2 commits into
Open
Conversation
Adds a new top-level "Security best practices" section to the user guide with a landing page that frames secure deployment across the three Metal3 trust boundaries (BMO/control plane, Ironic, and the provisioning network), and adds the corresponding SUMMARY.md entry. **Why**: The user guide had no security or hardening section, the only security-adjacent page was the vulnerability-disclosure policy. Hardening guidance existed but was scattered across component repos and never framed as best practice. **NOTE**: This is the landing page only. It links out to the current authoritative sources for each topic (TLS configuration, certificate lifecycle, Ironic authentication, TLS-enabled PXE, namespace-scoped BMO); dedicated pages for those will follow in separate PRs. Signed-off-by: Migi Jylhä <migi.jylha@est.tech>
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
metal3-io-bot
added
the
size/L
metal3-io-bot
added
the
do-not-merge/hold
Member
|
/copilot-review |
Contributor
|
Copilot code review has been requested by @tuminoid. Please allow a few moments for the review to be added. |
There was a problem hiding this comment.
Pull request overview
Adds Ironic TLS configuration and hardening guidance to the Metal3 user guide.
Changes:
- Documents TLS surfaces, configuration flags, and a hardened baseline.
- Links the new page from the security landing page.
- Adds the page to mdBook navigation.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
docs/user-guide/src/SUMMARY.md |
Adds TLS guidance to navigation. |
docs/user-guide/src/security/tls.md |
Introduces TLS configuration and hardening documentation. |
docs/user-guide/src/security/introduction.md |
Links to the new TLS page. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Adds a "TLS Configuration and Hardening" page under the user guide's Security section. It cosolidates the Ironic TLS tuning knobs that were previously split between the ironic-image README and the IrSO deployment, explains the two TLS surfaces (Ironic API vs virtual-media HTTP server), documents the protocol/ cipher/curve flags for each, and gives a recommended hardened baseline. Also links the Security landing page's TLS bullets to this new page and adds the SUMMARY entry. **Why**: The TLS hardening flags (below) were only documented in the ironic-image README, with nothing in the user guide tying them together or recommending hardened values. - `IRONIC_SSL_PROTOCOL` - `IRONIC_TLS_12/13_CIPHERS` - `IRONIC_TLS_CURVES` - `IRONIC_TLS_ENFORCE_SERVER_CIPHER_ORDER` - `IRONIC_VMEDIA_*` (equivalents) **Depends on**: Depends on metal3-io#725 and should merge after it. /hold until then. **NOTE**: until metal3-io#725 merges, the diff includes its commits. Review only the "Add TLS configuration and hardening page" commit here. Signed-off-by: Migi Jylhä <migi.jylha@est.tech>
migiFi
force-pushed
the
docs-security-tls
branch
from
August 28, 2026 13:18
dd7cd9e to
f561ade
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a "TLS Configuration and Hardening" page under the user guide's Security section. It consolidates the Ironic TLS tuning knobs that were previously split between the ironic-image README and the IrSO deployment, explains the two TLS surfaces (Ironic API vs. virtual-media HTTP server), documents the protocol/ cipher/curve flags for each, and gives a recommended hardened baseline.
Also links the Security landing page's TLS bullet to this new page and adds the
SUMMARY entry.
Why:
The TLS hardening flags (below) were only documented in the ironic-image README, with nothing in the user guide tying them together or recommending hardened values.
IRONIC_SSL_PROTOCOLIRONIC_TLS_12/13_CIPHERSIRONIC_TLS_CURVESIRONIC_TLS_ENFORCE_SERVER_CIPHER_ORDERIRONIC_VMEDIA_*(and equivalents)Depends on #725 and should merge after it. /hold until then.
NOTE: until 725 merges, the diff includes its commits. Review only the "Add TLS configuration and hardening page" commit here.