Skip to content

docs(readme): address review feedback on Standalone, AI Conformant version, Free tier, vNode framing, and Links section#3904

Open
saiyam1814 wants to merge 3 commits into
loft-sh:mainfrom
saiyam1814:docs/readme-feedback-fixes
Open

docs(readme): address review feedback on Standalone, AI Conformant version, Free tier, vNode framing, and Links section#3904
saiyam1814 wants to merge 3 commits into
loft-sh:mainfrom
saiyam1814:docs/readme-feedback-fixes

Conversation

@saiyam1814
Copy link
Copy Markdown
Contributor

Summary

Follow-up to #3876 to address review feedback on the README.

What changed

  • CNCF AI Conformant version pin — dropped (v1.35) from both the badge line and the prose certification line. 1.35 is the latest cert; the version pin would date the README.
  • Standalone framing — Standalone is not bare-metal-only; it runs on either dedicated infrastructure or bare metal. Updated:
    • "What is vCluster?" intro
    • Quick Start prerequisites
    • Architectures intro
    • v0.29 cell in the What's New table
    • Key Features row renamed Bare Metal & StandaloneStandalone Deployment with matching copy
  • Free tier line — simplified by dropping the "Private Nodes, Auto Nodes, Standalone" enumeration. Was overlapping/technical against "Unlimited Tenant Clusters."
  • Mode-specific featuresShared Platform Stack and Resource Syncing now carry a (Control Plane Cluster modes) qualifier. Integrations notes that host integrations apply only in Control Plane Cluster modes. Added a one-line footnote below the table explaining Standalone behavior.
  • vNode framingRuntime-level tenant isolationRuntime-level isolation. Tenant Clusters already provide tenant isolation; vNode adds kernel-level workload sandboxing on top, so calling its layer "tenant isolation" was duplicative/confusing.
  • Links → Connect with us — replaced the link table with a bulleted "Connect with us" list (Slack/LinkedIn/X/YouTube/Blog/consultation), matching the org-level profile README at loft-sh/.github so the two pages feel consistent.

Diff stats

README.md only — 21 lines added, 21 lines removed.

Test plan

  • Render the README on the PR and confirm:
    • No (v1.35) references remain in the certification copy.
    • Standalone is consistently described as running on dedicated infrastructure or bare metal.
    • The Free tier line reads cleanly without the technical enumeration.
    • Key Features table renders with the new qualifiers and the footnote.
    • vNode row reads as "Runtime-level isolation."
    • "Connect with us" section renders as a list with all six entries.

@saiyam1814 saiyam1814 requested a review from a team as a code owner April 29, 2026 05:07
Comment thread README.md
| Feature | Description |
|---------|-------------|
| **🎛️ Isolated Virtual Control Plane** | Each Tenant Cluster gets its own API server, controller manager, and data store — complete Kubernetes API isolation |
| **🔗 Shared Platform Stack** | Leverage the Control Plane Cluster's CNI, CSI, ingress, and other infrastructure — no duplicate platform components |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This isn't quite right because control plane cluster modes with private nodes wouldn't support this.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Right, sorry — fixed in 3b62b19. Qualifier is now (Shared / Dedicated Nodes). Private Nodes have their own CNI/CSI per the Architecture Comparison table above so they don't share the host stack.

Comment thread README.md
| **🔗 Shared Platform Stack** | Leverage the Control Plane Cluster's CNI, CSI, ingress, and other infrastructure — no duplicate platform components |
| **🔗 Shared Platform Stack** *(Control Plane Cluster modes)* | Leverage the Control Plane Cluster's CNI, CSI, ingress, and other infrastructure — no duplicate platform components |
| **🔒 Strong Tenant Isolation** | Tenants get admin access inside their Tenant Cluster while having minimal permissions on the Control Plane Cluster |
| **🔄 Resource Syncing** | Bidirectional sync of any Kubernetes resource — pods, services, secrets, configmaps, CRDs, and more |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This isn't quite right because control plane cluster modes with private nodes wouldn't support this.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Same fix in 3b62b19 — qualifier on Resource Syncing is now (Shared / Dedicated Nodes).

Comment thread README.md
| **🔄 Resource Syncing** *(Control Plane Cluster modes)* | Bidirectional sync of any Kubernetes resource — pods, services, secrets, configmaps, CRDs, and more |
| **💤 Sleep Mode** | Pause inactive Tenant Clusters to save resources. Instant wake when needed |
| **🖥️ Bare Metal & Standalone** | Run with or without a Control Plane Cluster. Purpose-built for AI factories and on-prem GPU fleets |
| **🧩 Integrations** | Native support for cert-manager, external-secrets, KubeVirt, Istio, and metrics-server |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This isn't quite right because control plane cluster modes with private nodes wouldn't support this.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed in 3b62b19 — Integrations note now says "host-side integrations apply in Shared / Dedicated Nodes modes," and the footnote below the table now reads:\n\n> Shared Platform Stack, Resource Syncing, and host-cluster integrations apply only in Shared and Dedicated Nodes modes, where the Tenant Cluster shares the Control Plane Cluster's CNI, CSI, and platform stack. Private Nodes and Standalone deployments bring their own CNI, CSI, and platform components.

