meshery/schemas

[MeshModel]: Relocate Design schema to this schemas repo

leecalcote opened this issue · 2 comments

leecalcote commented

Current Situation

Meshery Designs are a first-class construct of the tool.

Proposed Change

Add a formal OpenAPI-compatible definition in this repo.

Contributor Guides and Handbook

How to make updates to MeshModel

Instructions for Models

  1. Forthcoming

Instructions for Components

While the default shape for new components is a circle, each component should be considered for its best-fit shape.

  1. Review and familiarize with the available set of predefined relationship types. Refer the Cytoscape node types for a list of possible shapes.
  2. Propose a specific shape, best-suited to visually represent the Component. Example - Deployment as a pentagon.
  3. Proposee a specific icon, best-suited to visually represent the Component. Example - DaemonSet as a skull icon.

Instructions for Relationships

  1. 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.
  2. Propose a specific visual representation for the relationship. Visual representation examples:
  3. 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.
  4. Create a Relationship Definition (yaml). See the Relationship Schema in MeshModel and examples.
  5. Create a policy for evaluation of the relationship (rego). See examples.

Instructions for Policies

  1. Forthcoming
stale commented

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale commented

This issue is being automatically closed due to inactivity. However, you may choose to reopen this issue.