EPMRPP-117612 || Add Installation docs#1141
Merged
Merged
Conversation
pressayuliya
requested review from
maria-hambardzumian and
siarheirazuvalau
as code owners
July 8, 2026 17:25
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughAdds two new advanced installation documentation pages, updates static navigation and redirect references, and adjusts sidebar ordering metadata across several existing docs and a category config file. ChangesDocumentation additions, removals, and sidebar reordering
Estimated code review effort: 2 (Simple) | ~15 minutes Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 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.
Actionable comments posted: 4
🧹 Nitpick comments (2)
docs/installation-steps-advanced/AuditLogsAndLogCollection.md (2)
9-10: 🩺 Stability & Availability | 🔵 TrivialCall out log rotation here.
The upstream audit-log guidance says this path must be rotated; without that warning, users can end up with an ever-growing file and a full pod filesystem.
Suggested note
When audit logging is enabled, the API service writes audit logs to a shared volume at `/var/log/reportportal/audit.log` inside the pod. The chart does not include a built-in log streamer. To ship these logs to a central backend (e.g. Elasticsearch, Loki, S3), add a **sidecar** using `serviceapi.extraContainers` (and optionally `serviceapi.extraVolumes` for config). +Configure log rotation for `/var/log/reportportal/audit.log` as well; the file is append-only and can grow quickly.🤖 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/installation-steps-advanced/AuditLogsAndLogCollection.md` around lines 9 - 10, The audit logging guidance for the service API should explicitly mention log rotation for the audit log file written by the serviceapi workload. Update the AuditLogsAndLogCollection.md text near the description of /var/log/reportportal/audit.log to note that any sidecar or log shipper configured via serviceapi.extraContainers should also handle rotation (or rely on a rotator) so the file does not grow without bound. Keep the recommendation tied to the serviceapi and audit log path references already present in the document.
45-45: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winPin the example images instead of using
latest.
fluent/fluent-bit:latestandbusybox:latestmake these install snippets non-reproducible and can pull incompatible behavior over time. Please use tested tags or digests instead.Suggested change
- image: fluent/fluent-bit:latest + image: fluent/fluent-bit:<tested-tag> - image: busybox:latest + image: busybox:<tested-tag>Also applies to: 93-93
🤖 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/installation-steps-advanced/AuditLogsAndLogCollection.md` at line 45, The install snippets use mutable container tags, so update the image references in the audit/log collection examples to pinned, reproducible versions instead of `latest`. In the documentation section that shows the fluent-bit setup and the related `busybox` example, replace those tags with tested version tags or immutable digests so the examples stay stable over time.
🤖 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/installation-steps-advanced/AWSLoadBalancerIntegrationOnEKS.md`:
- Around line 1-5: The frontmatter metadata for this doc is mismatched: the
description still refers to audit logging and Fluent Bit instead of the AWS Load
Balancer Integration on EKS guide. Update the `description` field in the page
frontmatter for `AWS LoadBalancerIntegrationOnEKS.md` so it accurately
summarizes the ALB-on-EKS installation content, keeping the existing
`sidebar_label` and `sidebar_position` unchanged.
- Around line 64-66: The fenced diagram block in the documentation is missing an
explicit language label, which triggers markdownlint. Update the fence in the
relevant markdown section to use an explicit label such as text so the diagram
remains rendered as plain text while staying lint-clean.
In `@static/ai-sitemap.json`:
- Around line 182-186: The sitemap entry for AWSLoadBalancerIntegrationOnEKS has
the wrong description text and currently advertises audit logging / Fluent Bit
content. Update the description in the ai-sitemap JSON entry for the AWS Load
Balancer Integration on EKS item to an EKS/ALB-specific summary that matches the
actual page, keeping the title and URL unchanged.
In `@static/llms.txt`:
- Line 49: The `llms.txt` entry for `AWSLoadBalancerIntegrationOnEKS` still uses
the audit logging summary, so update that line to describe the EKS/AWS Load
Balancer integration accurately. Keep the same link target, but replace the text
in the `llms.txt` list item with an EKS/ALB-specific summary that matches the
`AWSLoadBalancerIntegrationOnEKS` page.
---
Nitpick comments:
In `@docs/installation-steps-advanced/AuditLogsAndLogCollection.md`:
- Around line 9-10: The audit logging guidance for the service API should
explicitly mention log rotation for the audit log file written by the serviceapi
workload. Update the AuditLogsAndLogCollection.md text near the description of
/var/log/reportportal/audit.log to note that any sidecar or log shipper
configured via serviceapi.extraContainers should also handle rotation (or rely
on a rotator) so the file does not grow without bound. Keep the recommendation
tied to the serviceapi and audit log path references already present in the
document.
- Line 45: The install snippets use mutable container tags, so update the image
references in the audit/log collection examples to pinned, reproducible versions
instead of `latest`. In the documentation section that shows the fluent-bit
setup and the related `busybox` example, replace those tags with tested version
tags or immutable digests so the examples stay stable over time.
🪄 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: CHILL
Plan: Pro
Run ID: 49ae0011-1df5-486d-b2d8-fcb933827e50
📒 Files selected for processing (16)
docs/installation-steps-advanced/AWSLoadBalancerIntegrationOnEKS.mddocs/installation-steps-advanced/AdditionalConfigurationParameters.mddocs/installation-steps-advanced/AmazonALBNGINXIngressController.mddocs/installation-steps-advanced/AuditLogsAndLogCollection.mddocs/installation-steps-advanced/BackupRestoreGuide.mddocs/installation-steps-advanced/DeployWithAWSECSFargate.mddocs/installation-steps-advanced/JobsConfiguration.mddocs/installation-steps-advanced/MaintainCommandsCheatSheet.mddocs/installation-steps-advanced/MigrateOneInstanceToAnother.mddocs/installation-steps-advanced/QuickStartWithGCPGKE.mddocs/installation-steps-advanced/ScalingReportPortalServices.mddocs/installation-steps-advanced/SetupTLSHTTPSDockerComposeTraefikV2.mddocs/installation-steps-advanced/UpgradingPostgreSQLForReportPortalV24.2AndLater.mddocs/installation-steps-advanced/file-storage-options/_category_.jsonstatic/ai-sitemap.jsonstatic/llms.txt
💤 Files with no reviewable changes (1)
- docs/installation-steps-advanced/AmazonALBNGINXIngressController.md
Comment on lines
+1
to
+5
| --- | ||
| sidebar_position: 8 | ||
| sidebar_label: AWS Load Balancer Integration on EKS | ||
| description: Configure ReportPortal audit logging and collect logs with Fluent Bit sidecars, shared volumes, and Helm values. | ||
| --- |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the page description metadata.
The current description talks about audit logging/Fluent Bit, but this file is an ALB-on-EKS install guide. That mismatch will leak into search snippets and doc indexes.
Proposed fix
-description: Configure ReportPortal audit logging and collect logs with Fluent Bit sidecars, shared volumes, and Helm values.
+description: Configure ReportPortal on Amazon EKS with the AWS Load Balancer Controller.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| --- | |
| sidebar_position: 8 | |
| sidebar_label: AWS Load Balancer Integration on EKS | |
| description: Configure ReportPortal audit logging and collect logs with Fluent Bit sidecars, shared volumes, and Helm values. | |
| --- | |
| --- | |
| sidebar_position: 8 | |
| sidebar_label: AWS Load Balancer Integration on EKS | |
| description: Configure ReportPortal on Amazon EKS with the AWS Load Balancer Controller. | |
| --- |
🤖 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/installation-steps-advanced/AWSLoadBalancerIntegrationOnEKS.md` around
lines 1 - 5, The frontmatter metadata for this doc is mismatched: the
description still refers to audit logging and Fluent Bit instead of the AWS Load
Balancer Integration on EKS guide. Update the `description` field in the page
frontmatter for `AWS LoadBalancerIntegrationOnEKS.md` so it accurately
summarizes the ALB-on-EKS installation content, keeping the existing
`sidebar_label` and `sidebar_position` unchanged.
Comment on lines
+64
to
+66
| ``` | ||
| Browser → ALB (Layer 7) → Kubernetes Ingress → Services → Pods | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Label the fenced diagram block.
Markdownlint flags this fence because it has no language. Use text (or another explicit label) so the page stays lint-clean.
Proposed fix
-```
+```text
Browser → ALB (Layer 7) → Kubernetes Ingress → Services → Pods</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 64-64: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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/installation-steps-advanced/AWSLoadBalancerIntegrationOnEKS.md` around
lines 64 - 66, The fenced diagram block in the documentation is missing an
explicit language label, which triggers markdownlint. Update the fence in the
relevant markdown section to use an explicit label such as text so the diagram
remains rendered as plain text while staying lint-clean.
Source: Linters/SAST tools
Comment on lines
+182
to
+186
| { | ||
| "title": "AWS Load Balancer Integration on EKS", | ||
| "url": "https://reportportal.io/docs/installation-steps-advanced/AWSLoadBalancerIntegrationOnEKS/", | ||
| "description": "Configure ReportPortal audit logging and collect logs with Fluent Bit sidecars, shared volumes, and Helm values." | ||
| }, |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Fix the AWS entry description.
AWSLoadBalancerIntegrationOnEKS is still described as audit logging / Fluent Bit collection, so the sitemap advertises the wrong page content. Please replace it with an EKS/ALB-specific summary.
🤖 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 `@static/ai-sitemap.json` around lines 182 - 186, The sitemap entry for
AWSLoadBalancerIntegrationOnEKS has the wrong description text and currently
advertises audit logging / Fluent Bit content. Update the description in the
ai-sitemap JSON entry for the AWS Load Balancer Integration on EKS item to an
EKS/ALB-specific summary that matches the actual page, keeping the title and URL
unchanged.
| - [Maintain commands Cheat sheet](https://reportportal.io/docs/installation-steps-advanced/MaintainCommandsCheatSheet/): Quickly manage and troubleshoot your ReportPortal instance with essential Docker commands for installation, backup, cleanup, and service monitoring. | ||
| - [Additional configuration parameters](https://reportportal.io/docs/installation-steps-advanced/AdditionalConfigurationParameters/): Optimize ReportPortal setup with customizable parameters - ports, session timeouts, database and API settings via Docker-friendly environment variables. | ||
| - [Setup TLS / HTTPS Docker Compose + Traefik v2](https://reportportal.io/docs/installation-steps-advanced/SetupTLSHTTPSDockerComposeTraefikV2/): Practical guide to setting up TLS/HTTPS in our test results dashboard | ||
| - [AWS Load Balancer Integration on EKS](https://reportportal.io/docs/installation-steps-advanced/AWSLoadBalancerIntegrationOnEKS/): Configure ReportPortal audit logging and collect logs with Fluent Bit sidecars, shared volumes, and Helm values. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Fix the AWS link description.
This entry still uses the audit-log copy, so llms.txt points readers to the wrong content for AWSLoadBalancerIntegrationOnEKS. Please swap in an EKS/ALB-specific summary.
🤖 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 `@static/llms.txt` at line 49, The `llms.txt` entry for
`AWSLoadBalancerIntegrationOnEKS` still uses the audit logging summary, so
update that line to describe the EKS/AWS Load Balancer integration accurately.
Keep the same link target, but replace the text in the `llms.txt` list item with
an EKS/ALB-specific summary that matches the `AWSLoadBalancerIntegrationOnEKS`
page.
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
2 participants
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.
Summary by CodeRabbit