Skip to content

Add v1beta3 preflight guidance for Embedded Cluster v3#4186

Draft
AmberAlston wants to merge 1 commit into
mainfrom
ec-v3-preflight-v1beta3-docs
Draft

Add v1beta3 preflight guidance for Embedded Cluster v3#4186
AmberAlston wants to merge 1 commit into
mainfrom
ec-v3-preflight-v1beta3-docs

Conversation

@AmberAlston

Copy link
Copy Markdown
Member

Summary

Expands the v1beta3 preflight documentation for EC v3 from a one-liner link to the troubleshoot.sh project into actionable, Replicated-owned guidance.

What this PR addresses now:

  • Why EC v3 requires v1beta3 for preflights (Helm-native rendering, external spec packaging)
  • That support bundles are unaffected (v1beta2 continues to work)
  • Key differences from v1beta2 (Helm syntax not repl{{}}, spec lives outside charts, not valid YAML pre-render)
  • Migration checklist on the v2-to-v3 page: change apiVersion, move spec out of chart, remove Secret wrapper, replace template syntax
  • New "Add preflight checks" section on the configure page with single-chart and multi-chart examples
  • Current limitations (one spec per release, Helm syntax only, YAML linters won't work pre-render)

What's outstanding (blocked on in-progress implementation work):

  • How external spec injection works end-to-end once the global.preflight gate lands (ec#475)
  • The native Helm side of the story (helm template --set global.preflight=true | preflight workflow)
  • Concrete examples with real rendered output showing what the spec looks like after Helm rendering
  • How preflight result upload works in v1beta3 (--upload-results-to CLI flag replacing uploadResultsTo in spec)
  • In-cluster collector execution guidance (sc-138530, needs owner and implementation)

Related stories:

  • sc-136287 (document how v1beta3 works with EC v3)
  • sc-138515 (linter does not recognize v1beta3)
  • sc-138512 (hasPreflightSpec does not detect v1beta3)
  • sc-138532 (warn at promote time when EC v3 release has v1beta2 preflight)
  • sc-138530 (in-cluster collector execution)

Test plan

  • Local docs preview renders both updated pages correctly
  • All cross-page links resolve
  • Code examples are syntactically valid Helm templates

🤖 Generated with Claude Code

Expand the migration page's v1beta3 section from a one-liner into
actionable guidance: what changed, why v1beta3 is required, step-by-step
migration checklist, and clarification that support bundles are unaffected.

Add a new "Add preflight checks" section to the EC v3 configure page
with how v1beta3 specs work, single-chart and multi-chart examples,
and current limitations.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@netlify

netlify Bot commented Jun 18, 2026

Copy link
Copy Markdown

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit 849b57f
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs/deploys/6a347312001ebb0008ca8ca7
😎 Deploy Preview https://deploy-preview-4186--replicated-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Jun 18, 2026

Copy link
Copy Markdown

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit 849b57f
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs-upgrade/deploys/6a3473133c9dcc000887674f
😎 Deploy Preview https://deploy-preview-4186--replicated-docs-upgrade.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@replicated-ci replicated-ci added type::docs Improvements or additions to documentation type::feature labels Jun 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type::docs Improvements or additions to documentation type::feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants