meshery / schemas

Logical object models for Meshery

If you like Meshery, please ★ this repository to show your support! 🤩

MESHERY IS A CLOUD NATIVE COMPUTING FOUNDATION PROJECT

A self-service engineering platform, Meshery, is the open source, cloud native manager that enables the design and management of all Kubernetes-based infrastructure and applications (multi-cloud). Among other features, As an extensible platform, Meshery offers visual and collaborative GitOps, freeing you from the chains of YAML while managing Kubernetes multi-cluster deployments.

Try Meshery in the Cloud Native Playground (teaser video)

 

Functionality

Cloud Native Lifecycle Management

Meshery manages the provisioning, configuration and operation of your Kubernetes clusters while supporting hundreds of different types of cloud native infrastructure integrations. Meshery also offers a catalog of curated design templates filled with configuration best practices.

Using a GitOps-centric approach, visually and collaboratively design and manage your infrastructure and microservices. Extend Meshery as your self-service engineering platform by taking advantage of its vast set of extensibility features, including gRPC adapters, hot-loadable Reactjs packages and Golang plugins, subscriptions on NATS topics, consumable and extendable API interfaces via REST and GraphQL.

Multi-Cluster Kubernetes, Multi-Cloud, and Cloud Native Configuration Management

Meshery supports 250+ integrations.

Assess your cloud native infrastructure configuration against deployment and operational best practices with Meshery's configuration validator. Manage your workloads with confidence. Check your Kubernetes configuration for anti-patterns and avoid common pitfalls.

Context-Aware Policies For Applications

Leverage built-in relationships to enforce configuration best practices consistently from code to Kubernetes. Enhance development process by building custom rules in Open Policy Agent's Rego query language.

Manage data plane intelligence with WebAssembly filters

Dynamically load and manage your own WebAssembly filters in Envoy-based service meshes.

See Image Hub.

Performance Management

Adhering to Cloud Native Standards

In an effort to produce service mesh agnostic tooling, Meshery uses the Service Mesh Performance specification as a common format to capture and measure your infrastructure's performance against a universal cloud native performance index. As an implementation of Service Mesh Interface (SMI), Meshery participates in advancing cloud native infrastructure adoption through the standardization of APIs.

Standardized Cloud Native Performance Management

Meshery is the cloud native utility for uniformly managing the performance of microservices and the infrastructure that run them. As an implementation of the Service Mesh Performance (SMP), Meshery enables you to measure the value provided by Docker, Kubernetes, or a service mesh in the context of the overhead incurred.

Meshery Architecture

You may deploy Meshery internal to your cluster or external to your cluster.

Learn more about Meshery's architecture.

Get Started with Meshery

Using `mesheryctl`

Meshery runs as a set of containers inside or outside of your Kubernetes clusters.

curl -L https://meshery.io/install | bash -

Use the quick start guide.

See all supported platforms

See the getting started section to quickly deploy Meshery on any of these supported platforms:

Platform	Supported?
Docker	✔️
Docker - Docker App	✔️
Docker - Docker Extension	✔️
Kubernetes	✔️
Kubernetes - AKS	✔️
Kubernetes - Docker Desktop	✔️
Kubernetes - EKS	✔️
Kubernetes - GKE	✔️
Kubernetes - Helm	✔️
Kubernetes - kind	✔️
Kubernetes - Minikube	✔️
Kubernetes - OpenShift	In Progress
Linux	✔️
Mac	✔️
Mac - Homebrew	✔️
Windows	✔️
Scoop	✔️
WSL2	✔️
Raspberry Pi	In Progress

Meshery documentation offers thorough installation guides for your platform of choice.

 

 

Join the Meshery community!

Our projects are community-built and welcome collaboration. 👍 Be sure to see the Contributor Journey Map and Community Handbook for a tour of resources available to you and the Repository Overview for a cursory description of repository by technology and programming language. Jump into community Slack or discussion forum to participate.

Find your MeshMate

MeshMates are experienced Layer5 community members, who will help you learn your way around, discover live projects, and expand your community network. Connect with a Meshmate today!

Find out more on the Layer5 community.

✔️ Join any or all of the weekly meetings on community calendar.
✔️ Watch community meeting recordings.
✔️ Fill-in a community member form to gain access to community resources.
✔️ Discuss in the Community Forum.
✔️ Explore more in the Community Handbook.

     Not sure where to start? Grab an open issue with the help-wanted label.

 

Contributing

Please do! We're a warm and welcoming community of open source contributors. Please join. All types of contributions are welcome. Be sure to read the Contributor Guides for a tour of resources available to you and how to get started.

 

