Skip to content

Conversation

roguepikachu
Copy link
Contributor

@roguepikachu roguepikachu commented Oct 1, 2025

Add comprehensive documentation for the ValidateResourcesExist feature that validates Kubernetes resource types in definition CUE templates.

  • Document webhook-based validation for output/outputs resources
  • Add examples for single and multiple outputs (success/failure)
  • Include CRD installation guidance and addon exemptions
  • Add troubleshooting guide and debug commands
  • Update v1.10 sidebar navigation

Feature is available in v1.10.4+ as an alpha feature gate.

Description of your changes

I have:

  • Read and followed KubeVela's contribution process.
  • Update sidebar.js if adding a new page.
  • Run yarn start to ensure the changes has taken effect.

Summary by cubic

Added docs for Validate Definition Output Resources (ValidateResourcesExist) to explain webhook-based checks for resource types in CUE definitions and how to enable them. Updated the v1.10 sidebar and included examples, CRD guidance, addon exemptions, and troubleshooting.

  • Migration
    • Enable with: vela install --set features.ValidateResourcesExist=true (alpha, v1.10.4+; default off)
    • Ensure the KubeVela webhook is configured
    • Install required CRDs before applying definitions referencing them

Add comprehensive documentation for the ValidateResourcesExist feature
that validates Kubernetes resource types in definition CUE templates.

- Document webhook-based validation for output/outputs resources
- Add examples for single and multiple outputs (success/failure)
- Include CRD installation guidance and addon exemptions
- Add troubleshooting guide and debug commands
- Update v1.10 sidebar navigation

Feature is available in v1.10.4+ as an alpha feature gate.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>
@roguepikachu roguepikachu force-pushed the docs/add-resources-exists-validation-feature-documentation branch from ad9c228 to 0e8b4c7 Compare October 1, 2025 06:48
Copy link

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

No issues found across 2 files

…dation documentation

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>
@FogDong FogDong merged commit 34ad0eb into kubevela:main Oct 1, 2025
6 checks 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.

3 participants