Skip to content

MGMT-23702: Update docs for AAP direct as default provider#25

Merged
tzvatot merged 3 commits intoosac-project:mainfrom
tzvatot:docs/aap-direct-default
Apr 9, 2026
Merged

MGMT-23702: Update docs for AAP direct as default provider#25
tzvatot merged 3 commits intoosac-project:mainfrom
tzvatot:docs/aap-direct-default

Conversation

@tzvatot
Copy link
Copy Markdown
Contributor

@tzvatot tzvatot commented Mar 29, 2026

Summary

  • Rename env var prefix from CLOUDKIT_ to OSAC_ to match the operator
  • Update default provider from EDA to AAP direct
  • Mark EDA provider as legacy (requires explicit opt-in via OSAC_PROVISIONING_PROVIDER=eda)
  • Update examples and rollback instructions

Companion to osac-operator#164.

Jira

Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Renamed provisioning environment variables from CLOUDKIT_* to OSAC_* across docs and examples.
    • Clarified defaults: AAP is now the default provider; EDA is legacy and requires explicit opt-in.
    • Updated migration, rollback (to EDA), testing checks, and troubleshooting guidance to reference OSAC_* variable names and updated poll/interval variables.

- 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)
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b6441893-602c-43e6-b952-83fa48a6e17e

📥 Commits

Reviewing files that changed from the base of the PR and between 4d44c3a and df616fa.

📒 Files selected for processing (1)
  • architecture/aap-provisioning/troubleshooting.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • architecture/aap-provisioning/troubleshooting.md

Walkthrough

Documentation in four files under architecture/aap-provisioning (README.md, operations.md, testing.md, troubleshooting.md) was updated to rename environment variable prefixes from CLOUDKIT_* to OSAC_*. Provider guidance and examples were revised to make AAP the default and mark EDA as legacy that must be explicitly enabled. Migration, rollback, examples, kubectl jsonpath checks, and troubleshooting variable references were all updated to use the OSAC_* names. All changes are documentation-only.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 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 clearly summarizes the main change: updating documentation to reflect AAP direct as the default provider, which aligns with the primary objective of the changeset.
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

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: 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 | 🟡 Minor

Linked troubleshooting guide appears out-of-sync with renamed env vars.

The referenced architecture/aap-provisioning/troubleshooting.md still uses CLOUDKIT_AAP_PROVISION_TEMPLATE and CLOUDKIT_AAP_STATUS_POLL_INTERVAL, which conflicts with this document’s OSAC_* 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

📥 Commits

Reviewing files that changed from the base of the PR and between 8bd48e2 and 8ee9fb6.

📒 Files selected for processing (3)
  • architecture/aap-provisioning/README.md
  • architecture/aap-provisioning/operations.md
  • architecture/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)
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 `@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

📥 Commits

Reviewing files that changed from the base of the PR and between 8ee9fb6 and 4d44c3a.

📒 Files selected for processing (3)
  • architecture/aap-provisioning/README.md
  • architecture/aap-provisioning/operations.md
  • architecture/aap-provisioning/troubleshooting.md
✅ Files skipped from review due to trivial changes (1)
  • architecture/aap-provisioning/README.md

@tzvatot tzvatot requested a review from eranco74 April 9, 2026 08:56
Copy link
Copy Markdown
Contributor

@akshaynadkarni akshaynadkarni left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for updating the docs.

@tzvatot tzvatot merged commit a249501 into osac-project:main Apr 9, 2026
1 check 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