meshery / meshery-adapter-template

Template Repository for creating Meshery Adapters

Meshery Adapter for

Meshery

Meshery is the multi-service mesh management plane offering lifecycle management of more types of service meshes than any other tool available today. Meshery facilitates adopting, configuring, operating and managing performance of different service meshes and incorporates the collection and display of metrics from applications running on top of any service mesh.

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

Community and Contributing

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! Contributors are expected to adhere to the CNCF Code of Conduct.

✔️ Join weekly community meeting on Fridays from 10am - 11am Central.
✔️ Watch community meeting recordings.
✔️ To Access Community Drive, fill the Community Member Form.
✔️ Discuss in the Community Forum.

Not sure where to start? Grab an open issue with the help-wanted label.

About Layer5

Layer5's cloud native application and infrastructure management software enables organizations to expect more from their infrastructure. We embrace developer-defined infrastructure. We empower engineer to change how they write applications, support operators in rethinking how they run modern infrastructure and enable product owners to regain full control over their product portfolio.

License

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

meshery-adapter-template's Issues

[chore] update Go to 1.21, and update relevant pkgs

Desired Behaviour

Need to update Go to 1.21 in go.mod and in Dockerfile, and also Makefile

• Minor chore on updating meshkit and meshery-adapter-library

[CI] Update Slack.yml and add newcomer-alert workflow

Current Behavior
Currently the slack.yml is outdated. Also there is no automated way of notifying the slack channel when a "good first issue" has been created.

Desired Behavior
Update slack.yml and add newcomer-alert.yml to the Github workflow.

---

Resources
Add the updated slack.yml file and the newcomer-alert.yml file to the .github/workflow folder.

Files needed:
https://github.com/meshery/meshery-istio/blob/master/.github/workflows/slack.yml
https://github.com/layer5io/layer5/blob/master/.github/workflows/newcomers-alert.yml

Add GitHub issue templates to this repo

As used in the main "Meshery" repo, please add these GitHub issue templates to this "Meshery-adapter-template" repo:

• question
• bug
• documentation
• feature

[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]

Dependabot can't parse your go.mod

Dependabot couldn't parse the go.mod found at /go.mod.

The error Dependabot encountered was:

go: errors parsing go.mod:
/go.mod:3: usage: go 1.23

View the update logs.

[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:

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

Update README with new Meshery logo

Description
A Meshery logo is available. The old version of the logo used in the README should be displaced.

Expected Behavior
New Meshery logo should displace old logo with:

<a href="https://layer5.io/meshery"><img align="left" src="https://raw.githubusercontent.com/layer5io/meshery/master/ui/static/img/meshery-logo/meshery-logo-light-text.png"  width="25%" /></a>

Dependabot can't resolve your Go dependency files

Dependabot can't resolve your Go dependency files.

As a result, Dependabot couldn't update your dependencies.

The error Dependabot encountered was:

go: github.com/kumarabd/[email protected]: reading github.com/kumarabd/gokit/go.mod at revision v0.2.0: unknown revision v0.2.0

If you think the above is an error on Dependabot's side please don't hesitate to get in touch - we'll do whatever we can to fix it.

View the update logs.

Dependabot can't resolve your Go dependency files

Dependabot can't resolve your Go dependency files.

As a result, Dependabot couldn't update your dependencies.

The error Dependabot encountered was:

github.com/layer5io/meshery-adapter-template/adaptor: cannot find module providing package github.com/layer5io/meshery-adapter-template/adaptor
github.com/layer5io/meshery-adapter-template imports
	github.com/layer5io/meshery-adapter-template/api/grpc: cannot find module providing package github.com/layer5io/meshery-adapter-template/api/grpc
github.com/layer5io/meshery-adapter-template imports
	github.com/layer5io/meshery-adapter-template/internal/config: cannot find module providing package github.com/layer5io/meshery-adapter-template/internal/config
github.com/layer5io/meshery-adapter-template imports
	github.com/layer5io/meshery-adapter-template/internal/tracing: cannot find module providing package github.com/layer5io/meshery-adapter-template/internal/tracing

If you think the above is an error on Dependabot's side please don't hesitate to get in touch - we'll do whatever we can to fix it.

View the update logs.

Replace the Logo of Layer5 with Meshery in config.yml workflow

Description

Currently, we are using the Logo of Layer5 instead of Meshery. This repository is under the organization Meshery, so, there should be the image of Meshery.

How to resolve this?

• Go to .github and replace this welcome image with the new one:

• Make sure to display the images conditionally, based on the theme selected by user.
  Here's the sample code:

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/GiorgosXou/Random-stuff/main/Programming/StackOverflow/Answers/70200610_11465149/w.png">
  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/GiorgosXou/Random-stuff/main/Programming/StackOverflow/Answers/70200610_11465149/b.png">
  <img alt="Meshery Logo" src="">
</picture>

New images are:

• Download these images, and upload with an appropriate name. Make sure to use conditional rendering as described above.

• After uploading the image, and removing the previous image, go to .github/config.yml folder and update the reference to previous image to the new image in the following part:

firstPRMergeComment: >
  Thanks for your contribution to the Layer5 and Meshery community! :tada:
   
  ![Congrats!](https://raw.githubusercontent.com/meshery/meshery.io/master/.github/welcome/Layer5-celebration.png)
    	   	    	    	 :star: Please leave a [star on the project](../stargazers). :smile:

Here, replace ![Congrats!](https://raw.githubusercontent.com/meshery/meshery.io/master/.github/welcome/Layer5-celebration.png) with the code

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/GiorgosXou/Random-stuff/main/Programming/StackOverflow/Answers/70200610_11465149/w.png">
  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/GiorgosXou/Random-stuff/main/Programming/StackOverflow/Answers/70200610_11465149/b.png">
  <img alt="Shows a black logo in light color mode and a white one in dark color mode." src="https://user-images.githubusercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png">
</picture>

make sure to change the image sources with the path to image in the folder where you upload it.

• That's it.

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

Broken image link in Readme

Description
There's a broken link to to first image in this repo's readme.

Add appropriate project badges to this repo's README

Each of the Meshery repos include a set of project badges.

Please add the applicable set of badges to this repo's readme.

Example badges from main meshery repo:

[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 few badges like, Slack, Go report card, Build Status, need to fix that.

Note:
Badges (mentioned above) must recognize the case for this repo. only.

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]

Add GitHub Actions ci.yml workflow to this template repo

Please copy the GitHub action workflow from the meshery repo to this new adapter template repo.

Refactoring of the adapter template

Enhancement Description
To benefit from the practices of microservices kits like gokit.

// @kumarabd

Add Release Drafter for the repository

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

Related Challenges
Add ReleaseDrafter configuration yaml file & GitHub Action.

---

Additional context
Rlease Drafter configuration file
Release Drafter GitHub action