As a self-service engineering platform, Meshery enables collaborative design and operation of cloud and cloud native infrastructure.
Overview & Installation
- 🚀 Quick Start , Overview, and FAQs
- Accessing Meshery UI - Accessing Meshery's web-based user interface
- Advanced Configuration - Advanced installation and runtime configuration topics for Meshery.
- Install on Docker - Install Meshery on Docker
- Install on Kubernetes - Install Meshery on Kubernetes. Deploy Meshery in Kubernetes in-cluster or outside of Kubernetes out-of-cluster.
- Install using mesheryctl - Use Meshery CLI to install Meshery on supported platforms.
- Installation
- Overview - Meshery is the self-service engineering platform, enabling collaborative design and operation of cloud and cloud native infrastructure.
- Production Deployment - Considerations, best practices, security hardening, performance bounds, and operational readiness guidance for deploying Meshery in production.
- Upgrading - How to upgrade Meshery and each of its components
- Using Meshery Playground - An alternative to installing Meshery
Concepts
- 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.
- Organizations - Organizations are the unit of tenancy in Meshery — they group users together and own all of the resources those users create.
- 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.
- Adapters - Adapters extend Meshery's management capabilities in any number of ways, including lifecycle, configuration, performance, governance, identity...
- 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
- 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.
- 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.
- 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
- 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.
- Overview - Meshery provides the ability to manage infrastructure for agility, maintainability, diversity, reliability and isolation, security, and speed.
- Registering a Connection - Use the Connection Wizard to create and update Connections - Kubernetes clusters, Grafana, Prometheus, and more - in your Meshery deployment.
- 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 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 view Prometheus and Grafana metrics in Meshery
- Cloud Native Design Patterns - Meshery applies DRY principle when managing the configuration of cloud native infrastructure.
- 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 using the built-in Design Configurator in Meshery UI or the mesheryctl CLI.
- 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 and Exporting Designs - Manage and transfer Meshery designs seamlessly through import and export using CLI and 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.
- 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 Meshery Installations - Troubleshoot Meshery installation and deployment
Integrations & Extensions
- Academies - Transform Meshery into an integrated learning platform.
- Adapters - Meshery architecture is extensible. Meshery provides several extension points for working with different cloud native infrastructure via adapters, load generators and providers.
- Extensions - Meshery architecture is extensible. Meshery provides several extension points for working with different cloud native infrastructure via adapters, load generators and providers.
- Models - Meshery architecture is extensible. Meshery provides several extension points for working with different cloud native projects via adapters, load generators and providers
- See all 391 models
Contributing & Community
- Community - Meshery's open source, cloud native community
- Contributing - How to contribute to the Meshery project and any of its components.
- Project
- Releases - List of released Meshery versions and their release notes.
- Security Vulnerabilities - How the Meshery team handles security vulnerabilities.
- 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 - How to contribute to the Meshery CLI and its commands.
- 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 Models - How to contribute to the Meshery models and their components.
- 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 the Meshery UI and its components.
- Contributing to Meshery using git - How to contribute to Meshery using git
- How to write MeshKit compatible errors - How to declare errors in Meshery components.
- HTTP Error Response Contract - How Meshery Server responds to error conditions over HTTP, and how clients should parse those responses.
- Meshery Documentation Structure and Organization - Audience, high-Level outline & information architecture for Meshery Documentation
- Setting up Meshery Development Environment on Windows - How to set up Meshery Development Environment on Windows
Extensibility & Reference
- Command Line Reference - A guide to Meshery's CLI: mesheryctl
- Error Codes - 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 CRDs - Details of the Custom Resource Definitions included in Meshery Operator and used by its custom controllers.
- Permission Keys - List of default permissions.
- REST API - Meshery REST API documentation
- Ensuring Extension Compatibility - A guide for Meshery extension developers on maintaining compatibility with the Meshery platform, covering shared frameworks, dependencies, and build tooling.
- 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: Schemas - Meshery schemas support x-* vendor extensions as an intentional extensibility mechanism for remote providers to attach provider-specific metadata.
- 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.