Repository: redpanda-data/rp-connect-docs
Pull request #217: DOC-1171 Add FIPS compliant install
Author: login: asimms41
Created: 2025-04-09T16:46:50Z | Merged: 2025-04-25T10:12:08Z

## Description

Resolves [DOC-1171](https://redpandadata.atlassian.net/browse/DOC-1171)
Review deadline: 15th April

Related PR: [https://github.com/redpanda-data/docs/pull/1072](https://github.com/redpanda-data/docs/pull/1072)

This pull request includes updates to the documentation for Redpanda Connect, focusing on FIPS compliance. The changes add new information about installing and running `rpk` in FIPS-compliant mode.

Documentation updates:

* [`modules/get-started/pages/licensing.adoc`](diffhunk://#diff-957cb35762068e6af2e15629ce74d3142be85fc53665c9effe13e263d1c94351R21-R23): Added a reference to FIPS compliance in the enterprise features section.
* [`modules/get-started/pages/quickstarts/rpk.adoc`](diffhunk://#diff-59440aa7b0032e1e9f98d026e0685b11fa9aa60605bcf8d85d352175d7b97f6fL5-R5): Updated the guide to include instructions for installing and running `rpk` in FIPS-compliant mode. [[1]](diffhunk://#diff-59440aa7b0032e1e9f98d026e0685b11fa9aa60605bcf8d85d352175d7b97f6fL5-R5) [[2]](diffhunk://#diff-59440aa7b0032e1e9f98d026e0685b11fa9aa60605bcf8d85d352175d7b97f6fR23-R102)

## Page previews

[Get Started with Redpanda Connect using rpk](https://deploy-preview-217--redpanda-connect.netlify.app/redpanda-connect/get-started/quickstarts/rpk/#fips-compliance)

[Enterprise Licensing](https://deploy-preview-217--redpanda-connect.netlify.app/redpanda-connect/get-started/licensing/)

## Checks

- [x] New feature
- [ ] Content gap
- [ ] Support Follow-up
- [ ] Small fix (typos, links, copyedits, etc)

[DOC-1171]: https://redpandadata.atlassian.net/browse/DOC-1171?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->

## Summary by CodeRabbit

- **Documentation**
  - Added information about FIPS compliance as a new enterprise feature for Redpanda Connect.
  - Updated quickstart instructions to include steps for installing and running the `rpk` CLI in FIPS compliance mode on Linux.
  - Improved formatting of license application command examples for clarity.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->


Diff:
diff --git a/modules/get-started/pages/licensing.adoc b/modules/get-started/pages/licensing.adoc
index 2c75f54c..fbb36b02 100644
--- a/modules/get-started/pages/licensing.adoc
+++ b/modules/get-started/pages/licensing.adoc
@@ -12,6 +12,9 @@ You need a valid Enterprise Edition license to use the following enterprise feat
 | https://docs.redpanda.com/redpanda-connect/components/catalog/?support=enterprise[Enterprise connectors]
 | Additional inputs, outputs, and processors available only to enterprise customers.
 
+| xref:get-started:quickstarts/rpk.adoc#fips-compliance[FIPS compliance]
+| Run Redpanda Connect using a FIPS-compliant version of `rpk`, the Redpanda command-line interface (CLI).
+
 | xref:components:redpanda/about.adoc[Redpanda Connect configuration service]
 | A configuration block that you can use to send logs and status events to a topic on a Redpanda cluster.
 
diff --git a/modules/get-started/pages/quickstarts/rpk.adoc b/modules/get-started/pages/quickstarts/rpk.adoc
index 0dc6e0c9..266944b4 100644
--- a/modules/get-started/pages/quickstarts/rpk.adoc
+++ b/modules/get-started/pages/quickstarts/rpk.adoc
@@ -2,7 +2,7 @@
 :description: pass:q[Deploy your first pipelines using Redpanda Connect and `rpk`.]
 :page-aliases: getting_started:overview.adoc, ROOT:install.adoc, guides:getting_started.adoc
 
-This guide explains how to get started with Redpanda Connect using `rpk`, the Redpanda command-line interface (CLI).
+This guide explains how to get started with Redpanda Connect using `rpk`, the Redpanda command-line interface (CLI). You can also install and run `rpk` in <<fips-compliance,FIPS compliance mode>>.
 
 == Install
 
@@ -20,6 +20,92 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+include::components:partial$enterprise_feature_note.adoc[]
+
+To install `rpk` to run the latest version of Redpanda Connect in FIPS-compliant mode, you must install the `redpanda-rpk-fips` and `redpanda-connect-fips` packages. Both packages are built using the https://github.com/microsoft/go[Microsoft GoLang compiler^] and the https://github.com/microsoft/go-crypto-openssl[Microsoft’s Go Crypto OpenSSL package^], which uses the FIPS-approved version of OpenSSL.
+
+IMPORTANT: The packages for FIPS-compliant `rpk` (`redpanda-rpk-fips`) and Redpanda `rpk` (`redpanda-rpk`) are mutually exclusive, and so cannot be installed in the same environment.
+
+[tabs]
+=====
+RHEL::
++
+--
+. To make sure your distribution is up to date, run:
++
+[,bash]
+----
+sudo dnf upgrade
+----
+. Add `redpanda` to your `dnf` list of repositories. 
++
+[,bash]
+----
+curl -1sLf 'https://dl.redpanda.com/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.rpm.sh' | \
+sudo -E bash
+----
+. Install Redpanda packages for FIPS compliance.
++
+[,bash]
+----
+sudo dnf install -y redpanda-rpk-fips redpanda-connect-fips
+----
+
+. Verify your installation.
++
+[,bash]
+----
+rpk connect --version
+----
+
+To keep up-to-date with Redpanda Connect releases, run the following command:
+
+[,bash]
+----
+sudo dnf update
+----
+
+--
+Debian/Ubuntu::
++
+--
+. To make sure your distribution is up to date, run:
++
+[,bash]
+----
+sudo apt upgrade 
+----
+. Add `redpanda` to your `apt` list of repositories. 
++
+[,bash]
+----
+curl -1sLf 'https://dl.redpanda.com/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.deb.sh' | sudo -E bash 
+----
+. Install Redpanda packages for FIPS compliance.
++
+[,bash]
+----
+sudo apt install -y redpanda-rpk-fips redpanda-connect-fips 
+----
+. Verify your installation.
++
+[,bash]
+----
+rpk connect --version
+----
+
+To keep up-to-date with the Redpanda Connect releases, run the following command:
+
+[,bash]
+----
+sudo apt update
+----
+
+--
+=====
+
 === MacOS
 
 include::ROOT:get-started:partial$install-rpk-macos.adoc[]


Reviews:
user: login: asimms41
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-04-09T16:49:38Z
user: login: clee
state: COMMENTED
author_association: NONE
submitted_at: 2025-04-09T16:59:30Z
user: login: clee
state: COMMENTED
author_association: NONE
submitted_at: 2025-04-09T17:04:48Z
user: login: asimms41
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-04-10T12:18:18Z
user: login: asimms41
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-04-10T12:19:15Z
user: login: asimms41
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-04-10T12:19:38Z
user: login: asimms41
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-04-10T12:19:49Z
user: login: asimms41
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-04-10T12:19:59Z
user: login: clee
body: LGTM once the `redpanda-connect-fips` TODO is filled out!
state: COMMENTED
author_association: NONE
submitted_at: 2025-04-11T16:03:37Z
user: login: clee
state: COMMENTED
author_association: NONE
submitted_at: 2025-04-11T16:10:10Z
user: login: asimms41
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-04-15T10:18:41Z
user: login: asimms41
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-04-15T10:51:37Z
user: login: clee
body: LGTM
state: APPROVED
author_association: NONE
submitted_at: 2025-04-15T16:07:28Z
user: login: jrkinley
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-04-24T11:51:12Z
user: login: coderabbitai[bot]
body: **Actionable comments posted: 1**

<details>
<summary>🔭 Outside diff range comments (1)</summary><blockquote>

<details>
<summary>modules/get-started/pages/licensing.adoc (1)</summary><blockquote>

`47-52`: _⚠️ Potential issue_

**Use consistent AsciiDoc code block syntax**  
Fenced backticks (` ```bash `) diverge from the rest of the guide’s `[source,bash]` + `----` style. Convert this to a standard AsciiDoc block for consistency and proper rendering.  

Suggested refactor:
```diff
-+
-```bash
-rpk connect run --redpanda-license <license-string> ./<connect-configuration>.yaml
-```
-+
+[source,bash]
+----
+rpk connect run --redpanda-license <license-string> ./<connect-configuration>.yaml
+----
```

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

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

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between bea564f643e3fdf3a42dbb06a6d32800164cc268 and f7bcea604d861b02842ad7eba53aaa2ee6f11fe1.

</details>

<details>
<summary>📒 Files selected for processing (2)</summary>

* `modules/get-started/pages/licensing.adoc` (1 hunks)
* `modules/get-started/pages/quickstarts/rpk.adoc` (2 hunks)

</details>

<details>
<summary>🔇 Additional comments (5)</summary><blockquote>

<details>
<summary>modules/get-started/pages/quickstarts/rpk.adoc (4)</summary>

`5-5`: **Introduction updated with FIPS compliance**  
Nicely added the FIPS compliance mode call-out to the intro paragraph—this makes the new feature discoverable upfront.

---

`23-24`: **New “FIPS compliance” section heading**  
The new second-level heading (`==== FIPS compliance`) aligns with other installation subsections and is clear.

---

`25-25`: **Verify partial include path**  
The include directive uses a colon-separated path (`components:partial$enterprise_feature_note.adoc`). Please confirm that the repository layout expects `components/partial/enterprise_feature_note.adoc` or update to match the actual file path.

---

`27-30`: **Installation instructions for FIPS packages**  
Clear, concise instructions describing the mutual-exclusion of `redpanda-rpk-fips` and `redpanda-rpk`. Good enterprise feature note placement.

</details>
<details>
<summary>modules/get-started/pages/licensing.adoc (1)</summary>

`15-17`: **Added “FIPS compliance” enterprise feature row**  
The new table entry cleanly surfaces the FIPS compliance feature alongside other enterprise capabilities.

</details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-04-24T12:02:35Z
user: login: kbatuigas
body: lgtm
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-04-24T13:16:19Z

Review comments:
diff_hunk: @@ -20,6 +20,106 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+To use a FIPS-compliant version of `rpk` only, you must install the `redpanda-fips` and `redpanda-rpk-fips` packages, which are separate from but dependent on the  `redpanda` package. You must also install the `redpanda-tuners` package, and the Redpanda Connect binary.
+
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: asimms41
body: Why do users need to install the `redpanda-tuners` package?
created_at: 2025-04-09T16:49:38Z
author_association: CONTRIBUTOR
diff_hunk: @@ -20,6 +20,106 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+To use a FIPS-compliant version of `rpk` only, you must install the `redpanda-fips` and `redpanda-rpk-fips` packages, which are separate from but dependent on the  `redpanda` package. You must also install the `redpanda-tuners` package, and the Redpanda Connect binary.
+
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: clee
body: If they're installing the latest version and copy-pasting from these instructions, then technically they don't need to mention redpanda-tuner since it should get pulled in as a dependency automatically.

Also, while we're removing mention of not-fully-necessary packages… technically the redpanda server (and by extension redpanda-fips) isn't required for rpk or rpk-fips to install/run.
created_at: 2025-04-09T16:59:30Z
author_association: NONE
diff_hunk: @@ -20,6 +20,106 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+To use a FIPS-compliant version of `rpk` only, you must install the `redpanda-fips` and `redpanda-rpk-fips` packages, which are separate from but dependent on the  `redpanda` package. You must also install the `redpanda-tuners` package, and the Redpanda Connect binary.
+
+For full information about the contents of FIPS packages, see xref:ROOT:deploy:deployment-option/self-hosted/manual/production/dev-deployment.adoc#install-redpanda-for-fips-compliance[Install Redpanda for FIPS compliance].
+
+[tabs]
+=====
+RHEL::
++
+--
+Replace all `<version>` placeholders with the full version number, for example: `4.50.0`.
+
+. To make sure your distribution is up to date, run:
++
+[,bash]
+----
+sudo dnf upgrade
+----
+. Add `redpanda` to your `dnf` list of repositories. 
++
+[,bash]
+----
+curl -1sLf 'https://dl.redpanda.com/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.rpm.sh' | \
+sudo -E bash
+----
+. Install Redpanda packages for FIPS compliance.
++
+[,bash]
+----
+sudo dnf install -y redpanda redpanda-tuner redpanda-fips redpanda-rpk-fips 
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: clee
body: Also, fun fact! You can add `redpanda-connect-fips` to the end of this package list and it will work since we also publish the redpanda-connect-fips RPM and deb packages to our main cloudsmith archive.
created_at: 2025-04-09T17:02:32Z
author_association: NONE
diff_hunk: @@ -20,6 +20,106 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+To use a FIPS-compliant version of `rpk` only, you must install the `redpanda-fips` and `redpanda-rpk-fips` packages, which are separate from but dependent on the  `redpanda` package. You must also install the `redpanda-tuners` package, and the Redpanda Connect binary.
+
+For full information about the contents of FIPS packages, see xref:ROOT:deploy:deployment-option/self-hosted/manual/production/dev-deployment.adoc#install-redpanda-for-fips-compliance[Install Redpanda for FIPS compliance].
+
+[tabs]
+=====
+RHEL::
++
+--
+Replace all `<version>` placeholders with the full version number, for example: `4.50.0`.
+
+. To make sure your distribution is up to date, run:
++
+[,bash]
+----
+sudo dnf upgrade
+----
+. Add `redpanda` to your `dnf` list of repositories. 
++
+[,bash]
+----
+curl -1sLf 'https://dl.redpanda.com/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.rpm.sh' | \
+sudo -E bash
+----
+. Install Redpanda packages for FIPS compliance.
++
+[,bash]
+----
+sudo dnf install -y redpanda redpanda-tuner redpanda-fips redpanda-rpk-fips 
+----
+. Download the Redpanda Connect binary.
++
+[,bash]
+----
+curl -LO https://github.com/redpanda-data/connect/releases/download/v<version>/redpanda-connect-fips-<version>-1.x86_64.rpm
+----
+
+. Install the downloaded binary.
++
+[,bash]
+----
+sudo dnf install ./redpanda-connect-fips-<version>-1.x86_64.rpm
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: clee
body: Which means you could delete all this.
created_at: 2025-04-09T17:03:46Z
author_association: NONE
diff_hunk: @@ -20,6 +20,106 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+To use a FIPS-compliant version of `rpk` only, you must install the `redpanda-fips` and `redpanda-rpk-fips` packages, which are separate from but dependent on the  `redpanda` package. You must also install the `redpanda-tuners` package, and the Redpanda Connect binary.
+
+For full information about the contents of FIPS packages, see xref:ROOT:deploy:deployment-option/self-hosted/manual/production/dev-deployment.adoc#install-redpanda-for-fips-compliance[Install Redpanda for FIPS compliance].
+
+[tabs]
+=====
+RHEL::
++
+--
+Replace all `<version>` placeholders with the full version number, for example: `4.50.0`.
+
+. To make sure your distribution is up to date, run:
++
+[,bash]
+----
+sudo dnf upgrade
+----
+. Add `redpanda` to your `dnf` list of repositories. 
++
+[,bash]
+----
+curl -1sLf 'https://dl.redpanda.com/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.rpm.sh' | \
+sudo -E bash
+----
+. Install Redpanda packages for FIPS compliance.
++
+[,bash]
+----
+sudo dnf install -y redpanda redpanda-tuner redpanda-fips redpanda-rpk-fips 
+----
+. Download the Redpanda Connect binary.
++
+[,bash]
+----
+curl -LO https://github.com/redpanda-data/connect/releases/download/v<version>/redpanda-connect-fips-<version>-1.x86_64.rpm
+----
+
+. Install the downloaded binary.
++
+[,bash]
+----
+sudo dnf install ./redpanda-connect-fips-<version>-1.x86_64.rpm
+----
+. Verify your installation.
++
+[,bash]
+----
+rpk connect --version
+----
+
+--
+Debian/Ubuntu::
++
+--
+Replace all `<version>` placeholders with the full version number, for example: `4.50.0`.
+
+. To make sure your distribution is up to date, run:
++
+[,bash]
+----
+sudo apt upgrade 
+----
+. Add `redpanda` to your `apt` list of repositories. 
++
+[,bash]
+----
+curl -1sLf 'https://dl.redpanda.com/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.deb.sh' | sudo -E bash 
+----
+. Install Redpanda packages for FIPS compliance.
++
+[,bash]
+----
+sudo apt install -y redpanda redpanda-tuner redpanda-fips redpanda-rpk-fips 
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: clee
body: Similarly, you can add `redpanda-connect-fips` to the package list here…
created_at: 2025-04-09T17:04:24Z
author_association: NONE
diff_hunk: @@ -20,6 +20,106 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+To use a FIPS-compliant version of `rpk` only, you must install the `redpanda-fips` and `redpanda-rpk-fips` packages, which are separate from but dependent on the  `redpanda` package. You must also install the `redpanda-tuners` package, and the Redpanda Connect binary.
+
+For full information about the contents of FIPS packages, see xref:ROOT:deploy:deployment-option/self-hosted/manual/production/dev-deployment.adoc#install-redpanda-for-fips-compliance[Install Redpanda for FIPS compliance].
+
+[tabs]
+=====
+RHEL::
++
+--
+Replace all `<version>` placeholders with the full version number, for example: `4.50.0`.
+
+. To make sure your distribution is up to date, run:
++
+[,bash]
+----
+sudo dnf upgrade
+----
+. Add `redpanda` to your `dnf` list of repositories. 
++
+[,bash]
+----
+curl -1sLf 'https://dl.redpanda.com/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.rpm.sh' | \
+sudo -E bash
+----
+. Install Redpanda packages for FIPS compliance.
++
+[,bash]
+----
+sudo dnf install -y redpanda redpanda-tuner redpanda-fips redpanda-rpk-fips 
+----
+. Download the Redpanda Connect binary.
++
+[,bash]
+----
+curl -LO https://github.com/redpanda-data/connect/releases/download/v<version>/redpanda-connect-fips-<version>-1.x86_64.rpm
+----
+
+. Install the downloaded binary.
++
+[,bash]
+----
+sudo dnf install ./redpanda-connect-fips-<version>-1.x86_64.rpm
+----
+. Verify your installation.
++
+[,bash]
+----
+rpk connect --version
+----
+
+--
+Debian/Ubuntu::
++
+--
+Replace all `<version>` placeholders with the full version number, for example: `4.50.0`.
+
+. To make sure your distribution is up to date, run:
++
+[,bash]
+----
+sudo apt upgrade 
+----
+. Add `redpanda` to your `apt` list of repositories. 
++
+[,bash]
+----
+curl -1sLf 'https://dl.redpanda.com/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.deb.sh' | sudo -E bash 
+----
+. Install Redpanda packages for FIPS compliance.
++
+[,bash]
+----
+sudo apt install -y redpanda redpanda-tuner redpanda-fips redpanda-rpk-fips 
+----
+. Download the Redpanda Connect binary.
++
+[,bash]
+----
+curl -LO https://github.com/redpanda-data/connect/releases/download/v<version>/redpanda-connect-fips_<version>_amd64.deb
+----
+
+. Install the downloaded binary.
++
+[,bash]
+----
+sudo dpkg -i redpanda-connect-fips_<version>_amd64.deb
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: clee
body: And then delete all this too!
created_at: 2025-04-09T17:04:42Z
author_association: NONE
diff_hunk: @@ -20,6 +20,106 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+To use a FIPS-compliant version of `rpk` only, you must install the `redpanda-fips` and `redpanda-rpk-fips` packages, which are separate from but dependent on the  `redpanda` package. You must also install the `redpanda-tuners` package, and the Redpanda Connect binary.
+
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: asimms41
body: I've updated this now to be the bare minimum. But, for upgrade, users would still need to download and install the binary, wouldn't they? If so, I'll update the upgrades page as well.
created_at: 2025-04-10T12:18:18Z
author_association: CONTRIBUTOR
diff_hunk: @@ -20,6 +20,86 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+include::components:partial$enterprise_feature_note.adoc[]
+
+To install `rpk` to run the latest version of Redpanda Connect in FIPS-compliant mode, you must install the `redpanda-rpk-fips` and `redpanda-connect-fips` packages.
+
+`redpanda-rpk-fips`
+
+Contains a version of `rpk` built with the https://github.com/microsoft/go[Microsoft GoLang compiler^] and https://github.com/microsoft/go-crypto-openssl[Microsoft’s Go Crypto OpenSSL package^] to which `rpk` is linked, and uses the FIPS-approved version of OpenSSL.
+
+`redpanda-connect-fips`
+
+TODO
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: asimms41
body: What makes the `redpanda-connect-fips` package FIPS-compliant?
created_at: 2025-04-10T12:19:15Z
author_association: CONTRIBUTOR
diff_hunk: @@ -20,6 +20,106 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+To use a FIPS-compliant version of `rpk` only, you must install the `redpanda-fips` and `redpanda-rpk-fips` packages, which are separate from but dependent on the  `redpanda` package. You must also install the `redpanda-tuners` package, and the Redpanda Connect binary.
+
+For full information about the contents of FIPS packages, see xref:ROOT:deploy:deployment-option/self-hosted/manual/production/dev-deployment.adoc#install-redpanda-for-fips-compliance[Install Redpanda for FIPS compliance].
+
+[tabs]
+=====
+RHEL::
++
+--
+Replace all `<version>` placeholders with the full version number, for example: `4.50.0`.
+
+. To make sure your distribution is up to date, run:
++
+[,bash]
+----
+sudo dnf upgrade
+----
+. Add `redpanda` to your `dnf` list of repositories. 
++
+[,bash]
+----
+curl -1sLf 'https://dl.redpanda.com/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.rpm.sh' | \
+sudo -E bash
+----
+. Install Redpanda packages for FIPS compliance.
++
+[,bash]
+----
+sudo dnf install -y redpanda redpanda-tuner redpanda-fips redpanda-rpk-fips 
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: asimms41
body: Updated.
created_at: 2025-04-10T12:19:38Z
author_association: CONTRIBUTOR
diff_hunk: @@ -20,6 +20,106 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+To use a FIPS-compliant version of `rpk` only, you must install the `redpanda-fips` and `redpanda-rpk-fips` packages, which are separate from but dependent on the  `redpanda` package. You must also install the `redpanda-tuners` package, and the Redpanda Connect binary.
+
+For full information about the contents of FIPS packages, see xref:ROOT:deploy:deployment-option/self-hosted/manual/production/dev-deployment.adoc#install-redpanda-for-fips-compliance[Install Redpanda for FIPS compliance].
+
+[tabs]
+=====
+RHEL::
++
+--
+Replace all `<version>` placeholders with the full version number, for example: `4.50.0`.
+
+. To make sure your distribution is up to date, run:
++
+[,bash]
+----
+sudo dnf upgrade
+----
+. Add `redpanda` to your `dnf` list of repositories. 
++
+[,bash]
+----
+curl -1sLf 'https://dl.redpanda.com/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.rpm.sh' | \
+sudo -E bash
+----
+. Install Redpanda packages for FIPS compliance.
++
+[,bash]
+----
+sudo dnf install -y redpanda redpanda-tuner redpanda-fips redpanda-rpk-fips 
+----
+. Download the Redpanda Connect binary.
++
+[,bash]
+----
+curl -LO https://github.com/redpanda-data/connect/releases/download/v<version>/redpanda-connect-fips-<version>-1.x86_64.rpm
+----
+
+. Install the downloaded binary.
++
+[,bash]
+----
+sudo dnf install ./redpanda-connect-fips-<version>-1.x86_64.rpm
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: asimms41
body: Updated.
created_at: 2025-04-10T12:19:49Z
author_association: CONTRIBUTOR
diff_hunk: @@ -20,6 +20,106 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+To use a FIPS-compliant version of `rpk` only, you must install the `redpanda-fips` and `redpanda-rpk-fips` packages, which are separate from but dependent on the  `redpanda` package. You must also install the `redpanda-tuners` package, and the Redpanda Connect binary.
+
+For full information about the contents of FIPS packages, see xref:ROOT:deploy:deployment-option/self-hosted/manual/production/dev-deployment.adoc#install-redpanda-for-fips-compliance[Install Redpanda for FIPS compliance].
+
+[tabs]
+=====
+RHEL::
++
+--
+Replace all `<version>` placeholders with the full version number, for example: `4.50.0`.
+
+. To make sure your distribution is up to date, run:
++
+[,bash]
+----
+sudo dnf upgrade
+----
+. Add `redpanda` to your `dnf` list of repositories. 
++
+[,bash]
+----
+curl -1sLf 'https://dl.redpanda.com/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.rpm.sh' | \
+sudo -E bash
+----
+. Install Redpanda packages for FIPS compliance.
++
+[,bash]
+----
+sudo dnf install -y redpanda redpanda-tuner redpanda-fips redpanda-rpk-fips 
+----
+. Download the Redpanda Connect binary.
++
+[,bash]
+----
+curl -LO https://github.com/redpanda-data/connect/releases/download/v<version>/redpanda-connect-fips-<version>-1.x86_64.rpm
+----
+
+. Install the downloaded binary.
++
+[,bash]
+----
+sudo dnf install ./redpanda-connect-fips-<version>-1.x86_64.rpm
+----
+. Verify your installation.
++
+[,bash]
+----
+rpk connect --version
+----
+
+--
+Debian/Ubuntu::
++
+--
+Replace all `<version>` placeholders with the full version number, for example: `4.50.0`.
+
+. To make sure your distribution is up to date, run:
++
+[,bash]
+----
+sudo apt upgrade 
+----
+. Add `redpanda` to your `apt` list of repositories. 
++
+[,bash]
+----
+curl -1sLf 'https://dl.redpanda.com/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.deb.sh' | sudo -E bash 
+----
+. Install Redpanda packages for FIPS compliance.
++
+[,bash]
+----
+sudo apt install -y redpanda redpanda-tuner redpanda-fips redpanda-rpk-fips 
+----
+. Download the Redpanda Connect binary.
++
+[,bash]
+----
+curl -LO https://github.com/redpanda-data/connect/releases/download/v<version>/redpanda-connect-fips_<version>_amd64.deb
+----
+
+. Install the downloaded binary.
++
+[,bash]
+----
+sudo dpkg -i redpanda-connect-fips_<version>_amd64.deb
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: asimms41
body: Updated.
created_at: 2025-04-10T12:19:59Z
author_association: CONTRIBUTOR
diff_hunk: @@ -20,6 +20,86 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+include::components:partial$enterprise_feature_note.adoc[]
+
+To install `rpk` to run the latest version of Redpanda Connect in FIPS-compliant mode, you must install the `redpanda-rpk-fips` and `redpanda-connect-fips` packages.
+
+`redpanda-rpk-fips`
+
+Contains a version of `rpk` built with the https://github.com/microsoft/go[Microsoft GoLang compiler^] and https://github.com/microsoft/go-crypto-openssl[Microsoft’s Go Crypto OpenSSL package^] to which `rpk` is linked, and uses the FIPS-approved version of OpenSSL.
+
+`redpanda-connect-fips`
+
+TODO
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: clee
body: `redpanda-connect-fips` is also built using Microsoft's fork of the GoLang compiler and uses the exact same libraries (including OpenSSL) as `redpanda-rpk-fips`, which is why it requires `redpanda-rpk-fips` to be installed in order to work properly.
created_at: 2025-04-11T16:02:37Z
author_association: NONE
diff_hunk: @@ -20,6 +20,106 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+To use a FIPS-compliant version of `rpk` only, you must install the `redpanda-fips` and `redpanda-rpk-fips` packages, which are separate from but dependent on the  `redpanda` package. You must also install the `redpanda-tuners` package, and the Redpanda Connect binary.
+
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: clee
body: For upgrades, users should automatically get upgraded versions of both `redpanda-rpk-fips` and `redpanda-connect-fips` through yum/dnf or apt updates as time goes on.
created_at: 2025-04-11T16:10:10Z
author_association: NONE
diff_hunk: @@ -20,6 +20,86 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+include::components:partial$enterprise_feature_note.adoc[]
+
+To install `rpk` to run the latest version of Redpanda Connect in FIPS-compliant mode, you must install the `redpanda-rpk-fips` and `redpanda-connect-fips` packages.
+
+`redpanda-rpk-fips`
+
+Contains a version of `rpk` built with the https://github.com/microsoft/go[Microsoft GoLang compiler^] and https://github.com/microsoft/go-crypto-openssl[Microsoft’s Go Crypto OpenSSL package^] to which `rpk` is linked, and uses the FIPS-approved version of OpenSSL.
+
+`redpanda-connect-fips`
+
+TODO
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: asimms41
body: Updated.
created_at: 2025-04-15T10:18:41Z
author_association: CONTRIBUTOR
diff_hunk: @@ -20,6 +20,106 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+To use a FIPS-compliant version of `rpk` only, you must install the `redpanda-fips` and `redpanda-rpk-fips` packages, which are separate from but dependent on the  `redpanda` package. You must also install the `redpanda-tuners` package, and the Redpanda Connect binary.
+
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: asimms41
body: I've updated the install instructions to include a line about keeping up-to-date with releases.
created_at: 2025-04-15T10:51:37Z
author_association: CONTRIBUTOR
diff_hunk: @@ -20,6 +20,92 @@ If you want to use `rpk` to also communicate with a Redpanda cluster, ensure the
 
 include::ROOT:get-started:partial$install-rpk-linux.adoc[]
 
+==== FIPS compliance
+
+include::components:partial$enterprise_feature_note.adoc[]
+
+To install `rpk` to run the latest version of Redpanda Connect in FIPS-compliant mode, you must install the `redpanda-rpk-fips` and `redpanda-connect-fips` packages. Both packages are built using the https://github.com/microsoft/go[Microsoft GoLang compiler^] and the https://github.com/microsoft/go-crypto-openssl[Microsoft’s Go Crypto OpenSSL package^], which uses the FIPS-approved version of OpenSSL.
+
+IMPORTANT: The packages for FIPS-compliant `rpk` (`redpanda-rpk-fips`) and Redpanda `rpk` (`redpanda-rpk`) are mutually exclusive, and so cannot be installed in the same environment.
+
+[tabs]
+=====
+RHEL::
++
+--
+. To make sure your distribution is up to date, run:
path: modules/get-started/pages/quickstarts/rpk.adoc
user: login: coderabbitai[bot]
body: _⚠️ Potential issue_

**Remove stray diff markers**  
There are stray `--` lines that look like diff artifacts and will render incorrectly in AsciiDoc. These should be removed so that each tab panel flows properly.  

Apply this diff:
```diff
@@ -34,5 +34,4 @@
-RHEL::
-+
---
 . To make sure your distribution is up to date, run:
+
@@ -70,5 +69,4 @@
-Debian/Ubuntu::
-+
---
 . To make sure your distribution is up to date, run:
+
```



Also applies to: 70-73

<!-- This is an auto-generated comment by CodeRabbit -->
created_at: 2025-04-24T12:02:34Z
author_association: CONTRIBUTOR

PR comments:
user: login: netlify[bot]
created_at: 2025-04-09T16:47:07Z
body: ### <span aria-hidden="true">✅</span> Deploy Preview for *redpanda-connect* ready!


|  Name | Link |
|:-:|------------------------|
|<span aria-hidden="true">🔨</span> Latest commit |  |
|<span aria-hidden="true">🔍</span> Latest deploy log | https://app.netlify.com/sites/redpanda-connect/deploys/680b5edefbde472404b8ffd9 |
|<span aria-hidden="true">😎</span> Deploy Preview | [https://deploy-preview-217--redpanda-connect.netlify.app](https://deploy-preview-217--redpanda-connect.netlify.app) |
|<span aria-hidden="true">📱</span> Preview on mobile | <details><summary> Toggle QR Code... </summary><br /><br />![QR Code](https://app.netlify.com/qr-code/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1cmwiOiJodHRwczovL2RlcGxveS1wcmV2aWV3LTIxNy0tcmVkcGFuZGEtY29ubmVjdC5uZXRsaWZ5LmFwcCJ9.9DrfEHIfXihvzy5YRf2bLQ73aGnRsaXT49-uRS1toAw)<br /><br />_Use your smartphone camera to open QR code link._</details> |
---
<!-- [redpanda-connect Preview](https://deploy-preview-217--redpanda-connect.netlify.app) -->
_To edit notification comments on pull requests, go to your [Netlify site configuration](https://app.netlify.com/sites/redpanda-connect/configuration/notifications#deploy-webhooks)._
author_association: NONE
user: login: hyperlint-ai-deprecated[bot]
created_at: 2025-04-09T16:47:11Z
body: ## PR Change Summary

Added instructions for installing Redpanda in FIPS compliance mode, enhancing security options for users.
- Introduced FIPS compliance installation instructions for `rpk`.
- Updated the installation guide to include FIPS-specific packages and commands.
- Provided detailed steps for both RHEL and Debian/Ubuntu systems.


**Modified Files**

- `modules/get-started/pages/quickstarts/rpk.adoc`


 







---

<details>

<summary>How can I customize these reviews?</summary>

Check out the [Hyperlint AI Reviewer docs](https://docs.hyperlint.com/guides/ai-reviewer/) for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the `hyperlint-ignore` label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add `hyperlint-ignore` to the PR to ignore the link check for this PR.
</details>
author_association: NONE
user: login: coderabbitai[bot]
created_at: 2025-04-24T12:01:08Z
body: <!-- This is an auto-generated comment: summarize by coderabbit.ai -->
<!-- walkthrough_start -->

## Walkthrough

The documentation for Redpanda Connect was updated to introduce and describe support for FIPS compliance as an enterprise feature. The licensing documentation now lists FIPS compliance as a feature and corrects the formatting of a license application command. The quickstart guide for the `rpk` CLI was expanded with a new section detailing the installation and usage of FIPS-compliant binaries on Linux, including step-by-step instructions for both RHEL and Debian/Ubuntu distributions. No changes were made to code, logic, or public APIs—only documentation was affected.

## Changes

| File(s)                                                         | Change Summary                                                                                                                      |
|-----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| modules/get-started/pages/licensing.adoc                        | Added FIPS compliance as an enterprise feature; fixed code block formatting for license application command.                        |
| modules/get-started/pages/quickstarts/rpk.adoc                  | Updated introduction and added a new section with detailed instructions for installing and running FIPS-compliant `rpk` binaries.   |

## Poem

> In docs, a new compliance shines bright,  
> FIPS support now listed, clear in sight.  
> With step-by-step guides for Linux to see,  
> Secure `rpk` runs as easy as can be.  
> A code block fixed, a feature added—hooray!  
> The bunnies of Redpanda hop and say:  
> "Secure and compliant, we’re ready today!" 🐇✨

<!-- walkthrough_end -->
<!-- internal state start -->


<!-- DwQgtGAEAqAWCWBnSTIEMB26CuAXA9mAOYCmGJATmriQCaQDG+Ats2bgFyQAOFk+AIwBWJBrngA3EsgEBPRvlqU0AgfFwA6NPEgQAfACgjoCEYDEZyAAUASpETZWaCrKNxU3bABsvkCiQBHbGlcABpIcVwvOkgAIgARAHkAYTAARjSAdjTIAEFaegAxAEkrAGUFZm4veExcFAxEXDQfUNj7bAFmdRp6OUhsREp0RHhWRAAWNPDsblpqaQjYEkgbOm5Mechk/AxyMUhafAZHdmp4XYj8BoYvbCUGgDN8CmZzy5V8PAamlpqMIjoDD0CjYPbwAFLFYAAwo3AA1tCrvhfBDICVymAmFUanVIMxFCQNDBloxYJhSMg0AV/IhkLhSQApeBUFB04KQJKpDLZIH0clSdB+EgSeAkADuhxI1P+K3wjzyvHgvjSAFYGcS3KSjic2BhmuJLrN5jRkBDbvcSBwjFB8rQIYC0MLHpQyAwVgR0aUKtjqrUMO6GlDIOxKEqhpAXdRsLT7KJDVh5cGau7Gg6eGhSJAABTQgm0bzSAD0pFwYF+FF6RY2lKLKbIowBWh10IAlBoDFAAKpzc6QhkrILwBjwiv1IjYeAPZ58WEIpG5/OFxAlkhlsd0auZ4tDkdjldw+HN45tyDi9SwH64UFiC6NfhYWD4SWeiG/Hx8vxgyBzxFBp0YmUWIsH6eJvHslAdgYcArJ4H7+EEIRssKXgLPQnqYPgA58LYQYDvi2hYGstAbMCTo6qc+rvFg/jcPgowEC4OYANo6sguFmGkAAMmQAEwALrZrAuC4NwiAcEWJYXp0GjYkW/gkZsaBgCaaBFmx1beF4RbcXxrbtkYVjbjw/iihKyAzsGxpoYcxyUQad7oP46ASNoqECNEkYvMGsQAOJrpAZTNJWMTngyqzrEp2y7Ps9SDOmh7tLuo7BfUmw+QAovqYYUEgKwADLDg2DrtDWRIkisuGoG8FDwjEaBUpA5CSlGuAxis6VHIsGBYTcdwPEw2X6pARBoGJ4QONwdGVl5PjPmAszhN53Q9XwjzwAAHtIUH6MY4BQGQ9BJmgeCEKQ5BUL0lR6pwJn8MI8aSIs/RMEoVCqOoWg6LtJhQO4ZpUlgJ0EMQZDKFd2I3VwVCSg4ThMS9hLvWomjaLoYCGHtpgGEu0QrqW5apZuZUrvWaZNtSxzWrENMGBYeTFKDF02XDNXyEmDDkgC0haisFE3dRZ4NQMvZXa+Ab9R1TUSiG2VwrlEate1svXvIlmxIBlSgQGJBtFKiAMLlaj9qSKjKuo8ieqCRGRWR0UQQc8WQgB3rATi/r1FIFCjJcSb4b+SLJPlxTEna6h3n8sjhE63R0umr0rB5xzwgRtXDOKwvUko9DOF8wLBiQG1oDiKyQ+llljdUsjpk6ZMRk0uWQqKTq/goDv1Nb6MKaR8xgHXKzAP3hON0QeiQBoRbAINsXARg60Tpdd56BosjF140LhA2Mbprw+DcMMM5vCJDrEgActcnMUos4qugRDyevhXj4EQw78Hwb7Xtgt67PSyzMEMXgpCICWhgLw8hMDoAKOHS4D9SRK2cjUJon4nSH2oOISE60NpeT4I/IqjQOpTRTILMuwIoLmEsLkLwNBF4/yuMGJQtxnDUWQEmQu00rreU8B5V+7Bw48wMOfcgHYaaxBtNjXGxYCYbloFuWsyV9zyQRMeBg1Nab01yIzc64MYis2cOzBUl9uaIF5rZXUZwEzYODAHbYwc8KkmIj3J0Ox26QHkalEak4HgZ2QIXGgwIYjiwtA8D+N4EwWW8h/P4Nd87WwwOmaxaJNa+lxDrfEhJiQwQaNeRQX9GLyA2FQIgVBuCXm8SLE0ATrg3UcgyVAzVGBjTNjUXAshQ7S1ho9GB6hoj0A1t6LWKT3TtDKVnGIYI3rBkKhgbAWDIk+EFiE3Jd5gF9XuNElWOU8qRmlG1ZyPUaAZIQMgIY38sBKGaMqX+KwEKTn8DdOhczfD4WYHgbAkcQwbQtKMQUsJba90PGAdaYkkTpV+YpMis8Z5AsQEiDYI5twrPFAgTmTlE6TioQMRsgIACyw4KD0XlLgQAmATIF8hfECyphjpTJdsFw3BPSJH3hgMoZR8oZnhVmMKl5AJgErviqQ9BGVkBZflQ5KwTkWN3qKJQxySAFIWPYGg3AwByEJnKq8fwFmNE/qc8JfAbAAAkMpsvSvEEgahMBFi7AIMEbVDhIGvPAG1YTwjmn6vHFg4FaD0muNZGgwZECyCaCQZg0cCjBgcVFWi9F1AvCjhqj8+EeXJI9uy+ECLwhe3gI8S2pJHnUWjvnOq6r8JwvTZSEWdCKlnwvlzCtN9nJvHvtcfC2K0AMESBUby8Rk7DHzRYxZuq350NLfAfespMXGULsXao20jDkLyFQ8GyyR3alEKhGh95WEbXYTEThnQUwqz4cYzskBz5kivj6j5u6jp8C4Ye3h4hFgOBRcLR4YJdWurlo8dt0glp8CIE/AQLRICuVyioPGZ5b5NpIAAbnodmhUuwwFpPtOtRY/NzGOUGn4zQBgRFiMxr9WWR0FTAzOmDS6MRIbsGhmgWGjg2aQERm9FQKMvro0MMRyG6gAD6U5EC8dMmKG+tBeNjk41jKAjxMgCHdGgAAbFxCYtAAAcCm0gCC4rxVTExeLUkyOatAqoADMaBzO8RICQBTjwMguhyLtAw3HPV8YE0JkUIm6C8cOpxoAA -->

<!-- internal state end -->
<!-- tips_start -->

---



<details>
<summary>🪧 Tips</summary>

### Chat

There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai?utm_source=oss&utm_medium=github&utm_campaign=redpanda-data/rp-connect-docs&utm_content=217):

- 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](https://docs.coderabbit.ai/finishing-touches/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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit.
- Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback.
- Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

</details>

<!-- tips_end -->
author_association: CONTRIBUTOR