meshery
meshery copied to clipboard
Published
4 months ago
•
meshery
meshery
[Models] Support for Kubernetes cluster-api CRDs
Current Situation
Meshery does not have an existing model for cluster-api.
Proposed Change
Add support for all Kubernetes cluster-api CRDs available here - https://github.com/kubernetes-sigs/cluster-api/tree/main/config/crd
General Contributor Guides and Handbook
- 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack
Understanding Meshery Models
Contributing to Meshery Models
- https://docs.meshery.io/project/contributing/contributing-models
- https://docs.meshery.io/project/contributing/contributing-relationships
Instructions for Models
To add or update a model, follow these steps:
- Create a Model Definition (yaml).
Instructions for Components
While the default shape for new components is a circle, each component should be considered for its best-fit shape.
- Review and familiarize with the available set of predefined relationship types. Refer the Cytoscape node types for a list of possible shapes.
- Propose a specific shape, best-suited to visually represent the Component. Example - Deployment as a pentagon.
- Proposee a specific icon, best-suited to visually represent the Component. Example - DaemonSet as a skull icon.
Instructions for Relationships
- Identify the relationship and any specific constraints to be enforced between one or more specific components within the same or different models.
- Propose a specific visual representation for the relationship. See list of visualizations on Visualizing Relationships
- Prospose the appropriate relationship type, using one of the predefined set of relationship types or suggest a new relationship where an existing type does not fit.
- Create a Relationship Definition (yaml).
- (Typically not necessary) create a policy for evaluation of the relationship (rego).
- Review a prior pull request as an example of how to define a Relationships: https://github.com/meshery/meshery/pull/9880/files
