docs(DOC-1834): add Docker section and update FIPS compliance language#1630
docs(DOC-1834): add Docker section and update FIPS compliance language#1630
Conversation
- Add Docker section with mount and flags configuration methods - OpenSSL files are pre-configured in the FIPS image (no manual setup) - Update prerequisites to cover both Linux packages and Docker image - Update K8s limitation: FIPS mode is supported with Helm/Operator on a FIPS-enabled host - Rewrite intro: cleaner sentences, "certified" for OpenSSL FIPS 140-2, drop stale 140-3 claim - Rename "Suggested reading" to "Next steps" Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add page-topic-type, personas, and learning objectives metadata - Replace passive voice throughout - Replace "FIPS compliance mode" with "FIPS-compliant mode" - Fix "should not be used" → "Do not use it in a production environment" - Remove duplicate Docker image sentence from Prerequisites - Rename headings to gerund form for parallel structure - Remove trailing whitespace Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThe documentation page for FIPS compliance was updated to standardize terminology, expand deployment guidance, and restructure instructional content. The page metadata was updated with learning objectives, and terminology was refined to consistently use "FIPS-compliant" language. Docker deployment prerequisites were added, including guidance on using versioned FIPS images and Linux host requirements. The limitations section was adjusted to reflect host-level requirements for FIPS mode. A new "Configure FIPS mode with Docker" section replaced the "Suggested reading" section with concrete configuration examples, while existing reference links in the "Next steps" section were retained. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
modules/manage/pages/security/fips-compliance.adoc (1)
32-32: Use auto-title xrefs instead of hard-coded link text.Prefer
xref:...[]here for consistency with repo AsciiDoc linking conventions.Suggested doc-only refactor
-Before configuring brokers to run in FIPS mode on Linux, install the `redpanda-rpk-fips` and `redpanda-fips` xref:deploy:deployment-option/self-hosted/manual/production/production-deployment.adoc#install-redpanda-for-fips-compliance[packages]. +Before configuring brokers to run in FIPS mode on Linux, install the `redpanda-rpk-fips` and `redpanda-fips` xref:deploy:deployment-option/self-hosted/manual/production/production-deployment.adoc#install-redpanda-for-fips-compliance[]. -- Redpanda does not support PKCS#12 keys for xref:manage:security/encryption.adoc[TLS encryption] when FIPS mode is enabled. The PKCS12KDF algorithm used in PKCS#12 is not FIPS-compliant. To use Redpanda in FIPS mode with TLS enabled, configure your certificates and keys in PEM format instead. +- Redpanda does not support PKCS#12 keys for xref:manage:security/encryption.adoc[] when FIPS mode is enabled. The PKCS12KDF algorithm used in PKCS#12 is not FIPS-compliant. To use Redpanda in FIPS mode with TLS enabled, configure your certificates and keys in PEM format instead.Based on learnings: AsciiDoc linking should prefer
xref:...[]so link titles are pulled from target docs automatically.Also applies to: 40-40
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/manage/pages/security/fips-compliance.adoc` at line 32, Replace the hard-coded link text in the sentence beginning "Before configuring brokers to run in FIPS mode on Linux, install the `redpanda-rpk-fips` and `redpanda-fips` ..." with an auto-title AsciiDoc cross-reference by using xref:deploy:deployment-option/self-hosted/manual/production/production-deployment.adoc#install-redpanda-for-fips-compliance[] instead of the explicit link text; apply the same change to the other occurrence mentioned (lines 40-40) so both links use xref:...[] and pull titles automatically.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@modules/manage/pages/security/fips-compliance.adoc`:
- Line 32: Replace the hard-coded link text in the sentence beginning "Before
configuring brokers to run in FIPS mode on Linux, install the
`redpanda-rpk-fips` and `redpanda-fips` ..." with an auto-title AsciiDoc
cross-reference by using
xref:deploy:deployment-option/self-hosted/manual/production/production-deployment.adoc#install-redpanda-for-fips-compliance[]
instead of the explicit link text; apply the same change to the other occurrence
mentioned (lines 40-40) so both links use xref:...[] and pull titles
automatically.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: b3e187ec-6311-465d-b3a1-c26bd1b75e0c
📒 Files selected for processing (1)
modules/manage/pages/security/fips-compliance.adoc
2 participants
Summary
:page-topic-type:,:personas:, learning objectivesTest plan
/current/manage/security/fips-compliance/renders correctlyCloses DOC-1834
🤖 Generated with Claude Code