Stargazers

If you like Meshery, please ★ star this repository to show your support! 🤩

License

This repository and site are available as open-source under the terms of the Apache 2.0 License.

schemas's Issues

Catalog Schema

          > @Yashsharma1911 is this good to merge?... because workflow is failing and catalog items are not updating seems an urgent thing

@MUzairS15 @Yashsharma1911 how are we ensuring that different systems use the same reference for these categories? Is it time for a Catalog.schema?

Originally posted by @leecalcote in meshery/meshery.io#1646 (comment)

[Schemas] Import Design: remove checklist for type

@Yashsharma1911 will you remove the checkboxes from this selection?

Slack Message

Migrate Credential, Connection, RJSF Schemas to here

Current Behavior

Desired Behavior

Implementation

Acceptance Tests

Mockups

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Enhancing relationship definition schema

Current Behavior

Desired Behavior

1. Enhancing the attributes like from to to be more descriptive.

Implementation

Acceptance Tests

Mockups

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Feature: Relationships add type

Current Behavior

Relationships have kind and subtype, which is not enough to accurately identify a given relationship definition.

Desired Behavior

Add type as a first-class property of the Relationship schema.

Implementation

• 1. Revise Relationship schema to include new property. Include field validation and description.
• 2. Version and release this new schema.
• 3. Open issue in github.com/meshery/meshkit to support this new property.
• 4. Open issue in github.com/meshery/meshery to support type in REST API.
• 5. Add field type and initial values to existing relationship definitions in Meshery Integrations sheet.
• 6. Support type in Registry in Meshery UI

Acceptance Tests

1. Users can see all Relationships by type in Meshery Registry.

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Designs: Relationships required? Can be nil?

          Relationships required? Can be nil?

A valid design can just have one component with no relationships.

Is there value in requiring relationships?

Originally posted by @leecalcote in #97 (comment)

Core Schema to support SemVer version string

Desired Behavior

https://schemas.meshery.io/v1alpha1/core.json#versionString - should support semver and should support rc in addition to alpha, beta versioning.

Implementation

Acceptance Tests

Mockups

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

[Relationships] Schema update: move from "rego_query" to "evalPolicy"

Current Behavior

Example - https://github.com/meshery/meshery/blob/047800b0c42b9c100821f59601e11ac20d30b568/server/meshmodel/kubernetes/relationships/edge_mount.json#L18C1-L19C1

Desired Behavior

Change from "rego_query" to "evalPolicy"

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Migrate schemas from Cloud to schemas repo

Current Behavior

Desired Behavior

Implementation

Acceptance Tests

Mockups

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

New Schema: TelemetryProvider, Dashboard, Chart

Current Behavior

Desired Behavior

Implementation

See Meshery Architecture deck.

Acceptance Tests

Mockups

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

[MeshModel]: Relocate Design schema to this schemas repo

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

• MeshModel Repository
• 🖥 MeshModel Overview
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

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:
   • Hierarchical
   • Sibling
   • Binding
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

[Question] Is catalog schema in the proper directory?

Current Behavior

From the perspective of the layout and organization of this repo, is this where it belongs?

Desired Behavior

Ideally, there is a description of the organization of this repo by top-level folder in the README.

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Move Environment schemas to new schemas repo

Current Behavior

Desired Behavior

Implementation

Acceptance Tests

Mockups

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Graduate Meshery Schemas to beta

Current Behavior

Desired Behavior

Implementation

Acceptance Tests

Mockups

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

[Chore] Change versioning Schemas to semver and start making releases, so that the Golang package can be imported.

Current Behavior

Schemas are versioned as v1alpha1 and so on.

Desired Behavior

Change versioning Schemas to semver and start making releases, so that the Golang package can be imported.

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Selector v1alpha3: Consolidate "from" and "to" into a single selector definition.

          Consolidate "from" and "to" into a single selector definition.

Originally posted by @leecalcote in #97 (comment)

Catalog schema: Proposal to shift classes from `enum `to `oneof` type string

Current Behavior

Regarding this discussion, meshery/meshkit#542 (comment), the current approach to having Catalog content class descriptions in a separate, single property makes extraction of the enum value and its corresponding description a bit more challenging than is perhaps necessary.

Proposal:

{
    "type": "string",
    "oneOf": [
        { "const": "open", "description": "The issue is currently open." },
        { "const": "closed", "description": "The issue has been resolved." },
        { "const": "pending" } // Waiting for more information
    ]
}

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Enhancement to Relationship Selectors

Current Behavior

Relationship Selectors v1alpha2 have an unnecessary copy of Model version as a property.

