meshery / meshery-cpx

Meshery adapter for Citrix Service Mesh

Meshery Adapter for CPX

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.
✔️ Fill-in a community member form to gain access to community resources.
✔️ Discuss in the Community Forum.

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

About Layer5

Community First

The Layer5 community represents the largest collection of service mesh projects and their maintainers in the world.

Open Source First

We build projects to provide learning environments, deployment and operational best practices, performance benchmarks, create documentation, share networking opportunities, and more. Our shared commitment to the open source spirit pushes Layer5 projects forward.

License

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

meshery-cpx's Issues

Update go version in github actions workflows to 1.17

Current Behavior

Many of places in the workflows still mention go version 1.16 yet the adapters use go version 1.17

Desired Behavior

Workflows shouls also use go version 1.17

Implementation

Acceptance Tests

Mockups

---

Contributor Guides and Resources

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

[Install] Upgrade to Citrix 1.2.0-beta

Enhancement Description
The current version of the adapter runs Citrix Service Mesh 1.1.0-beta. 1.2.0-beta is currently available.

Create CPX maintainers file

Enhancement Description
Create a MAINTAINERS.md in the root directory that includes:

@dheerajng
@girishranganathan
@leecalcote

The definition of expectations of maintainers is forthcoming soon.

Upgrade to Citrix xDS Adapter v0.10.1

Current Behavior

The current Meshery Adapter for Citrix is running an older version of Citrix ADC with the xDS-API based service mesh.

Desired Behavior

Upgrade to Citrix xDS Adapter v0.10.1

---

Contributor Guides and Resources

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

Cleanup template repo and make CPX adapter buildable

Description
Init adapter

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
ReleaseDrafter Configuration File
ReleaseDrafter GitHub Action

[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

Create Docker Hub repo for Citrix CPX

Description
Create Docker Hub repo for Citrix CPX, which should be located here - https://hub.docker.com/r/layer5/meshery-cpx

Add Docker Hub service account for meshery-cpx repo pushes

Description
Add the service account credentials for pushing meshery-cpx images to its respective Docker Hub repo.

[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

Upgrading Meshery-CPX adapter to install Citrix Service Mesh components

Enhancement Description
Meshery-CPX adapter should be able to install Citrix ADC as Ingress Gateway and automatic sidecar injector webhook

Related Challenges

1. Automatic Sidecar Injector needs a signed certificate from kubeapiserver for proper functioning of the webhook service. It relies on OpenSSL and kubectl binaries to create certificate and CSR, get it approved and generate the secret for webhook service. Meshery-CPX container includes OpenSSL and kubectl binaries.
2. webhook-certificate generation script relies on kubeconfig file which is available in Out of cluster environment. But this kubeconfig file is usually not available in In-Cluster environment. A script is written to generate this kubeconfig file and executed from the Adapter code.

---

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

[CI] Support multi-platform Docker images

Desired Behavior

Meshery users, particularly those running Docker Desktop can benefit from multi-platform images of Meshery Server.

Implementation

Refactor existing stable and edge build and release workflows to use docker-build-push actions. See https://github.com/meshery/meshery/blob/master/.github/workflows/build-and-release-dde.yml as an example.

Be aware of local binaries and their needs:

1. layer5/kubeopenapi-json

Acceptance Tests

1. platform: linux/amd64,linux/arm64 should both be supported.

Mockups

---

Contributor Guides and Resources

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

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-cpx/cpx: cannot find module providing package github.com/layer5io/meshery-cpx/cpx
	github.com/layer5io/meshery-cpx/meshes: cannot find module providing package github.com/layer5io/meshery-cpx/meshes

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.

Missing documentation and question issue template.

[CI] Update Multi Platform build and Release workflow

Current Behavior

Currently, the multiplatform.yml file is sending unwanted build arguments to docker build process because of which release tag and commit_sha are not being passed over to the image and hence the version of meshery adapter are not visible on-hovering adapters chips on Meshery UI Dashboard.

Desired Behavior

This would be fixed when correct build args are passed to the docker build step inside multiplatform workfow.
Required Args:

• VERSION
• GIT_COMMITSHA

Check this commit for reference:
meshery/meshery-consul@446ad17

related to: meshery/meshery#6245

---

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

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-cpx/cpx: cannot find module providing package github.com/layer5io/meshery-cpx/cpx
github.com/layer5io/meshery-cpx imports
	github.com/layer5io/meshery-cpx/meshes: cannot find module providing package github.com/layer5io/meshery-cpx/meshes

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

[App] BookInfo deployment error and Istio-injection label removal

Description
BookInfo fails to install with the latest adapter for CPX with this error message:

Additionally, the act of deploying this sample app removes istio-injection=enabled from the default namespace.

Builds: Static and Error checking of Go code

Enhancement Description
In order to facilitate coding best practices, this adapter's code should have static analysis and error checking run as part of its build process.

Chore Description
Using the meshery-istio adapter's Actions workflow as an example, enable Static and Error checks in this repository's CI.yml workflow.

[README] Need to fix Build & 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 badge like, Slack & Build are failing, need to fix that.

Note:
Build badge recognize 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]

Upgrade meshkit errors

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

[Install] `istio-system` and `citrix-system` namespaces both created on provisioning

Description
Both of these namespaces are created when provisioning the Citrix Service Mesh. This behavior is true whether citrix-system is specified as the namespace in the Meshery UI or whether default is specified.

Are of these necessary? Currently, no pods are provisioned into the citrix-system namespace.

README: Add hyperlinks to badges

Description
Some of the badges in this repos readme are missing informative hyperlinks.

Desired Behavior
The badges (and their links) that are used in the Meshery repo's README are a great example of how the badges in this repo can be improved.

`citrix-system` namespace not deleted on deprovision of Citrix Service Mesh

Description
The citrix-system namespace is left as a residual artifact when deprovisioning Citrix Service Mesh whether the user specifies citrix-system namespace or the default namespace when deprovisioning.

Meshery CPX adapter fails to connect to Meshery

Description
Cannot ping meshery CPX adapter from meshery dashboard

Expected Behavior
Meshery server should be able to communicate with the meshery CPX adapter.

Enviroment:

• OS: Darwin
• Browser: Safari

---

[Optional] To Reproduce
Steps to reproduce the behavior:

1. Start Meshery using mesheryctl system start
2. Visit http://localhost:9081
3. Meshery CPX adapter chip is grayed out

Additional Context
Meshery is running in Docker

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

Update logo in README

Current State:
The Meshery logo used in the README is outdated.

Desired State:
Use the new logo as seen in https://github.com/layer5io/meshery-istio's README.

// @chiradeep @dheerajng