MeshSync is Meshery's event-driven, continuous discovery and synchronization engine. It ensures that the configuration and operational state of Kubernetes (and any supported Meshery platform) are known to Meshery Server. When deployed into a Kubernetes cluster, MeshSync runs as a custom controller under the control of Meshery Operator and publishes resource changes over Meshery Broker (NATS).
MeshSync runs in one of two output modes: broker (default - publishes Kubernetes resource events to Meshery Broker over NATS) and file (writes deduplicated cluster snapshots to disk, with no NATS or CRD dependency). Run meshsync --help for input parameters.
All MeshSync documentation lives in Meshery Docs - the single source of truth. Please update the docs alongside code changes rather than duplicating details here.
📖 Using & understanding MeshSync - how it works and where it fits in Meshery's architecture:
- MeshSync architecture
- Meshery architecture (logical and component architecture)
🛠️ Contributing to MeshSync - set up a development environment, build, test, and submit changes:
Our projects are community-built and welcome collaboration. 👍 Be sure to see the Contributor Journey Map. Jump into community Slack or discussion forum to participate.
MeshMates are experienced Meshery community members, who will help you learn your way around, discover live projects, and expand your community network. Connect with a MeshMate today!
Learn more about the MeshMates program.
✔️ Join any or all of the weekly meetings on community calendar.
✔️ Watch community meeting recordings.
✔️ Fill-in a member form and 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.
Please do! We're a warm and welcoming community of open source contributors. All types of contributions are welcome. Start with Contributing to MeshSync for a development-environment walkthrough, and see the general Contributor Guides for a tour of the resources available to you and how to get started.
This repository and site are available as open-source under the terms of the Apache 2.0 License.