Meshery Documentation

Overview & Installation

🚀 Quick Start and FAQs

Installation

AKS - Manage your AKS clusters with Meshery. Deploy Meshery in AKS in-cluster or out-of-cluster.
Bash - Install Meshery CLI on Linux or MacOS with Bash
Brew - Install Meshery CLI on Linux or MacOS with Brew
Codespaces - Build and contribute to Meshery using GitHub Codespaces
Compatibility Matrix - An installation compatibility matrix and project test status dashboard.
Docker Extension - Install Docker Extension for Meshery
Docker - Install Meshery on Docker
EKS - Install Meshery on Elastic Kubernetes Service. Deploy Meshery in EKS in-cluster or outside of EKS out-of-cluster.
GKE - Install Meshery on Google Kubernetes Engine. Deploy Meshery in GKE in-cluster or outside of GKE out-of-cluster.
Helm - Install Meshery on Kubernetes using Helm. Deploy Meshery in Kubernetes in-cluster.
KinD - Install Meshery on KinD. Deploy Meshery in KinD in-cluster or outside of KinD out-of-cluster.
Kubernetes - Install Meshery on Kubernetes. Deploy Meshery in Kubernetes in-cluster or outside of Kubernetes out-of-cluster.
KubeSphere - Install Meshery on KubeSphere
Install Meshery CLI on Linux or Mac - Install Meshery CLI on Linux or Mac
Minikube - Install Meshery on Minikube. Deploy Meshery in Minikube in-cluster or outside of Minikube out-of-cluster.
Meshery Playground - Details of the cloud native playground
Scoop - Install Meshery CLI on Windows with Scoop
Install Meshery CLI on Windows - Install Meshery CLI on Windows

Concepts

Logical

Components - Meshery Components identify and characterize infrastructure under management.
Connections - Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are managed by a state machine and used within one or more Environments.
Credentials - Meshery uses one or more Credentials when authenticating to a managed or unmanaged Connection.
Designs - Meshery Designs are descriptive, declarative characterizations of how your Kubernetes infrastructure should be configured.
Environments - Environments are how you organize your deployment targets (whether on-premises servers or cloud services) into resource groups.
Models - Meshery uses a set of resource models to define concrete boundaries to ensure extensible and sustainable management.
Patterns - Meshery Patterns are descriptive, declarative characterizations of how your Kubernetes infrastructure should be configured.
Policies - Meshery Policies enable you with a broad set of controls and governance of the behavior of systems under Meshery's management.
Registry - Meshery Registry is a database acting as the central repository for all capabilities known to Meshery. These capabilities encompass various entities, including models, components, relationships, and policies.
Relationships - Meshery Relationships identify and facilitate genealogy between Components.
Workspaces - Meshery Workspaces act as central collaboration point for teams.

Architectural

Adapters - Adapters extend Meshery's management capabilities in any number of ways, including lifecycle, configuration, performance, governance, identity...
Architecture - overview of different individual components of Meshery architecture and how they interact as a system.
Broker - Meshery broker component facilitates data streaming between kubernetes cluster components and outside world.
Catalog - Browsing and using cloud native patterns
Database - Meshery offers support for internal caching with the help of file databases. This has been implemented with several libraries that supports different kinds of data formats.
MeshSync - MeshSync ensures Meshery Server is continuously in-sync with the state of infrastructure under management.
Operator - Meshery Operator controls and manages the lifecycle of components deployed inside a kubernetes cluster

Guides & Tutorials

Using Meshery CLI Guides

Authenticating with Meshery via CLI - Get your authentication token from Meshery CLI.
Configuring Autocompletion for `mesheryctl` - Bash, Zsh, Oh My Zsh, and fish autocompletion for `mesheryctl` commands.
Meshery CLI Guides - Guides for common tasks while using Meshery's CLI, mesheryctl.
Running system checks using Meshery CLI - Run pre-flight and post-deployment system health checks using Meshery's CLI, mesheryctl.
Mesheryctl system commands - Mesheryctl system commands for managing Meshery deployments.
Using Meshery CLI - Guides for common tasks while using Meshery's CLI, mesheryctl.

🧑‍🔬 Tutorials

