meshery / meshery

Meshery, the cloud native manager
https://meshery.io
Apache License 2.0
4.89k stars 1.52k forks source link

[Models] Enhance CertManager model with Components #10862

Open leecalcote opened 2 weeks ago

leecalcote commented 2 weeks ago

Current Situation

Meshery has an existing model for CertManager, but has no supported components, yet.

Proposed Change

Add support for all CertManager CRDs available here - https://github.com/cert-manager/cert-manager/tree/master/deploy/crds


General Contributor Guides and Handbook

Understanding Meshery Models

Contributing to Meshery Models

Instructions for Models

To add or update a model, follow these steps:

  1. 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.

  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 one or more specific components within the same or different models.
  2. Propose a specific visual representation for the relationship. See list of visualizations on Visualizing Relationships
  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).
  5. (Typically not necessary) create a policy for evaluation of the relationship (rego).
  6. Review a prior pull request as an example of how to define a Relationships: https://github.com/meshery/meshery/pull/9880/files
praduman8435 commented 2 weeks ago

Hi @leecalcote , may I work on this issue

leecalcote commented 2 weeks ago

@praduman8435 let’s set you up for success and find you another issue.