While the tool currently offers valuable functionality for generating example YAML files from Kubernetes Custom Resource Definitions (CRDs), many users working within the Crossplane ecosystem require similar support for CompositeResourceDefinitions (XRDs).
XRDs are a core component of Crossplane, allowing users to define their own custom resources. Having the ability to generate example YAML files from XRDs would significantly enhance the tool's utility for Crossplane users, streamlining their development process and reducing manual effort.
Proposed Solution
Extend the tool to include functionality that:
Automatically generates example YAML files from CompositeResourceDefinitions (XRDs). Maybe via autodetection?
This should be a relatively small change to implement, as XRDs essentially contain a CRD, with the OpenAPI part being identical. Therefore, the existing logic for CRDs can be reused with minor adjustments to accommodate the XRD-specific structures.
Benefits
Broader Utility: Expands the tool's applicability to the Crossplane community, supporting a broader range of Kubernetes users.
Increased Productivity: Simplifies the creation of example YAMLs for XRDs, saving users time and effort.
Seamless Integration: Provides a consistent approach and toolset for generating examples from both CRDs and XRDs, enhancing the overall user experience.
Unique Offering: As of now, I have not found any other tool that provides this functionality.
Minimal Effort Required: Since XRDs include parts of a CRD with an identical OpenAPI part, implementing this feature would involve minor adjustments to the existing logic, making it a relatively small and straightforward change.
Conclusion
By adding support for generating example YAMLs from CompositeResourceDefinitions (XRDs), we can significantly broaden the tool's appeal and utility. This feature would be a valuable addition, catering specifically to users within the Crossplane ecosystem and improving their workflow efficiency. Implementing this change should be relatively straightforward given the similarities between CRDs and XRDs.
Skarlso
commented
10 hours ago
Problem Statement
While the tool currently offers valuable functionality for generating example YAML files from Kubernetes Custom Resource Definitions (CRDs), many users working within the Crossplane ecosystem require similar support for CompositeResourceDefinitions (XRDs).
XRDs are a core component of Crossplane, allowing users to define their own custom resources. Having the ability to generate example YAML files from XRDs would significantly enhance the tool's utility for Crossplane users, streamlining their development process and reducing manual effort.
Proposed Solution
Extend the tool to include functionality that:
This should be a relatively small change to implement, as XRDs essentially contain a CRD, with the OpenAPI part being identical. Therefore, the existing logic for CRDs can be reused with minor adjustments to accommodate the XRD-specific structures.
Benefits
Conclusion
By adding support for generating example YAMLs from CompositeResourceDefinitions (XRDs), we can significantly broaden the tool's appeal and utility. This feature would be a valuable addition, catering specifically to users within the Crossplane ecosystem and improving their workflow efficiency. Implementing this change should be relatively straightforward given the similarities between CRDs and XRDs.
What do you think?