Skip to content

Add files via upload#2908

Merged
manojs1978 merged 7 commits into
mainfrom
manojs1978-flexdoc-updatesfor-debian
Jun 26, 2026
Merged

Add files via upload#2908
manojs1978 merged 7 commits into
mainfrom
manojs1978-flexdoc-updatesfor-debian

Conversation

@manojs1978

@manojs1978 manojs1978 commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Added a complete Debian installation guide for Gluu Flex, including Debian 13 support, prerequisites, package download and signature/integrity verification, setup and post-install access checks, HTTPS guidance, and a full uninstall process.
    • Updated the RHEL installation step to use the EL9 release RPM instead of EL8.

Signed-off-by: manoj suryawanshi <manojsurya78@gmail.com>
@manojs1978 manojs1978 requested a review from ossdhaval June 26, 2026 07:31
@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@manojs1978, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 28 minutes and 48 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: e5b77ca1-9e01-476c-bd81-eca2b24b957b

📥 Commits

Reviewing files that changed from the base of the PR and between 3580188 and 09198e5.

📒 Files selected for processing (2)
  • docs/install/vm-install/Debian.md
  • docs/install/vm-install/suse.md
📝 Walkthrough

Walkthrough

Adds Debian VM installation and removal guidance, plus a RHEL install note that switches the release package reference to the EL9 RPM.

Changes

Debian VM install guide

Layer / File(s) Summary
Intro and prerequisites
docs/install/vm-install/Debian.md
Front matter, supported Debian version, and prerequisite guidance are added.
Package download and verification
docs/install/vm-install/Debian.md
The Debian package download path, cosign signature verification, optional checksum check, and package install command are added.
Setup and access
docs/install/vm-install/Debian.md
The setup script, Admin UI prompt example, post-install access steps, SSA upload guidance, troubleshooting pointers, Casa access, and HTTPS enablement note are added.
Uninstallation steps
docs/install/vm-install/Debian.md
Flex removal, Janssen package removal, optional apt cleanup, and Admin UI uninstall/update commands are added.

RHEL VM install guide

Layer / File(s) Summary
Release package artifact
docs/install/vm-install/rhel.md
The release package install command now references the EL9 RPM artifact.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • GluuFederation/flex#2785: Updates the Linux VM package verification flow with cosign verify-blob and the .bundle path.

Suggested reviewers

  • ossdhaval
  • moabu

Poem

Hop hop, a Debian guide now blooms,
With cosign checks and tidy rooms.
Flex installs, then Casa glows,
TUI paths and HTTPS shows.
🐇 I left a neat trail in the snow.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is generic and does not describe the Debian install docs and RHEL package update in this changeset. Use a concise, specific title like 'Add Debian VM install docs and update RHEL package reference'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch manojs1978-flexdoc-updatesfor-debian

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mo-auto mo-auto added the area-documentation Documentation needs to change as part of issue or PR label Jun 26, 2026

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 6

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/install/vm-install/Debian.md`:
- Around line 255-261: The “Uninstalling Admin UI” section is using the global
Flex removal command, which conflicts with the section title. Update the
documentation in the uninstall section to match the actual behavior of
flex_setup.py --remove-flex: either change the section heading to “Uninstalling
Gluu Flex” or replace the command with the specific Admin UI removal option if
one exists. Use the existing “Uninstalling Admin UI” and “Uninstall Gluu Flex”
headings as the references to keep the uninstall instructions consistent.
- Around line 198-200: Fix the grammar in the uninstall section by changing the
phrase in the Janssen package removal step from “removes and uninstall” to
“removes and uninstalls”; update the sentence in the uninstall heading content
so the wording is consistent and correctly conjugated.
- Around line 134-135: The Uninstallation heading in the Debian install doc has
a grammar issue: “two step” should be hyphenated as “two-step.” Update the
wording in the Uninstallation section so the sentence reads naturally and
consistently, keeping the rest of the text unchanged.
- Around line 85-89: The package installation command is missing elevated
privileges, which will fail for non-root users. Update the install example in
the Debian install guide so the `apt install` command is run with `sudo`,
matching the other administrative commands in this section.
- Around line 54-64: The Debian install guide has a cosign bundle filename
mismatch between the download step and the verification step, so the referenced
bundle will not be found. Update the download command and the `cosign
verify-blob` command in the Debian install section to use the same Debian 13
bundle name, keeping the `flex-Debian13-...` identifier consistent throughout
that example.
- Around line 200-202: The uninstall command example is missing sudo, which
makes it inconsistent with the sample output shown below. Update the uninstall
snippet in the Debian install docs so the install.py invocation uses sudo,
matching the documented command style and ensuring it can be run with the
required privileges.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: db26183e-399d-42b7-889c-99416669dacc

📥 Commits

Reviewing files that changed from the base of the PR and between ae03500 and 0cdc028.

📒 Files selected for processing (1)
  • docs/install/vm-install/Debian.md

Comment thread docs/install/vm-install/Debian.md Outdated
Comment thread docs/install/vm-install/Debian.md
Comment thread docs/install/vm-install/Debian.md Outdated
Comment thread docs/install/vm-install/Debian.md
Comment thread docs/install/vm-install/Debian.md
Comment thread docs/install/vm-install/Debian.md
Signed-off-by: manoj suryawanshi <manojsurya78@gmail.com>
Signed-off-by: manoj suryawanshi <manojsurya78@gmail.com>

@coderabbitai coderabbitai Bot 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.

♻️ Duplicate comments (1)
docs/install/vm-install/Debian.md (1)

88-89: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Add sudo to apt install command.

The install command lacks sudo, unlike other administrative commands in this guide (e.g., line 96). This will fail for non-root users.

🛡️ Proposed fix
-apt install -y /tmp/flex_replace-flex-version-stable.debian13_amd64.deb
+sudo apt install -y /tmp/flex_replace-flex-version-stable.debian13_amd64.deb
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/install/vm-install/Debian.md` around lines 88 - 89, The Debian install
step uses apt install without elevated privileges, so update the installation
command in the Debian.md guide to include sudo consistently with the rest of the
VM install instructions. Locate the apt install invocation in the install
section and change it so non-root users can run it successfully.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Duplicate comments:
In `@docs/install/vm-install/Debian.md`:
- Around line 88-89: The Debian install step uses apt install without elevated
privileges, so update the installation command in the Debian.md guide to include
sudo consistently with the rest of the VM install instructions. Locate the apt
install invocation in the install section and change it so non-root users can
run it successfully.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 28f95678-79d2-4bd3-867f-b586b5a498dd

📥 Commits

Reviewing files that changed from the base of the PR and between 0cdc028 and 3580188.

📒 Files selected for processing (2)
  • docs/install/vm-install/Debian.md
  • docs/install/vm-install/rhel.md

Updated installation commands to include 'sudo' for proper permissions. Corrected grammatical errors in the uninstallation section.

Signed-off-by: manoj suryawanshi <manojsurya78@gmail.com>
Signed-off-by: manoj suryawanshi <manojsurya78@gmail.com>
Comment thread docs/install/vm-install/Debian.md
@manojs1978 manojs1978 merged commit 62d59a4 into main Jun 26, 2026
5 checks passed
@manojs1978 manojs1978 deleted the manojs1978-flexdoc-updatesfor-debian branch June 26, 2026 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-documentation Documentation needs to change as part of issue or PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants