Skip to content

EPMRPP-114114 || Update S3 Cloud Storage doc#1101

Merged
maria-hambardzumian merged 1 commit intodevelopfrom
EPMRPP-114114
Apr 2, 2026
Merged

EPMRPP-114114 || Update S3 Cloud Storage doc#1101
maria-hambardzumian merged 1 commit intodevelopfrom
EPMRPP-114114

Conversation

@pressayuliya
Copy link
Copy Markdown
Contributor

@pressayuliya pressayuliya commented Apr 2, 2026

Summary by CodeRabbit

  • Documentation
    • Updated S3 cloud storage configuration documentation to explicitly specify datastore type in Docker/EC2 setup
    • Improved formatting of Elasticsearch hosts endpoint reference for better readability

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 2, 2026

Walkthrough

The S3CloudStorage.md documentation file is updated to explicitly include DATASTORE_TYPE: s3 in the Analyzer environment configuration and reformats the ES_HOSTS value to an HTML link format while maintaining the same endpoint reference.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/installation-steps-advanced/file-storage-options/S3CloudStorage.md
Added DATASTORE_TYPE: s3 to Analyzer environment config and reformatted ES_HOSTS value to HTML link format.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • AmsterGet
  • maria-hambardzumian

Poem

🐰 Whisker-twitched with documentation glee,
S3 storage now plain for all to see,
With DATASTORE\_TYPE in place so true,
And ES\_HOSTS linked in markup new,
Configuration clarity hops on through!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title references the specific documentation file being updated (S3 Cloud Storage doc) and the related ticket identifier, directly reflecting the changeset which modifies S3CloudStorage.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch EPMRPP-114114

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 and usage tips.

Copy link
Copy Markdown

@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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/installation-steps-advanced/file-storage-options/S3CloudStorage.md`:
- Around line 369-370: The ES_HOSTS env entry currently contains HTML anchor
markup which is invalid for configuration; update the ES_HOSTS value to a plain
URL string (e.g., "http://opensearch:9200") so the analyzer can parse/connect
correctly, leaving DATASTORE_TYPE: s3 unchanged and ensuring ES_HOSTS contains
no HTML or tags.
🪄 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: e0fc6963-a89c-4c1a-a674-3f1aea851f61

📥 Commits

Reviewing files that changed from the base of the PR and between cb622f4 and 9ea00c5.

📒 Files selected for processing (1)
  • docs/installation-steps-advanced/file-storage-options/S3CloudStorage.md

Comment on lines +369 to +370
ES_HOSTS: <a href="http://opensearch:9200" rel="noreferrer noopener" title="http://opensearch:9200/" target="_blank">http://opensearch:9200</a>
DATASTORE_TYPE: s3
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Use plain URL for ES_HOSTS (HTML markup breaks config).

Line 369 should stay a raw host string. The current anchor tag value is not a valid ES_HOSTS env value and can break analyzer startup/connectivity.

Suggested fix
-  ES_HOSTS: <a href="http://opensearch:9200" rel="noreferrer noopener" title="http://opensearch:9200/" target="_blank">http://opensearch:9200</a>
+  ES_HOSTS: http://opensearch:9200
   DATASTORE_TYPE: s3
📝 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
ES_HOSTS: <a href="http://opensearch:9200" rel="noreferrer noopener" title="http://opensearch:9200/" target="_blank">http://opensearch:9200</a>
DATASTORE_TYPE: s3
ES_HOSTS: http://opensearch:9200
DATASTORE_TYPE: s3
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/installation-steps-advanced/file-storage-options/S3CloudStorage.md`
around lines 369 - 370, The ES_HOSTS env entry currently contains HTML anchor
markup which is invalid for configuration; update the ES_HOSTS value to a plain
URL string (e.g., "http://opensearch:9200") so the analyzer can parse/connect
correctly, leaving DATASTORE_TYPE: s3 unchanged and ensuring ES_HOSTS contains
no HTML or tags.

@maria-hambardzumian maria-hambardzumian merged commit 38ee403 into develop Apr 2, 2026
2 checks passed
@maria-hambardzumian maria-hambardzumian deleted the EPMRPP-114114 branch April 2, 2026 15:35
maria-hambardzumian added a commit that referenced this pull request Apr 2, 2026
Co-authored-by: Yuliya Prihodko <107035036+pressayuliya@users.noreply.github.com>
Co-authored-by: Yuliya_Prihodko <Yuliya_Prihodko@epam.com>
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.

2 participants