MGMT-23702: Update docs for AAP direct as default provider#25
MGMT-23702: Update docs for AAP direct as default provider#25tzvatot merged 3 commits intoosac-project:mainfrom
Conversation
- Rename env var prefix from CLOUDKIT_ to OSAC_ (matches operator) - Update default provider from EDA to AAP direct - Mark EDA provider as legacy (requires explicit opt-in) - Update examples and rollback instructions Generated with [Claude Code](https://claude.com/claude-code)
|
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)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughDocumentation in four files under architecture/aap-provisioning (README.md, operations.md, testing.md, troubleshooting.md) was updated to rename environment variable prefixes from Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 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 |
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 (1)
architecture/aap-provisioning/README.md (1)
8-8:⚠️ Potential issue | 🟡 MinorLinked troubleshooting guide appears out-of-sync with renamed env vars.
The referenced
architecture/aap-provisioning/troubleshooting.mdstill usesCLOUDKIT_AAP_PROVISION_TEMPLATEandCLOUDKIT_AAP_STATUS_POLL_INTERVAL, which conflicts with this document’sOSAC_*naming.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@architecture/aap-provisioning/README.md` at line 8, The Troubleshooting Guide is out-of-sync: replace all occurrences of the old environment variable names CLOUDKIT_AAP_PROVISION_TEMPLATE and CLOUDKIT_AAP_STATUS_POLL_INTERVAL in the troubleshooting document with the new OSAC_* names (e.g., OSAC_AAP_PROVISION_TEMPLATE and OSAC_AAP_STATUS_POLL_INTERVAL), update any example commands or config snippets to use the OSAC_ names, and verify any descriptive text and validation steps mention the new variables so the README and troubleshooting doc use the same naming.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@architecture/aap-provisioning/operations.md`:
- Around line 40-41: Update the inconsistent default-provider messaging so the
guide consistently states that AAP is the default; specifically, change the
explanatory text around OSAC_PROVISIONING_PROVIDER and any earlier mention that
says EDA is the default (referencing the OSAC_PROVISIONING_PROVIDER variable and
the section that currently claims EDA is default) so both sections clearly state
AAP is the default and the example value ("eda") is shown as an explicit
override rather than the default.
In `@architecture/aap-provisioning/README.md`:
- Line 219: The README table entry for OSAC_PROVISIONING_PROVIDER conflicts with
the later text — update the documentation so OSAC_PROVISIONING_PROVIDER is not
marked "Required" for AAP Direct: either change the table's requirement column
to "Optional" or add a parenthetical/default note (e.g., default "aap" for AAP
Direct) and add a short clarifying sentence near the existing Line 254 text to
state the implicit default behavior; reference the OSAC_PROVISIONING_PROVIDER
variable and the AAP Direct usage so readers understand it is optional when
using AAP.
---
Outside diff comments:
In `@architecture/aap-provisioning/README.md`:
- Line 8: The Troubleshooting Guide is out-of-sync: replace all occurrences of
the old environment variable names CLOUDKIT_AAP_PROVISION_TEMPLATE and
CLOUDKIT_AAP_STATUS_POLL_INTERVAL in the troubleshooting document with the new
OSAC_* names (e.g., OSAC_AAP_PROVISION_TEMPLATE and
OSAC_AAP_STATUS_POLL_INTERVAL), update any example commands or config snippets
to use the OSAC_ names, and verify any descriptive text and validation steps
mention the new variables so the README and troubleshooting doc use the same
naming.
🪄 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: 3b5fb525-64fa-4151-85a4-291784161641
📒 Files selected for processing (3)
architecture/aap-provisioning/README.mdarchitecture/aap-provisioning/operations.mdarchitecture/aap-provisioning/testing.md
- operations.md: Fix inconsistent default-provider text (EDA is legacy, not default) - README.md: Clarify OSAC_PROVISIONING_PROVIDER is optional for AAP direct (default) - troubleshooting.md: Rename remaining CLOUDKIT_* vars to OSAC_* Generated with [Claude Code](https://claude.com/claude-code)
There was a problem hiding this comment.
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 `@architecture/aap-provisioning/troubleshooting.md`:
- Line 33: Replace the unhyphenated phrase "rate limiting errors" with the
hyphenated compound adjective "rate-limiting errors" in the troubleshooting
table row (the cell containing "Poll interval too aggressive | AAP API rate
limiting errors | Poll interval set too low | Increase
`OSAC_AAP_STATUS_POLL_INTERVAL`..."), updating that exact text to maintain
consistency and clarity.
🪄 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: 93ce687e-7b1b-49d6-89e6-5b2afea7fe03
📒 Files selected for processing (3)
architecture/aap-provisioning/README.mdarchitecture/aap-provisioning/operations.mdarchitecture/aap-provisioning/troubleshooting.md
✅ Files skipped from review due to trivial changes (1)
- architecture/aap-provisioning/README.md
Generated with [Claude Code](https://claude.com/claude-code)
akshaynadkarni
left a comment
There was a problem hiding this comment.
LGTM. Thanks for updating the docs.
Summary
CLOUDKIT_toOSAC_to match the operatorOSAC_PROVISIONING_PROVIDER=eda)Companion to osac-operator#164.
Jira
Generated with Claude Code
Summary by CodeRabbit