https://github.com/meshery/meshery-adapter-library
Library of common functionality for Meshery Adapters
https://github.com/meshery/meshery-adapter-library
cloud-native cncf design-as-code hacktoberfest infrastructure-as-code integrations kubernetes meshery x-as-code
Last synced: 10 days ago
JSON representation
Library of common functionality for Meshery Adapters
- Host: GitHub
- URL: https://github.com/meshery/meshery-adapter-library
- Owner: meshery
- License: apache-2.0
- Created: 2020-10-05T19:18:06.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-18T00:17:18.000Z (2 months ago)
- Last Synced: 2025-03-31T21:33:16.589Z (about 2 months ago)
- Topics: cloud-native, cncf, design-as-code, hacktoberfest, infrastructure-as-code, integrations, kubernetes, meshery, x-as-code
- Language: Go
- Size: 927 KB
- Stars: 30
- Watchers: 8
- Forks: 35
- Open Issues: 3
-
Metadata Files:
- Readme: .github/readme/images/Layer5-MeshMentors.png
- Contributing: CONTRIBUTING-gitflow.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Meshery Adapter Library
The Meshery Adapter Library provides a common and consistent set of functionality that Meshery adapters use for managing the lifecycle, configuration, operation, and performance of cloud native infrastructure. See [Introducing MeshKit and the Meshery Adapter Library](https://layer5.io/blog/meshery/introducing-meshkit-and-the-meshery-adapter-library) for more.
## Purpose
The main purpose of the meshery-adapter-library is to
* provide a set of interfaces, some with default implementations, to be used and extended by adapters.
* implement common cross cutting concerns like logging, errors, and tracing
* provide a mini framework implementing the gRPC server that allows plugging in the mesh specific configuration and
operations implemented in the adapters.
### Overview and usage
The library consists of interfaces and default implementations for the main and common functionality of an adapter.
It also provides a mini-framework that runs the gRPC adapter service, calling the functions of handlers injected by the
adapter code. This is represented in an UML-ish style in the figure below. The library is used in the Consul adapter,
and others will follow.
### Package dependencies hierarchy
A clear picture of dependencies between packages in a module helps avoid circular dependencies (import cycles),
understand where to put code, design coherent packages etc.
Referring to the figure below, the packages `config` and `meshes` (which contains the adapter service proto definition)
are at the top of the dependency hierarchy and can be used by any other package. Thinking in layers (L), `config`
would be in the top layer, L1, `adapter` in L2, and `config/provider` in L3. Packages can always be imported and used in lower layers.
## Join the Layer5 community!
Our projects are community-built and welcome collaboration. 👍 Be sure to see the Layer5 Community Welcome Guide for a tour of resources available to you and jump into our Slack!
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.
Become a Meshtee today!
Find out more on the Layer5 community.
✔️ Join any or all of the weekly meetings on community calendar.
✔️ Watch community meeting recordings.
✔️ Access the Community Drive by completing a community Member Form.
✔️ Discuss in the Community Forum.
Not sure where to start? Grab an open issue with the help-wanted label.