Relationship Selectors v1alpha2 are missing a property to capture their declared (Designs) or realized instances (Views).

Desired Behavior

Proposed enhancement in Relationship Selectors as a v1alphav3:

1. Remove version field of Selector schema (https://github.com/meshery/schemas/blob/a7561a749e4dd8b9312fd39f4d11b8b0aac08f74/schemas/constructs/v1alpha2/selectors.json#L19C1-L21C11)
2. Relationship Definitions need To: From: Declaration ID property.

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

[Relationships] Operators in Version field

Current Behavior

Many relationships are defined with a specific value in the Version field; e.g.

version: v1.25.2

Desired Behavior

The Relationships schema should support ">" and ">=" in the Versions field.

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Reconcile schema differences in remote provider

Current Behavior

Finalize schema relocation.

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma (open invite)
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Migrate MeshModel schemas from MeshKit

Current Behavior

Desired Behavior

Implementation

Acceptance Tests

Mockups

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

New Schema: Activity

Current Behavior

Meshery will embed a workflow engine.

Desired Behavior

Consequently, Meshery will need a Workflow and Activity schemas defined (or similar constructs).

Implementation

Design spec needed

Acceptance Tests

Design spec needed

Mockups

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Publish definitions for core, shapes, flowchart models in support of Component v1beta1

Current Behavior

Desired Behavior

Implementation

Acceptance Tests

Mockups

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

[CI] Establish Release Notes Drafter

Current Behavior

Desired Behavior

Implementation

Acceptance Tests

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
• Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack
• 🧪 Meshery Test Plan Spreadsheet

New Schema: Workflows

Current Behavior

Meshery will embed a workflow engine.

Desired Behavior

Consequently, Meshery will need a Workflow and Activity schemas defined (or similar constructs).

Implementation

Design spec needed

Acceptance Tests

Design spec needed

Mockups

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Treating Designs as an abstraction, applying DRY

Current Behavior

Designs are declarations (see Contributing to Mehery Models for a definition of what a declaration is) and are largely abstracts amalgamating existing component and relationship definitions into a document.

Desired Behavior

In doing so, Designs should avoid recreating / redefining properties of existing Meshery resources.

Implementation

1. Includes $refComponent and $refRelationship.
2. Make “components” an array of $refComponents (

   schemas/schemas/constructs/v1beta1/designs.json

   Lines 22 to 26 in a7561a7

   	"description": "Map of component instances to their corresponding component declarations",
   	"additionalProperties": {
   	"type": "string",
   	"format": "uuid"
   	},

   )

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Question: Should Meshery Schemas have a core definition for JSONPath instead of using "string" type?

Example:

"mutatedRef": {
                "type": "string",
                "description": "JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."
              }

Enhancement to Components: Configuration property

Current Behavior

In adherence to Meshery Model's design principles:

1. Treat 3rd-party-authored content/manifests/schemas as hermetically sealed objects.
2. Treat all Definitions similarly within Meshery’s object model.

Components need a way of capturing declared configuration.

Implementation

1. Move “configuration” from Designs to Components (

   schemas/schemas/constructs/v1beta1/designs.json

   Lines 54 to 58 in a7561a7

   	"configuration": {
   	"$comment": "The configuration of the component. The configuration is based on the schema defined within the component definition.",
   	"additionalProperties": {
   	"type": "string"
   	},

   )
2. Move “id” from Designs to Components (

   schemas/schemas/constructs/v1beta1/designs.json

   Lines 23 to 26 in a7561a7

   	"additionalProperties": {
   	"type": "string",
   	"format": "uuid"
   	},

   )

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Automated publishing of Meshery core definitions

          Is there a conjoining PR in meshery/meshery to delete these definitions?

Is the registry model generator configured to source components from meshery/schemas?

Or is there workflow that needs to populate meshery/meshery with updates to these schemas? // @MUzairS15

Originally posted by @leecalcote in #58 (comment)

Relationship v1alpha3 - use selector $ref.

          This can be replaced with a selector $ref.

Originally posted by @leecalcote in #97 (comment)

New Resource: "Key"; Publish Key Schema

          ref to the key schema is missing here . i dont know if the openapi key schema works for a general key construct

Originally posted by @codeSafari10 in #116 (comment)

[Models] Add `status` field

          @Yashsharma1911 this will need to move to `status` with the MeshKit change, too. The `meshery/schemas` will need updated, too.

Originally posted by @leecalcote in meshery/meshery#10171 (comment)

Selector v1alpha3: Should be a component $ref.

          Should be a component $ref.

Originally posted by @leecalcote in #97 (comment)