fix indentation and adjust ordering #1911
Conversation
WalkthroughDocumentation updates to the AWS AMP metric provider Quick Start: adds parallel IRSA and Access Keys authentication examples, adjusts runnerServiceAccount annotations and placement, removes embedded AWS creds from the IRSA path, introduces secretKeyRef usage for Access Keys, and normalizes YAML ordering/indentation without changing semantics. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://waps.l3s.uni-hannover.de/live/im_/https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
docs/configuration/metric-providers-aws.rst (3)
32-58: Add aud condition to IRSA trust policy.Best practice (and common requirement) is to include the aud condition set to sts.amazonaws.com alongside sub.
"Condition": { "StringEquals": { + "oidc.eks.<REGION>.amazonaws.com/id/<OIDC_ID>:aud": "sts.amazonaws.com", "oidc.eks.<REGION>.amazonaws.com/id/<OIDC_ID>:sub": "system:serviceaccount:<NAMESPACE>:<SERVICE_ACCOUNT_NAME>" } }Refs: EKS docs and AWS guidance. (repost.aws, docs.aws.amazon.com)
11-19: Scope prerequisite #3 to the Access Keys flow only.IRSA doesn’t require long‑lived access keys. Clarify to avoid confusion.
-3. **AWS access credentials (Access Key and Secret Key)** - With sufficient permissions to query AMP (for example, the ``AmazonPrometheusQueryAccess`` policy). +3. **If not using IRSA**: AWS access credentials (Access Key ID and Secret Access Key) + With sufficient permissions to query AMP (for example, the ``AmazonPrometheusQueryAccess`` policy).(Policy example remains appropriate. (docs.aws.amazon.com))
165-168: Clarify required env vars by auth method.Readers using Access Keys will miss the credential vars here.
**Required Environment Variables**: - ``PROMETHEUS_SSL_ENABLED``: Always ``"true"`` - ``AWS_SERVICE_NAME``: Always ``"aps"`` for Amazon Prometheus Service - ``AWS_REGION``: The AWS region where your workspace is located + +If using Access Keys (non‑IRSA): +- ``AWS_ACCESS_KEY_ID`` and ``AWS_SECRET_ACCESS_KEY``: Your AWS credentialsRefs for names. (docs.aws.amazon.com)
🧹 Nitpick comments (1)
docs/configuration/metric-providers-aws.rst (1)
124-148: Optional: mention session tokens for temporary creds.If users load temporary credentials (e.g., from STS), they must also supply AWS_SESSION_TOKEN.
- name: AWS_SECRET_ACCESS_KEY valueFrom: secretKeyRef: name: aws-secret-key key: secret-key + # Optional if using temporary credentials (STS): + # - name: AWS_SESSION_TOKEN + # valueFrom: + # secretKeyRef: + # name: aws-secret-key + # key: session-tokenReference: AWS env var list. (docs.aws.amazon.com)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/configuration/metric-providers-aws.rst(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: run_tests
- GitHub Check: run_tests
- GitHub Check: Deploy docs
- GitHub Check: Deploy docs
🔇 Additional comments (4)
docs/configuration/metric-providers-aws.rst (4)
92-99: LGTM: IRSA env vars are minimal and correct.Keeping only PROMETHEUS_SSL_ENABLED, AWS_SERVICE_NAME=aps, and AWS_REGION aligns with IRSA.
172-179: Nice: clear note on Prometheus flags.Setting check_prometheus_flags: false is required with AMP; the callout helps prevent user errors.
60-101: Overall doc improvements are solid.Splitting IRSA vs Access Keys, removing inline creds, and using secretKeyRef are the right moves. Thanks for tightening indentation/order.
Also applies to: 102-151
83-86: runnerServiceAccount key confirmed: helm/robusta/values.yaml and templates use runnerServiceAccount, so the docs are accurate.
No description provided.