docs(example): run every example with crossplane render#102
Merged
Conversation
The examples only documented a live-cluster workflow. Give each one a self-contained setup so `crossplane render` works offline against a function-kro running in Development mode. Every example directory now has a schemas/ directory, a functions.yaml wiring function-kro (plus function-auto-ready where the pipeline uses it), and a README covering the render command with a link to the top-level cluster walkthrough. crossplane render has no cluster to read schemas from, so schemas/ holds an OpenAPI v3 schema for the XR and, for the AWS examples, the real VPC, Subnet, and SecurityGroup types from provider-aws-ec2 pruned to the fields the examples reference. Built-in Kubernetes types resolve from function-kro's compiled-in definitions and need no schema. The examples whose resources depend on each other, plus app, also include an observed.yaml. Without it render shows only the first wave; passing --observed-resources resolves the dependencies and populates status, so users can run both and see the difference, and collection-limits can trip its size guardrail once the collection expands. Drop basic's stale README, extra.yaml, and observed-*.yaml, which used the old non-namespaced ec2 API and the CRD fallback path. Signed-off-by: Jared Watts <jbw976@gmail.com>
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
1 participant
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.
Description of your changes
The current examples only document a live-cluster workflow. This PR now gives each one a self-contained setup so
crossplane rendercan be used to exercise them offline against a function-kro running in Development mode.Every example directory now has a
schemas/directory, afunctions.yamlwiringfunction-kro(plus function-auto-ready where the pipeline uses it), and aREADMEcovering the render command with a link to the top-level cluster walkthrough.crossplane renderhas no cluster to read schemas from, soschemas/holds an OpenAPI v3 schema for the XR and, for the AWS examples, the real VPC, Subnet, and SecurityGroup types from provider-aws-ec2 pruned to the fields the examples reference. Built-in Kubernetes types resolve fromfunction-kro's compiled-in definitions and need no schema.The examples whose resources depend on each other, plus app, also include an
observed.yaml. Without itrendershows only the first wave; passing--observed-resourcesresolves the dependencies and populates status, so users can run both and see the difference, and collection-limits can trip its size guardrail once the collection expands.This PR also drops the basic example's stale README, extra.yaml, and observed-*.yaml, which are no longer applicable.
I've gone through all these examples and reviewed their output, it all looks correct to me 😇
I have: