area/docsarea/modelshelp wantedissue/willfix
仓库指标
- 星标
- (10,013 个星标)
- PR 合并指标
- (平均合并 22天 16小时) (30 天内合并 332 个 PR)
描述
Current Situation
We do not have an adequate amount of Kubernetes examples published in MeshModel.
Proposed Change
See the examples and CRDs from this repository and
- Create a dedicated folder or section for examples and CRDs.
- Update and enhance documentation for better clarity and usability.
Contributor Guides and Handbook
- MeshModel Repository
- 🖥 MeshModel Overview
- 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack
How to make updates to MeshModel
Instructions for Models
- Forthcoming
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 the two specific components, their models or potentially other components, models, or environmental considerations.
- Propose a specific visual representation for the relationship. Visual representation examples:
- 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). See the Relationship Schema in MeshModel and examples.
- Create a policy for evaluation of the relationship (rego). See examples.
Instructions for Policies
- Forthcoming