meshery/meshery-osm

Meshery Adapter for Open Service Mesh

If you’re using Meshery or if you like the project, please ★ this repository to show your support! 🤩

MESHERY IS A CLOUD NATIVE COMPUTING FOUNDATION PROJECT

A self-service engineering platform, Meshery, is the open source, cloud native manager that enables the design and management of all Kubernetes-based infrastructure and applications (multi-cloud). Among other features, As an extensible platform, Meshery offers visual and collaborative GitOps, freeing you from the chains of YAML while managing Kubernetes multi-cluster deployments.

Try Meshery in the Cloud Native Playground (teaser video)

 

Functionality

Cloud Native Lifecycle Management

Meshery manages the provisioning, configuration and operation of your Kubernetes clusters while supporting hundreds of different types of cloud native infrastructure integrations. Meshery also offers a catalog of curated design templates filled with configuration best practices.

Using a GitOps-centric approach, visually and collaboratively design and manage your infrastructure and microservices. Extend Meshery as your self-service engineering platform by taking advantage of its vast set of extensibility features, including gRPC adapters, hot-loadable Reactjs packages and Golang plugins, subscriptions on NATS topics, consumable and extendable API interfaces via REST and GraphQL.

Multi-Cluster Kubernetes, Multi-Cloud, and Cloud Native Configuration Management

Meshery supports 250+ integrations.

Assess your cloud native infrastructure configuration against deployment and operational best practices with Meshery's configuration validator. Manage your workloads with confidence. Check your Kubernetes configuration for anti-patterns and avoid common pitfalls.

Context-Aware Policies For Applications

Leverage built-in relationships to enforce configuration best practices consistently from code to Kubernetes. Enhance development process by building custom rules in Open Policy Agent's Rego query language.

Manage data plane intelligence with WebAssembly filters

Dynamically load and manage your own WebAssembly filters in Envoy-based service meshes.

See Image Hub.

Performance Management

Adhering to Cloud Native Standards

In an effort to produce service mesh agnostic tooling, Meshery uses the Service Mesh Performance specification as a common format to capture and measure your infrastructure's performance against a universal cloud native performance index. As an implementation of Service Mesh Interface (SMI), Meshery participates in advancing cloud native infrastructure adoption through the standardization of APIs.

Standardized Cloud Native Performance Management

Meshery is the cloud native utility for uniformly managing the performance of microservices and the infrastructure that run them. As an implementation of the Service Mesh Performance (SMP), Meshery enables you to measure the value provided by Docker, Kubernetes, or a service mesh in the context of the overhead incurred.

Meshery Architecture

You may deploy Meshery internal to your cluster or external to your cluster.

Learn more about Meshery's architecture.

Get Started with Meshery

Using `mesheryctl`

Meshery runs as a set of containers inside or outside of your Kubernetes clusters.

curl -L https://meshery.io/install | bash -

Use the quick start guide.

See all supported platforms

See the getting started section to quickly deploy Meshery on any of these supported platforms:

Platform	Supported?
Docker	✔️
Docker - Docker App	✔️
Docker - Docker Extension	✔️
Kubernetes	✔️
Kubernetes - AKS	✔️
Kubernetes - Docker Desktop	✔️
Kubernetes - EKS	✔️
Kubernetes - GKE	✔️
Kubernetes - Helm	✔️
Kubernetes - kind	✔️
Kubernetes - Minikube	✔️
Kubernetes - OpenShift	In Progress
Linux	✔️
Mac	✔️
Mac - Homebrew	✔️
Windows	✔️
Scoop	✔️
WSL2	✔️
Raspberry Pi	In Progress

Meshery documentation offers thorough installation guides for your platform of choice.

 

 

Join the Meshery community!

Our projects are community-built and welcome collaboration. 👍 Be sure to see the Contributor Journey Map and Community Handbook for a tour of resources available to you and the Repository Overview for a cursory description of repository by technology and programming language. Jump into community Slack or discussion forum to participate.

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. Connect with a Meshmate today!

Find out more on the Layer5 community.

✔️ Join any or all of the weekly meetings on community calendar.
✔️ Watch community meeting recordings.
✔️ Fill-in a community member form to 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.

 

Contributing

Please do! We're a warm and welcoming community of open source contributors. Please join. All types of contributions are welcome. Be sure to read the Contributor Guides for a tour of resources available to you and how to get started.

 

Stargazers

If you like Meshery, please ★ star this repository to show your support! 🤩

License

This repository and site are available as open-source under the terms of the Apache 2.0 License.

meshery-osm's Issues

