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 service meshes and their workloads. . See 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 service mesh 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.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package adapter provides the default implementation of an adapter Handler, called by the MeshServiceServer implementation.
|
Package adapter provides the default implementation of an adapter Handler, called by the MeshServiceServer implementation. |
|
api
|
|
|
grpc
Package grpc implements the MeshServiceServer which is the server API for MeshService service.
|
Package grpc implements the MeshServiceServer which is the server API for MeshService service. |
|
Package common contains code and configuration common to all adapters that can either be used directly or as examples.
|
Package common contains code and configuration common to all adapters that can either be used directly or as examples. |
|
Package config provides the interface Handler and errors related to the configuration of adapters.
|
Package config provides the interface Handler and errors related to the configuration of adapters. |
|
provider
Package provider provides config provider implementations that can be used in the adapters, as well as the Options type containing options for various aspects of an adapter.
|
Package provider provides config provider implementations that can be used in the adapters, as well as the Options type containing options for various aspects of an adapter. |
|
Package meshes contains the MeshService ProtoBuf definition.
|
Package meshes contains the MeshService ProtoBuf definition. |
|
Package status contains constants for an operation's status.
|
Package status contains constants for an operation's status. |