Skip to content

feat: add instructions for multi-cluster setup for aws tracing module#124

Merged
chalindukodikara merged 1 commit into
openchoreo:mainfrom
chalindukodikara:issue-latest_2026_06_18-4
May 18, 2026
Merged

feat: add instructions for multi-cluster setup for aws tracing module#124
chalindukodikara merged 1 commit into
openchoreo:mainfrom
chalindukodikara:issue-latest_2026_06_18-4

Conversation

@chalindukodikara
Copy link
Copy Markdown
Contributor

@chalindukodikara chalindukodikara commented May 18, 2026

Purpose

$subject

Approach

Summarize the solution and implementation details.

Related Issues

openchoreo/openchoreo#3300

Checklist

  • Tests added or updated (unit, integration, etc.)
  • Samples updated (if applicable)

Remarks

Add any additional context, known issues, or TODOs related to this PR.

Summary by CodeRabbit

  • Documentation
    • Clarified setup instructions for EKS and non-EKS Kubernetes environments
    • Added AWS CLI workflows for IAM configuration
    • Updated Pod Identity association guidance
    • Added Compatibility section with version matrix

Review Change Stack

Signed-off-by: Chalindu Kodikara <chalindumkodikara@gmail.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 18, 2026

📝 Walkthrough

Walkthrough

The README for the AWS X-Ray observability module is updated to clarify EKS versus non-EKS Kubernetes setup paths. Terminology is standardized to "data-plane," AWS CLI workflows are added for IAM role and Pod Identity association creation, and a compatibility table is introduced.

Changes

AWS X-Ray Module Documentation

Layer / File(s) Summary
Terminology and structure clarification
observability-tracing-aws-xray/README.md
Introductory support matrix and multi-cluster topology table reformatted; headings updated from "workflow-plane" to "data-plane" for consistency.
EKS Pod Identity IAM and association setup
observability-tracing-aws-xray/README.md
New AWS CLI section added to create and attach IAM roles and policies for the adapter and collector; Pod Identity association instructions replaced with AWS CLI command alternatives per cluster topology.
Non-EKS static credentials IAM setup
observability-tracing-aws-xray/README.md
Static-credentials IAM user creation instructions replaced with AWS CLI commands to create user, attach policy, and export access keys via jq.
Trace ingestion and compatibility guidance
observability-tracing-aws-xray/README.md
Trace ingestion instructions simplified; new Compatibility section added with module-version-to-OpenChoreo-version mapping table.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • openchoreo/community-modules#118: Updates to observability-tracing-aws-xray/README.md installation and Pod Identity instructions that overlap with this PR's documentation and terminology changes.

Suggested reviewers

  • akila-i
  • yashodgayashan

Poem

🐰 With X-Ray eyes, the docs grow clear,
AWS CLI workflows appear,
Pods now dance on data-planes bright,
IAM roles shine in the light! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is incomplete with only the Purpose field filled (as a reference to the title) and all other sections left as template placeholders or empty. Complete the Approach section describing implementation details, fill in Related Issues if applicable, check the Checklist items if relevant, and add any Remarks about the changes or known limitations.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding multi-cluster setup instructions for the AWS tracing module, which aligns with the README documentation updates.
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
observability-tracing-aws-xray/README.md (1)

15-24: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add the new Compatibility section to the table of contents.

## Compatibility was added, but there is no TOC entry for it, so in-page navigation is incomplete.

Also applies to: 789-796

🤖 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 `@observability-tracing-aws-xray/README.md` around lines 15 - 24, The table of
contents is missing an entry for the newly added "## Compatibility" section; add
a TOC line linking to that heading (e.g., "10. [Compatibility](`#compatibility`)")
in the top TOC block and also add the corresponding entry in the secondary TOC
location referenced (lines around 789-796); search for the literal heading "##
Compatibility" to place the anchor link exactly and ensure numbering/ordering
matches the surrounding list.
🤖 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.

Outside diff comments:
In `@observability-tracing-aws-xray/README.md`:
- Around line 15-24: The table of contents is missing an entry for the newly
added "## Compatibility" section; add a TOC line linking to that heading (e.g.,
"10. [Compatibility](`#compatibility`)") in the top TOC block and also add the
corresponding entry in the secondary TOC location referenced (lines around
789-796); search for the literal heading "## Compatibility" to place the anchor
link exactly and ensure numbering/ordering matches the surrounding list.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 722a57a6-3b0b-4a68-a7cb-be2dc8bd2a50

📥 Commits

Reviewing files that changed from the base of the PR and between 99908bf and a533e4f.

📒 Files selected for processing (1)
  • observability-tracing-aws-xray/README.md

@chalindukodikara chalindukodikara merged commit aaa077e into openchoreo:main May 18, 2026
2 checks passed
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