Support BookInfo as a sample app

[README] Need to add `Community Forum`

Description

README.md is the first file one should read when starting a new project. Our community launched Discussion forum for help seekers; needs to publish it officially on README.md for convenience.

Screenshots

Current behaviour:

Desired behaviour:

Note:
Need to add only last line for Community Forum

Environment:

• OS: any [e.g. Ubuntu]
• Browser: any [e.g. Chrome, Safari]
• Version: any [e.g. 22]
• Device: any [e.g. laptop, iPhone 8]

---

Reference:

• Take reference to this pull request

unable to create kubeconfig: open /root/.kube/config

Description
Beta version of this adapter is released in Meshery v0.4.2 is reporting:

meshery-osm_1       | time="2020-08-17T04:12:10Z" level=error msg="unable to create kubeconfig: open /root/.kube/config: no such file or directory"

Enviroment:

• OS: MacOS
• Browser: Safari
• running Docker Desktop

Modify naming and messages

Description
Change notification statement and option names

Support locally deployed Kubernetes clusters (Docker Desktop, Minikube)

Enhancement Description
The current deployment of the Learn Layer5 tool within the adapter for OSM assumes a cloud-based deployment by specifying a service type of LoadBalancer.

Related Challenges
Kubernetes deployments that require NodePort needs to be supported as well.

Upgrade to meshkit errors

Enhancement Description
Port meshkit errors to the new error utility function. Instructions covered here, meshery/meshkit#48

[README] Update README Community Section

Description
The Community section in the README says "Access the Community Drive". There is a new procedure of having this automated based on the individual filling in a community member form

Expected Behavior
Update "Access Community Drive" to "To Access Community Drive, fill Community Member Form"

Screenshots

Resources
Refer to the Contributing guide

Enviroment:

• OS: [e.g. Ubuntu]
• Browser: [e.g. Chrome, Safari]
• Version: [e.g. 22]
• Device: [e.g. laptop, iPhone 8]

[Docs] Add OSM adapter to meshery.io

Desired State:
Open Service Mesh adapter should be listed as an alpha status adapter on https://meshery.io

---

Contributor Resources

• Meshery documentation site
• Meshery documentation source
• Instructions for contributing to documentation

[CI] Error check failing

Description
The Error check is failing in OSM adapter builds.

Expected Behavior
This error should not occur - https://github.com/layer5io/meshery-osm/runs/1028245941?check_suite_focus=true

[Sample App] Support OSM Book Buyer App

Enhancement Description
Like other service meshes, Open Service Mesh has a sample application used to demonstrate its functionality.

The Meshery Adapter for OSM should support the project's sample application, Book Buyer: https://github.com/openservicemesh/osm/tree/main/demo

[README] Need to fix Slack badge

Description

README.md is the first file one should read when starting a new project. For attractive look, we added some badges also.
But, there's a Slack badge, need to fix that.

Example Screenshot :-

Current Behavior

Desired Behavior

Environment:

• OS: any [e.g. Ubuntu]
• Browser: any [e.g. Chrome, Safari]
• Version: any [e.g. 22]
• Device: any [e.g. laptop, iPhone 8]

SMI conformance test crashes with a panic

The conformance test task is crashing with the latest release and takes the whole container down.

[CI] Establish Meshery Edge Release Channel (ci.yml)

Current Behavior
See meshery/meshery#1270 for additional details and the meshery/meshery#284 epic.

Desired Behavior
Implement in the same fashion that has been done in layer5io/meshery repo.

Bug: Move the meshery-osm adapter to port 10009

Description

We have used port 10010 for osm and there is no 10009

Expected Behavior

Let's not skip a port number and use 10009 for meshery-osm

[Lifecycle] Adapter fails to delete OSM installation

Description
Deleting OSM installation produces:

exit status 1

[Patterns] adding more properties to `OSMMesh` workloads

Enhancement Description
OSMMesh workloads, which are used for installing OSM, should have more properties.
This would allow users to have more control over configuration when they install the service mesh.

Some Considerations

• Since we're using helm charts for installing OSM, these properties should ideally be extracted from their Values file https://github.com/openservicemesh/osm/blob/main/charts/osm/values.yaml
• We'll need to version these workloads.
• We'll need to figure out how this will keep up with the CLI fallback method.

Add Reminder in the Welcome Bot to Star the Meshery-osm Project

Current Behavior
A welcome bot has been configured to usher in contributors new to this project. However, a reminder to star the project is missing in the message.

Desired Behavior
The config.yml should be updated, you can take a cue from the highlighted line 22