Deploy AWS EC2 Instances with Meshery - Learn how to deploy and manage AWS EC2 instances through Kubernetes with Meshery, utilizing AWS Controllers for Kubernetes (ACK) to enhance cloud resource management
Deploying Apache Cassandra with a StatefulSet in Meshery Playground - Deploy Apache Cassandra with a StatefulSet using Meshery Playground in an interactive live cluster environment.
Deploying PHP Guestbook application with Redis in Meshery - In this tutorial, we will deploy guest book built with PHP and Redis in Kubernetes. We will make use of Meshery Playground in an interactive live cluster environment.
Embedding a Meshery Design in a WordPress Post - Learn how to Embed a Meshery Design in a WordPress Post
Exploring Kubernetes CronJobs - In this tutorial, we will explore how to use Meshery Playground, an interactive live cluster environment, to perform hands-on labs for managing Kubernetes CronJobs.
Understanding Kubernetes ConfigMaps and Secrets with Meshery - In this tutorial, we will explore how to effectively use Kubernetes ConfigMaps and Secrets for managing configuration data and sensitive information. Leveraging Meshery Playground, an interactive live cluster environment, we'll perform hands-on labs to understand the practical aspects of working with ConfigMaps and Secrets in Kubernetes.
Exploring Kubernetes Deployments with Meshery - Explore a Kubernetes Deployment using Meshery Playground, an interactive live environment, through a series of hands-on exercises.
Exploring Kubernetes Pods with Meshery - Explore Kubernetes Pods using Meshery in an interactive live cluster environment, through a series of hands-on exercises.
Publishing Meshery Designs to ArtifactHub - Step by step example for how to export Meshery Designs and publish them to an ArtifactHub repository.
Deploying WordPress and MySQL with Persistent Volumes with Meshery - Deploy a WordPress site and a MySQL database with Persistent Volumes using Meshery Playground in an interactive live cluster environment.

Infrastructure Management

Deploying Sample Applications - This guide is to help users get a better understanding of sample apps
Managing Events with Notification Center - Meshery tracks operations performed on your infrastructure and workloads, and provides notification of environment issues, application conflicts with infrastructure configuration, policy violations, and so on.
Envoy WASM Filter Management - Meshery provides the ability to manage WASM filters for data plane proxies for agility, maintainability, diversity, reliability and isolation, security, and speed.
GitOps with Meshery - Integrating your CI/CD pipelines with Meshery's GitHub Actions
Infrastructure Discovery - MeshSync supports both greenfield and brownfield discovery of infrastructure. Greenfield discovery manages infrastructure created and managed entirely by Meshery, while brownfield discovery identifies separately created infrastructure.
Infrastructure Management - Meshery provides the ability to manage infrastructure for agility, maintainability, diversity, reliability and isolation, security, and speed.
Managing Connections - Manage the lifecycle of your infrastructure by registering each infrastructure element with Meshery.

Performance Management

Interpreting Performance Test Results - This guide is to help users to glean an insights of what the performance tests result should look like.
Managing Performance - Advanced performance characterization with Meshery.
Using Metrics in Meshery - How to connect and use Prometheus and Grafana metrics in Meshery
Performance Management with Meshery - This guide is to help users get a better overview of running and managing performance tests in Meshery

Configuration Management

Configuring your Cloud Native Infrastructure and Applications - Learn how to use Meshery Designs effectively
Creating a Meshery Design - Learn how to create a Meshery design from scratch or from a template.
Create Models - A comprehensive guide on creating models in Meshery, covering both CLI and UI methods.
Exporting Models - Exporting Meshery Model as an OCI or Compress file
Importing Models - Importing Existing Model and CRD-based Infrastructure Configurations into Meshery as Model
Cloud Native Design Patterns - Meshery applies DRY principle when managing the configuration of cloud native infrastructure .
Push or Pull a Model Image - Push or pull a model image to or from an OCI-compatible image repository.

Troubleshooting Guides

Troubleshooting Meshery Installations - Troubleshoot Meshery installation and deployment
Meshery Operator, MeshSync, Broker Troubleshooting Guide - Comprehensive guidance for troubleshooting Meshery Operator, MeshSync and Broker deployments under various scenarios.
Troubleshooting Errors while running Meshery - Troubleshooting Meshery errors when running make run-fast / meshery system start

Integrations & Extensions

Extensions

