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

Overview & Installation

• 🚀 Quick Start and FAQs

Installation

• Accessing Meshery UI
• Codespaces - Build and contribute to Meshery using GitHub Codespaces
• Compatibility Matrix - An installation compatibility matrix and project test status dashboard.
• Docker - Install Meshery on Docker
• Install Meshery CLI on Linux or macOS - Install Meshery CLI on Linux or macOS
• Install Meshery CLI on Windows - Install Meshery CLI on Windows
• Install mesheryctl - Install Meshery CLI
• Installation
• Installation - Installation procedures for deploying Meshery with mesheryctl.
• Kubernetes - Install Meshery on Kubernetes. Deploy Meshery in Kubernetes in-cluster or outside of Kubernetes out-of-cluster.
• Meshery Playground - Details about Meshery Playground
• Upgrading Meshery and all of its components - How to upgrade Meshery and all of its components
• Using Multiple Adapters - Meshery is capable of running zero or more adapters. Meshery offers many features without the need for adapters. Adapters are optional components that enhance and extend Meshery's core functionality.

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.
• Logical - Logical Concepts for understanding Meshery's various features and components.
• 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 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.
• Mesheryctl system commands - Mesheryctl system commands for managing Meshery deployments.
• Running system checks using Meshery CLI - Run pre-flight and post-deployment system health checks using Meshery's CLI, mesheryctl.
• Using Meshery CLI - Guides for common tasks while using Meshery's CLI, mesheryctl.

🧑‍🔬 Tutorials

• Artifacthub
• AWS
• Azure
• Kubernetes
• Tutorials - Explore the tutorials to learn how to use Meshery for collaboratively managing infrastructure.
• Wordpress

Infrastructure Management

• Deploying Sample Applications - This guide is to help users get a better understanding of sample apps
• 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.
• Infrastructure Management Guides - Guides for understanding Meshery's ability to manage infrastructure.
• Managing Connections - Manage the lifecycle of your infrastructure by registering each infrastructure element with Meshery.
• 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.

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.
• Performance Management Guides - Guides for understanding Meshery's ability to characterize and analyze performance of your infrastructure and applications.
• Performance Management with Meshery - This guide is to help users get a better overview of running and managing performance tests in Meshery
• Using Metrics in Meshery - How to connect and use Prometheus and Grafana metrics in Meshery

Configuration Management

• Cloud Native Design Patterns - Meshery applies DRY principle when managing the configuration of cloud native infrastructure.
• Configuration Management Guides - Guides for understanding Meshery's ability to configure infrastructure and applications
• Configuring your Cloud Native Infrastructure and Applications - Learn how to use Meshery Designs effectively
• Create Models - A comprehensive guide on creating models in Meshery, covering both CLI and UI methods.
• Creating a Meshery Design - Learn how to create a Meshery design from scratch or from a template.
• Edge Styles Guide - Learn about the different edge styles and how to interpret their visual meaning in Meshery's component relationships.
• Exporting Models - Exporting Meshery Model as an OCI or Compress file
• Identifying Meshery Components - A guide to help you identify and understand the various component icons, shapes, and visual styles used across the Meshery UI.
• Importing Models - Importing Existing Model and CRD-based Infrastructure Configurations into Meshery as Model
• Push or Pull a Model Image - Push or pull a model image to or from an OCI-compatible image repository.

Troubleshooting Guides

• 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
• Troubleshooting Extensions for Local Development - A guide to troubleshooting Meshery extensions in a local development environment.
• Troubleshooting Guide - The documentation in the Troubleshooting section provides comprehensive guidance on troubleshooting in Meshery and its components, ensuring you can address common issues efficiently.
• Troubleshooting Meshery Installations - Troubleshoot Meshery installation and deployment

Integrations & Extensions #

Extensions

• Adapters - Meshery architecture is extensible. Meshery provides several extension points for working with different cloud native infrastructure via adapters, load generators and providers.
• Extensions - Extensions are additional plugins or add-ons that provide extra functionalities beyond the core features of the Meshery.
• Helm Kanvas Snapshot - Helm CLI plugin to visually render a snapshot of your Helm charts.
• Import and Export Designs - Manage and transfer Meshery designs seamlessly through import and export using CLI and UI.
• 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.
• kubectl MeshSync Snapshot - A native kubectl plugin for conveniently synchronizing the state of your cluster with Meshery Server.
• Meshery Models - Meshery architecture is extensible. Meshery provides several extension points for working with different cloud native projects via adapters, load generators and providers

Integrations

• See all 391 integrations

Contributing & Community #

Community

• 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.
• Meshery Community - Meshery's open source, cloud native community
• Meshery Overview - Meshery is the self-service engineering platform, enabling collaborative design and operation of cloud and cloud native infrastructure.
• Project
• Releases - List of released Meshery versions and their release notes.
• Security Vulnerabilities - How the Meshery team handles security vulnerabilities.

Contributing

• Build & Release (CI) - Details of Meshery's build and release strategy.
• Contributing - How to contribute to the Meshery project and any of its components.
• Contributing to Meshery Adapters - How to contribute to Meshery Adapters
• Contributing to Meshery CLI - How to contribute to Meshery Command Line Interface.
• 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 Docker Extension - How to contribute to Meshery Docker Extension
• Contributing to Meshery Docs - How to contribute to Meshery Docs.
• Contributing to Meshery Policies - How to contribute to Meshery Policies
• Contributing to Meshery Schemas - How to contribute to Meshery Schemas
• Contributing to Meshery Server - How to contribute to Meshery Server
• Contributing to Meshery Server Events - Guide is to help backend contributors send server events using Golang.
• Contributing to Meshery UI - How to contribute to Meshery UI (web-based user interface).
• Contributing to Meshery UI - Dashboard Widgets - Guide to extending Meshery dashboards with custom widgets.
• 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 using git - How to contribute to Meshery using git
• 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 - How to contribute to Meshery Models, Components, Relationships, Policies...
• Contributing to Models Quick Start - A no-fluff guide to creating your own Meshery Models quickly.
• End-to-End Test Status - Status reports of Meshery's various test results.
• How to write MeshKit compatible errors - How to declare errors in Meshery components.
• Meshery CLI Style Guide - Design principles and code conventions.
• Meshery Documentation Structure and Organization - Audience, high-Level outline & information architecture for Meshery Documentation
• Schema-Driven UI Development in Meshery - How to contribute to Meshery Schemas for UI
• Setting up Meshery Development Environment on Windows - How to set up Meshery Development Environment on Windows

Extensibility & Reference #

Reference

• Command Line Reference - A guide to Meshery's CLI: mesheryctl
• Error Code Reference - Meshery Error Code Reference for all Meshery components so that you can troubleshoot issues.
• GraphQL API Reference - Meshery GraphQL API Documentation and Reference
• Meshery Operator CRD Reference - Details for the Custom Resource Definitions included in Meshery Operator and used by it's custom controllers.
• Permission Keys Reference - List of default permissions.
• Reference - References for using Meshery's various features and components.
• REST API Reference - Meshery REST API Documentation and Reference

Extensibility

• Ensuring Extension Compatibility with Meshery - A guide for Meshery extension developers on maintaining compatibility with the Meshery platform, covering shared frameworks, dependencies, and build tooling.
• Extensibility - Meshery has an extensible architecture with several different types of extension points.
• 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: Build-time - System integrators can supply build-time configuration, data, packages, and other extensions to Meshery's container image.
• 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.

Follow on X or subscribe to our newsletter for the latest updates. Get support on our forum. Join our Slack to interact directly with other users and contributors.