---

[Optional] Alternatives
A brief description of any alternative solutions or features you've considered.

[Optional] Additional context
Add any other context or screenshots about the feature request here.

Golang-jobs & static-check github actions are broken

[CI] Static analysis failing due to istio reference

Description
Static analysis failing due to istio reference - https://github.com/layer5io/meshery-osm/pull/73/checks?check_run_id=2141526807#step:4:21

[CI] Failed static checks

Current Situation
The build process for this adapter has failing static golang checks - https://github.com/meshery/meshery-osm/runs/4352711502?check_suite_focus=true

Desired Situation
No checks should be failing.

Contributor Resources

The meshery.io website uses Jekyll and GitHub Pages. Site content is found under the master branch.

• See the Contributing to Meshery.io Website section of the readme.md and other contributing instructions, too.
• See Meshery site designs in this Figma designfile. Fill-in the Layer5 Community Member Form and join the Layer5 Community Slack for access.

Add pull-request template for the repository

Current State:

There is no PR template and contributor has to manually populate the details

Desired State:

Add pull-request template for the repository

---

Contributor Resources

• Meshery documentation site
• Meshery documentation source
• Instructions for contributing to documentation

Add Release Drafter for the repository

Current Situation
Each of the layer5 repositories needs releaseDrafter automation as had been done in the meshery project which takes care of drafting release notes.

Desired Situation
Add ReleaseDrafter configuration yaml file & GitHub Action.

---

Additional context
Release drafter configuration file
Rlease drafter Github action

[Operations] Custom configuration operation is categorized incorrectly

Description
The operation to apply custom configuration should show under that category, not the Provisioning / Deprovisioning category.

Screenshots

The CI is passing when a stage fails to run

Description
The CI for docker build and push seems to be passing even when some of the stages are not being triggered.

Expected Behavior
Ideally this should result in a failure during these instances.

Screenshots

Adapter Operations are thread unsafe

Description
OSM Adapter operations are thread unsafe at the moment due its usage of meshery-adapter-library viper config provider.

Expected Behavior
Operations should be thread safe. This is achievable by replacing meshery-adapter-library config provider implementation with meshkit config provider implementation which share similar interfaces.

Contributor Resources
Refer Istio Adapter to see how config provider can be replaced

[CI] Patterns: Generate JSON Schema and Definitions for OSM components

Enhancement Description

To generate the workflow of getting the manifest from the OSM using the kubeopenapi-jsonschema to read and generate json schemas from those manifests and then also generating workload definitions from those schemas

A sample workflow is here

---

[Chore] Update issue templates

Current Behavior

Currently, the issue templates only consist of a basic structure.

Desired Behavior

Update the templates to reflect the proper guidelines. Refer: Layer5 Issue templates.

[CI] Add IMAGE_NAME secret to repo for Docker image

[Chore] Improve this adapter's go report score by running gofmt

Current Situation
This adapter currently has a go report card of a "D".

Desired Situation
Get this go report card to an "A" by following the instructions on this page - https://goreportcard.com/report/github.com/layer5io/meshery-osm

[CI] add label commenter workflow

Description
This repository should have the label commenter workflow.
It would run whenever an issue/pr is labelled with one of the targeted labels and comment down any relevant information.

Contributor Reference

The workflow would use: https://github.com/peaceiris/actions-label-commenter

A sample workflow is defined in: https://github.com/meshery/meshery/blob/master/.github/workflows/label-commenter.yml.

It would also need a sample configuration which is defined in: https://github.com/meshery/meshery/blob/master/.github/label-commenter-config.yml

NOTE:

• In the above configuration https://github.com/meshery/meshery/blob/88d1c7c559259775ce2affab2a15a32c673c3f52/.github/label-commenter-config.yml#L26-L41 are specific to Meshery and won't be needed on every repository.
• Do comment in PR if you find any label is missing for the repo.

[feature]: The custom service-mesh configuration checking feature

Enhancement Description
A brief description of the enhancement.

We need the custom service-mesh configuration checking feature for meshery-osm.

Related Challenges
A brief description of what the problem is. (e.g. I need to be able to...)

---

[Optional] Alternatives
A brief description of any alternative solutions or features you've considered.

[Optional] Additional context
Add any other context or screenshots about the feature request here.

[SMI] Adapter crashes on run of SMI Conformance test

Description

[SMI] Add SMI Conformance Tests as a supported operation

Enhancement Description

• OSM will seek to be SMI Conformant.
• The Meshery adapter for OSM should support invocation of this operation (of the SMI Conformance test suite)