Component Shape Guide - Kubernetes architecture deployment and architecture diagramming tool for cloud native applications - Kanvas.
Edges Style Guide - Visualize and manage complex cloud-native relationships with Kanvas' dynamic edge styling in Kubernetes architecture.
Import and Export Designs - Manage and transfer Meshery designs seamlessly through import and export using CLI and UI.
kubectl MeshSync Snapshot - A native kubectl plugin for conveniently synchronizing the state of your cluster with Meshery Server.
Helm Kanvas Snapshot - Helm CLI plugin to visually render a snapshot of your Helm charts.
Kanvas - Collaborative cloud native visual designer to design and manage infrastructure and applications.
Kanvas Snapshot - Screenshot service provided via Kanvas to capture a snapshot of your infrastructure at any given time.
Extensions - Extensions are additional plugins or add-ons that provide extra functionalities beyond the core features of the Meshery.
Meshery Integrations - Meshery architecture is extensible. Meshery provides several extension points for working with different cloud native projects via adapters, load generators and providers
Merging Designs - Treat other designs as templates or building blocks and combine your designs with others and power-up your designs.
Publishing a Design - Learn to publish and manage designs in Meshery with clear state transitions, role-based permissions, and common workflow FAQs.
Sharing a Design - Sharing a design lets you make your content visible to any anonymous visitor of meshery.io/catalog and any Meshery Cloud user.
Working with Tags - Tags can be used to visually group components.

Integrations

See all 343 integations

Contributing & Community

Contributing

Build & Release (CI) - Details of Meshery's build and release strategy.
Contributing to Meshery Adapters - How to contribute to Meshery Adapters
Contributing to Meshery CLI End-to-End Tests - How to contribute to Meshery Command Line Interface end-to-end testing with BATS.
Contributing to Meshery CLI - How to contribute to Meshery Command Line Interface.
Contributing to Meshery Docker Extension - How to contribute to Meshery Docker Extension
Meshery Documentation Structure and Organization - Audience, high-Level outline & information architecture for Meshery Documentation
Contributing to Meshery Docs - How to contribute to Meshery Docs.
How to write MeshKit compatible errors - How to declare errors in Meshery components.
Contributing to Meshery using git - How to contribute to Meshery using git
Meshery CLI Contributing Guidelines - Design principles and code conventions.
Contributing to Model Components - How to contribute to Meshery Model Components
Contributing to Model Relationships - How to contribute to Meshery Models Relationships, Policies...
Contributing to Models Quick Start - A no-fluff guide to creating your own Meshery Models quickly.
Contributing to Models - How to contribute to Meshery Models, Components, Relationships, Policies...
Contributing to Meshery Policies - How to contribute to Meshery Policies
Contributing to Meshery Schemas - How to contribute to Meshery Schemas
Contributing to Meshery Server Events - Guide is to help backend contributors send server events using Golang.
Contributing to Meshery UI - Notification Center - How to contribute to the Notification Center in Meshery's web-based UI.
Contributing to Meshery UI - Sistent - How to contribute to the Meshery's web-based UI using sistent design system.
Contributing to Meshery UI End-to-End Tests - How to contribute to end-to-end testing in Meshery UI using Playwright.
Contributing to Meshery UI - Dashboard Widgets - Guide to extending Meshery dashboards with custom widgets.
Contributing to Meshery UI - How to contribute to Meshery UI (web-based user interface).
Contributing - How to contribute to the Meshery project and any of its components.
Contributing and Community - Information about contributing to the Meshery project and participating the Meshery community.
Contributing to Meshery Server - How to contribute to Meshery Server
Setting up Meshery Development Environment on Windows - How to set up Meshery Development Environment on Windows
End-to-End Test Status - Status reports of Meshery's various test results.

Extensibility & Reference

Extensibility

Extensibility: Meshery Adapters - Meshery architecture is extensible. Meshery provides several extension points for working with different cloud native infrastructure via adapters, load generators and providers.
Extensibility: APIs - Meshery architecture is extensible, offering an array of extension points and REST and GraphQL APIs.
Extensibility: Authorization - Meshery architecture is extensible. Meshery provides several extension points for working with different cloud native projects via authorization, adapters, load generators and providers.
Extensibility: Load Generators - Meshery offers support for more types of Kubernetes and cloud native infrastructure than any other project or product in the world. Meshery uses adapters for more deeply managing specific types of infrastructure.
Extensibility: Providers - Meshery uses providers to enrich the level of depth by which it manages cloud native infrastructure.
Extensibility: UI - Meshery offers support for more adapters than any other project or product in the world. Meshery UI has a number of extension points that allow users to customize their experience with third-party plugins.
Verifying Compatibility With Golang Version Update - When Meshery is updated to use a new version of Golang, extension providers need to ensure their integrations remain compatible by updating their extension to align with Meshery.

As a self-service engineering platform, Meshery enables collaborative design and operation of cloud and cloud native infrastructure.