Skip to content

Doc-748 Correct RHEL cmds for FIPS#1084

Merged
Feediver1 merged 2 commits intomainfrom
Doc-748
Apr 29, 2025
Merged

Doc-748 Correct RHEL cmds for FIPS#1084
Feediver1 merged 2 commits intomainfrom
Doc-748

Conversation

@Feediver1
Copy link
Contributor

@Feediver1 Feediver1 commented Apr 21, 2025

This pull request updates the installation instructions for Redpanda with FIPS compliance on Linux. The changes replace the use of apt with yum for package installation and update the corresponding commands and notes.

Changes to installation instructions:

  • modules/deploy/partials/linux/install-fips.adoc: Updated the installation command to use curl and yum for setting up Redpanda with FIPS compliance, replacing the previous apt-based instructions. The alternative installation note was also updated to reflect the use of yum.## Description

Resolves https://redpandadata.atlassian.net/browse/DOC-748
Review deadline: Tuesday April 22

Page previews

Install Redpanda for FIPS compliance

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions for RHEL-based systems to use yum instead of apt, providing clearer steps for Redpanda installation on RPM-based distributions. Debian/Ubuntu instructions remain unchanged.

@Feediver1 Feediver1 requested a review from a team as a code owner April 21, 2025 15:39
@netlify
Copy link

netlify bot commented Apr 21, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 4a92bb0
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/680fd2a4faf9620009ef2ef8
😎 Deploy Preview https://deploy-preview-1084--redpanda-docs-preview.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 site configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
modules/deploy/partials/linux/install-fips.adoc (1)

30-31: Ensure consistent yum flag placement and tighten script invocation
The current command is:

curl -1sLf 'https://dl.redpanda.com/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.rpm.sh' | \
sudo -E bash && sudo yum install redpanda -y

Recommendations:

  • Move the -y flag directly after install for consistency and readability:
    - sudo yum install redpanda -y
    + sudo yum install -y redpanda
  • Consider dropping -E on the sudo bash invocation to avoid unintentionally preserving user environment variables in a FIPS-sensitive context.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6bafa1a and f220867.

📒 Files selected for processing (1)
  • modules/deploy/partials/linux/install-fips.adoc (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - redpanda-docs-preview
  • GitHub Check: Header rules - redpanda-docs-preview
  • GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (1)
modules/deploy/partials/linux/install-fips.adoc (1)

34-34: Alternative install note is clear and correct
The note:

NOTE: Alternatively, you could run `sudo yum install -y redpanda-fips`, which also picks up and includes the `redpanda` install package.

is accurate and follows the non-interactive install pattern. No changes required.

@redpanda-data redpanda-data deleted a comment from coderabbitai bot Apr 21, 2025
Copy link

@KavyaShivashankar KavyaShivashankar left a comment

Choose a reason for hiding this comment

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

lgtm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 28, 2025

Walkthrough

The installation instructions for Redpanda on RHEL-based Linux systems were updated. The previous use of apt commands was replaced with steps appropriate for RPM-based distributions, specifically using a setup script and the yum package manager. The documentation now clearly distinguishes between installation steps for RHEL-based and Debian/Ubuntu systems. Notes were updated to reference the correct package manager for each system type. No changes were made to the Debian/Ubuntu instructions or to any exported or public code entities.

Changes

File(s) Change Summary
modules/deploy/partials/linux/install-fips.adoc Updated Redpanda installation instructions for RHEL-based systems to use yum and setup script instead of apt; updated related notes.

Poem

In the land of Linux, a change takes root,
RHEL now gets a yum-filled reboot.
No more apt for Redpanda’s quest,
A curl and a script now handle the rest.
Debian stays steady, instructions unchanged,
While RPMs and yum are neatly arranged.
🐇✨


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
modules/deploy/partials/linux/install-fips.adoc (1)

34-34: Nitpick: streamline the note for conciseness
Consider rephrasing to remove unnecessary words and clarify that redpanda is installed as a dependency:

- NOTE: Alternatively, you could run `sudo yum install -y redpanda-fips`, which also picks up and includes the `redpanda` install package.
+ NOTE: Alternatively, run `sudo yum install -y redpanda-fips`, which also installs the `redpanda` package as a dependency.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2e1e840 and 4a92bb0.

📒 Files selected for processing (1)
  • modules/deploy/partials/linux/install-fips.adoc (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - redpanda-docs-preview
  • GitHub Check: Header rules - redpanda-docs-preview
  • GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (1)
modules/deploy/partials/linux/install-fips.adoc (1)

30-31: Correct use of RHEL installation command
The updated instructions now properly use the Redpanda RPM setup script followed by yum install to enable FIPS mode on RHEL systems. This aligns with RHEL’s package management.

Copy link
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

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

lgtm

@Feediver1 Feediver1 merged commit 460f54a into main Apr 29, 2025
8 checks passed
@Feediver1 Feediver1 deleted the Doc-748 branch April 29, 2025 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants