mesh-manager

README

Mesh Manager

Mesh Manager is Kubernetes Operator for managing microservices at scale. One of the main problems that any system faces with scale is managing microservices and ensuring that the system runs properly. Mesh Manager aims to address this issue.

Features

• Enforcing strictly specifying dependencies
• Prevention of missing dependency issues

How to Use

Prerequisites

The following tools are expected to be installed and ready.

• Kubectl
• Operator SDK

The following tools can be either installed on your own or let the installation scripts handle it.

• OLM to be installed in the cluster OLM can be installed using the operator-sdk

  operator-sdk olm install
  

How to Setup Operator

Quickstart

Run the following command to apply the controller to your cluster. The <VERSION> should be replaced with the release version to be used (eg:- 0.1.0) and kubectl CLI should be configured pointing to the cluster in which the controller needs to be started.

curl -L https://raw.githubusercontent.com/nadundesilva/mesh-manager/main/installers/install.sh | bash -s <VERSION>

Manual Installation

• Make sure all the pre-requisites are installed (including the dependencies which are normally installed by the installation scripts)
• Install the Operator Bundle using the Operator SDK. The <VERSION> should be replaced with the release version to be used (eg:- 0.1.0) and kubectl CLI should be configured pointing to the cluster in which the controller needs to be started.

  operator-sdk run bundle docker.io/nadunrds/mesh-manager-bundle:<VERSION>
  

Examples

Examples for the CRDs used by the Operator can be found in the samples directory.

How to Cleanup Operator

Quick Remove

Run the following command to remove the controller from your cluster. Kubectl CLI should be configured pointing to the cluster in which the controller needs to be started.

curl -L https://raw.githubusercontent.com/nadundesilva/mesh-manager/main/installers/uninstall.sh | bash -s

Manual Removal

Remove the controller from your cluster by running the following command.

operator-sdk cleanup mesh-manager

Support

❔ If you need support or have a question about the Mesh Manager, reach out through Discussions.

🐛 If you have found a bug and would like to get it fixed, try opening a Bug Report.

💡 If you have a new idea or want to get a new feature or improvement added to the Mesh Manager, try creating a Feature Request.

Development

The development guide can be found here. Contributions are welcome.