Skip to content

docs: add OpenChoreo on Azure reference architecture#755

Draft
Mirage20 wants to merge 1 commit into
openchoreo:mainfrom
Mirage20:add-reference-architectures
Draft

docs: add OpenChoreo on Azure reference architecture#755
Mirage20 wants to merge 1 commit into
openchoreo:mainfrom
Mirage20:add-reference-architectures

Conversation

@Mirage20

Copy link
Copy Markdown
Contributor

Purpose

Adds a per-cloud reference architecture for running OpenChoreo on Microsoft Azure. It gives platform engineers a component-by-component view of each plane, what it depends on, and how those dependencies map to Azure managed services, complementing the cloud-neutral Deployment Topology and Multi-Cluster Connectivity guides.

Approach

  • New page under platform-engineer-guide/reference-architectures/azure (azure/index.mdx): scope, a recommended Azure stack, and per-plane sections (component/dependency tables, environment requirements, Azure mapping notes) for the control, data, workflow, and observability planes, plus cross-plane connectivity and a golden path.
  • draw.io diagrams co-located with the page as editable source (.drawio) and rendered .svg (icons embedded via --embed-svg-images); embedded with the site's ExpandableImage convention so they version with the docs.
  • Intentionally hidden from public navigation for now: the page is marked unlisted: true and the sidebar category is commented out in sidebars.ts, so it is reachable only by direct URL until the content review is complete. Publishing is a two-line change (uncomment the category + remove unlisted), documented inline.
  • Production build passes and Prettier format:check is clean.

Related Issues

N/A

Checklist

  • Tests added or updated (unit, integration, etc.)
  • Samples updated (if applicable)
  • Added backport/<release-branch> label if this should be backported (e.g., backport/release-v1.0)
  • This PR includes AI-generated code or content

Remarks

Draft while the author fine-tunes the content. There is no PR preview deploy on this repo, so the page's direct URL (/docs/next/platform-engineer-guide/reference-architectures/azure/) only goes live after merge, behind the unlisted flag; reviewers can review the diff or run the site locally in the meantime.

- Add per-plane component/dependency inventory mapped to Azure managed
  services (control, data, workflow, observability), with draw.io
  diagrams co-located as editable source (.drawio) plus rendered .svg
- Keep it hidden until reviewed: page marked `unlisted` and the sidebar
  category commented out, so it is reachable only by direct URL for now

Signed-off-by: Miraj Abeysekara <miraj@wso2.com>
@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: d0199a5e-68a3-46ba-8011-6ee0d4579749

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ 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.

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.

1 participant