saiyam1814 added 3 commits May 3, 2026 14:45
- Drop "(v1.35)" from the Kubernetes AI Conformant references in
  both the badge line and the prose certification line. 1.35 is
  the latest cert and pinning the version dates the README.
- Stop describing Standalone as bare-metal-only. Standalone runs
  on either dedicated infrastructure or bare metal, so the prose
  in "What is vCluster?", the Quick Start prerequisites, the
  Architectures intro, and the v0.29 changelog cell now reflect
  that. The Key Features row is renamed from "Bare Metal &
  Standalone" to "Standalone Deployment" with matching copy.
- Simplify the Free tier line by dropping the "Private Nodes,
  Auto Nodes, Standalone" enumeration. The list overlapped with
  "Unlimited Tenant Clusters" and read as technical noise next
  to the Platform UI bullet.
- Clarify which Key Features are mode-specific. Shared Platform
  Stack and Resource Syncing now carry a "(Control Plane Cluster
  modes)" qualifier, Integrations notes that host integrations
  apply only in Control Plane Cluster modes, and a footnote
  below the table calls out the Standalone behavior explicitly.
- vNode row in the Platform table: drop "tenant" from
  "Runtime-level tenant isolation" since Tenant Clusters
  already provide tenant isolation; vNode adds runtime
  sandboxing on top.
- Replace the "Links" table with a "Connect with us" bulleted
  list, matching the org-level profile README so the two pages
  feel consistent.
…t stack

Per @deniseschannon's review: my "(Control Plane Cluster modes)"
qualifier on Shared Platform Stack, Resource Syncing, and the
Integrations note was incorrect. The Architecture Comparison table
in this same README shows Private Nodes have CNI/CSI Isolation = ✅
— they bring their own networking and storage stack and do not share
the host cluster's platform.

The shared-host features apply only in **Shared** and **Dedicated
Nodes** modes:
- Shared Platform Stack → "(Shared / Dedicated Nodes)"
- Resource Syncing → "(Shared / Dedicated Nodes)"
- Integrations note → "host-side integrations apply in Shared /
  Dedicated Nodes modes"
- Footnote rewritten to spell out that Private Nodes and Standalone
  bring their own CNI, CSI, and platform components.

Also dropped the misplaced Standalone half-sentence from the Quick
Start prerequisites. The bash block right above it deploys vCluster
into an existing Kubernetes cluster (`vcluster create --namespace`),
which is not the Standalone install path. The vind callout below
already serves the "no Kubernetes cluster?" reader more accurately.
Adds the v0.34 row at the top of "What's New" linking to the
combined Platform v4.9 + vCluster v0.34 changelog.

Highlights captured:
- Active/active vCluster Platform across regions (Route 53
  latency-based routing + RDS-backed Postgres/MySQL)
- Standalone snapshot capture (`vcluster snapshot create
  --standalone`, S3 / OCI / local destinations)
- First-class template parameters in YAML and Platform UI

Also fixes a sibling messaging inconsistency in the same file:
the AI-factory four-layer summary line below the vCluster
Platform table previously read "Certified Stacks → Tenant
Isolation → Tenant Clusters → GPU Infrastructure Operations,"
which positioned Tenant Isolation as a separate layer from
Tenant Clusters. After this PR's vNode row was changed from
"Runtime-level tenant isolation" to "Runtime-level isolation,"
that arrow framing was inconsistent. Rewrote the line as a
non-ordered foundation list (matches what landed on the
loft-sh/.github org README), and switched "GPU clouds" to
"AI clouds" in line with current terminology.
@saiyam1814 saiyam1814 force-pushed the docs/readme-feedback-fixes branch from 3b62b19 to 5798742 Compare May 3, 2026 09:18
@saiyam1814
Copy link
Copy Markdown
Contributor Author

Pushed 57987423 adding the new release row and rebased on latest main.

v0.34 row — links to the Platform v4.9 + vCluster v0.34 changelog:

Active/active vCluster Platform across regions (Route 53 + RDS), Standalone snapshots (S3 / OCI / local), first-class template parameters

Sibling consistency fix — the AI-factory four-layer summary line below the Platform table previously read "Certified Stacks → Tenant Isolation → Tenant Clusters → GPU Infrastructure Operations." Since this PR's vNode row was changed from "Runtime-level tenant isolation" to "Runtime-level isolation," that arrow framing was inconsistent (and matches what @deniseschannon pushed back on for the org README). Rewrote it as a non-ordered foundation list, same wording that landed on loft-sh/.github, and switched "GPU clouds" to "AI clouds" in line with current terminology.

Re-verified the previous round of fixes is still in:

  • ✅ No (v1.35) anywhere
  • ✅ Standalone consistently described as "dedicated infrastructure or bare metal"
  • ✅ Free tier line is the simplified version (no Private Nodes / Auto Nodes / Standalone enumeration)
  • ✅ Mode qualifiers on Shared Platform Stack, Resource Syncing, and Integrations all read (Shared / Dedicated Nodes) — Private Nodes excluded
  • ✅ vNode row reads "Runtime-level isolation"
  • ✅ Connect-with-us list (no link table)

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