docs(platform): add architecture page with diagrams#2272
Merged
Conversation
Adds platform/introduction/architecture.mdx covering the management plane, connected clusters and agents, failure behavior, entry points, project and tenant resource lifecycle, and network paths. Includes four SVG diagrams. Cross-links added from platform_intro, platform_communication, what-are-clusters, and what-are-projects. Closes DOC-1488 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
✅ Deploy Preview for vcluster-docs-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
…page Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
lizardruss
previously requested changes
Jun 11, 2026
lizardruss
left a comment
lizardruss
left a comment
Contributor
There was a problem hiding this comment.
I'm finding the organization of this page a little awkward. I added some suggestions, but they are only ideas.
…e page - name vcluster-platform namespace - reorder management plane bullets gateway-first - rename tenant resource lifecycle to project resource lifecycle - update lifecycle step 3 wording per reviewer suggestion - add NodeProvider/NodeClaim note to project resource lifecycle - collapse tenant cluster runtime section to a single pointer to vcluster architecture - clarify backing store prose and link to external database docs - fix svg backing store label from "CRDs or database" to "Custom resources" Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
djwfyi
added
backport-v4.9.0
reorder sections so the page teaches from outside in: management plane, connected clusters, entry points, projects, resource lifecycle, network paths, failure behavior. merge the two lifecycle sections into one, remove the defensive vCluster disclaimer from the intro, add plain-language bridge sentences to orient new readers before technical detail arrives, and move the lifecycle diagram to sit immediately after the numbered pattern. Closes DOC-1488 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
add a new intro-level overview svg with simpler abstraction for the page opener, move the detailed management-plane overview diagram to after the connected clusters section where it synthesizes both preceding sections, expand the local cluster explanation with its ui label and a dedicated paragraph, update the writer skill with progressive disclosure guidance for explanation and concept pages. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replaces the single architecture page with two focused pages: - architecture.mdx: structural introduction (what exists and how it fits together) - how-platform-works.mdx: behavioral page (controller model, lifecycle, network paths, failure) Fills gaps in understand pages: adds proxy path participation to what-are-clusters.mdx and project namespace model to what-are-projects.mdx. Closes DOC-1488 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
djwfyi
dismissed
lizardruss’s stale review
Page reworked and split into two pages. Concerns addressed.
- fix storage description in architecture.mdx: embedded db by default, kine for HA (not etcd) - rewrite direct endpoint section as regional and direct access endpoints - add GlossaryTerm import and wrap first tenant-cluster use in how-platform-works.mdx - remove link to platform_communication.mdx pending rewrite (DOC-1580) - add description frontmatter to what-are-clusters.mdx - update network paths aria-label to match renamed section - fix double blank line in vcluster-docs-writer SKILL.md - scope pr template hook to gh pr create commands only Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
djwfyi
pushed a commit
that referenced
this pull request
Jun 29, 2026
…#2341) * Backport: Copy platform/introduction/architecture.mdx to platform_versioned_docs/version-4.10.0/introduction/architecture.mdx * Backport: Copy platform/introduction/how-platform-works.mdx to platform_versioned_docs/version-4.10.0/introduction/how-platform-works.mdx * Backport: Copy platform/introduction/platform_intro.mdx to platform_versioned_docs/version-4.10.0/introduction/platform_intro.mdx * Backport: Copy platform/understand/platform_communication.mdx to platform_versioned_docs/version-4.10.0/understand/platform_communication.mdx * Backport: Copy platform/understand/what-are-clusters.mdx to platform_versioned_docs/version-4.10.0/understand/what-are-clusters.mdx * Backport: Copy platform/understand/what-are-projects.mdx to platform_versioned_docs/version-4.10.0/understand/what-are-projects.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Content Description
Adds a first-class architecture page for vCluster Platform (
platform/introduction/architecture.mdx), the counterpart to the existing vCluster architecture page. Covers the management plane, connected clusters and agents, failure behavior, entry points, project and tenant resource lifecycle, and network paths. Includes four custom SVG diagrams using brand colors. Cross-links added from the intro page and three understand pages.Preview Link
https://deploy-preview-2272--vcluster-docs-site.netlify.app/docs/platform/next/introduction/architecture
Internal Reference
Closes DOC-1488
AI review: mention
@claudein a comment to request a review or changes. See CONTRIBUTING.md for available commands.@netlify /docs