Include "Open Service Mesh" menu item in nav bar

[Docs] Update README

Description

Update the README.md file to stay in accordance with the Meshery repo README.

Release incremental version of OSM adapter

Current Situation
The adapter is using a new TCP port. This needs to be released in conjunction with a new Meshery release.

Logo missing in Adapter Chip in Meshery UI

Description
In the last release of this adapter, the icon in the adapter chip has gone missing.

Expected Behavior
Should show an OSM icon.

Screenshots

Environment:

• Meshery Version: v0.5.2

Support OSM Installation using adapter

Enhancement Description

Support OSM Installation using the adapter like it is available for other adapters

---

[CI] Docker build and push failing

Current Situation
Failure - https://github.com/layer5io/meshery-osm/runs/1019846887?check_suite_focus=true

@kushthedude do you mind having a look into this?

[Bug] Incorporate Adapter Version # at buildtime

Description

build-args main.version=$VERSION and main.gitsha=$GIT_COMMITSHA are not being picked up.

Expected Behavior

when testing locally e.g. building using
GOPROXY=direct GOSUMDB=off go build -ldflags="-w -s -X main.version=VERSION -X main.gitsha=GIT_COMMITSHA" -a -o ./meshery-osm .

and running ./meshery-osm

expected result of grpcurl --plaintext 127.0.0.1:10009 meshes.MeshService.ComponentInfo

{
  "type": "adapter",
  "name": "OPEN_SERVICE_MESH",
  "version": "VERSION",
  "gitSha": "GIT_COMMITSHA"
}

Replace meshery-osm adapter to use meshey-kit and meshery-framework as primary dependencies

Enhancement Description
A brief description of the enhancement.

As we discussed we should replace meshery-osm adapter to use meshey-kit and meshery-framework as primary dependencies. So I'm going to work on meshery-osm adapter @kumarabd @leecalcote @mgfeller

Related Challenges
A brief description of what the problem is. (e.g. I need to be able to...)

---

[Optional] Alternatives
A brief description of any alternative solutions or features you've considered.

[Optional] Additional context
Add any other context or screenshots about the feature request here.

Replace logging with logrus

We are using logrus in all of our projects, it would be great to have meshery-osm use logrus for the default logging.

Move to distroless image

Add releasedrafter workflow and configuration files to this repo

Current Situation
The ReleaseDrafter utility (GitHub Action) is not configured in this repository.

Desired Situation

• Releasedrafter should be configured to execute whenever a PR is merged to master in this repo.

Implementation

• Copy the releasedrafter config and the releasedrafter workflow file from the meshery repo and place in the .github folder here.

Update issue labels

Description

Update Issue labels to make it easy to highlight issues with appropriate tags.

[Lifecycle] remove version hardcoding

Enhancement Description
Support multiple versions in the OSM adapter.

Related Challenges

• Currently the OSM adapter only installs OSM v0.6.0. We need to be able to fetch binaries for the latest releases and use the latest OSM.
• Also, when reading binaries from ~/.meshery/bin it expects them to be in the form osm-v0.6.0. This is a side effect of point one but should be kept in mind.

---

Alternatives
Using docker cp $binPath meshery_meshery-osm_1:/root/.meshery/bin/osm-v0.6.0 for tricking the adapater to believe that the current binary is for osm-v0.6.0. Too hacky.

Contributor Resources

The meshery.io website uses Jekyll and GitHub Pages. Site content is found under the master branch.

• See the Contributing to Meshery.io Website section of the readme.md and other contributing instructions, too.
• See Meshery site designs in this Figma designfile. Fill-in the Layer5 Community Member Form and join the Layer5 Community Slack for access.

[CI] add error codes utility runner workflow

Current Behaviour
Error codes utility runner workflow is not present.

Desired Behavious
Add the error codes utility runner workflow.

Instructions in meshery/meshery-linkerd#213

[Chore] Add community guidelines

Current Behavior
Community guidelines, including the contributing guide and the code of conduct is missing.

Desired Behavior
Migrate the contributing guide and the code of conduct from the Layer5 repository.

[Chore] Issue Templates need updated to reference the correct label names

Description
The issue templates in this repo incorrectly reference labels like bug and enhancement.

Expected Behavior
These issue templates should be updated to reference the new label names like kind/bug and kind/enhancement

Link to OSM adapter broken in v0.1.2

Description
The "Opens Service Mesh" menu item is a broken link.

Expected Behavior

1. Show "Open Service Mesh" in the menu item name.
2. Navigate to http://localhost:9081/management?adapter=meshery-osm:10010