Quick Start with Kubernetes 
Manage your kubernetes clusters with Meshery. Deploy Meshery in kubernetes in-cluster or outside of kubernetes out-of-cluster. Note: It is advisable to Install Meshery in your kubernetes clusters
Prerequisites
- Install the Meshery command line client, mesheryctl.
- Install kubectl on your local machine.
- Access to an active kubernetes cluster.
Available Deployment Methods
In-cluster Installation
Follow the steps below to install Meshery in your kubernetes cluster.
Preflight Checks
Read through the following considerations prior to deploying Meshery on kubernetes.
Preflight: Cluster Connectivity
Verify your kubeconfig’s current context is set the kubernetes cluster you want to deploy Meshery.
kubectl config current-context
Installation: Using mesheryctl
Once configured, execute the following command to start Meshery.
Before executing the below command, go to ~/.meshery/config.yaml and ensure that current platform is set to kubernetes.
$ mesheryctl system start
Installation: Using Helm
For detailed instructions on installing Meshery using Helm V3, please refer to the Helm Installation guide.
Post-Installation Steps
Optionally, you can verify the health of your Meshery deployment, using mesheryctl system check.
You’re ready to use Meshery! Open your browser and navigate to the Meshery UI.
Accessing Meshery UI
After successfully deploying Meshery, you can access Meshery’s web-based user interface. Your default browser will be automatically opened and directed to Meshery UI (default location is http://localhost:9081).
You can use the following command to open Meshery UI in your default browser:
$ mesheryctl system dashboard
If you have installed Meshery on Kubernetes or a remote host, you can access Meshery UI by exposing it as a Kubernetes service or by port forwarding to Meshery UI.
$ mesheryctl system dashboard --port-forward
Depending upon how you have networking configured in Kubernetes, alternatively, you can use kubectl to port forward to Meshery UI.
$ kubectl port-forward svc/meshery 9081:9081 --namespace meshery
Verify Kubernetes Connection
After installing Meshery, regardless of the installation type, it is important to verify that your kubeconfig file has been uploaded correctly via the UI.
- In the Meshery UI, navigate to Lifecycle from the menu on the left.
- Click on Connections.
- Ensure that your cluster appears in the list of connections and is marked as
Connected. - Click on the cluster name to perform a ping test and confirm that Meshery can communicate with your cluster.
Customizing Your Meshery Provider Callback URL
Meshery Server supports customizing your Meshery Provider authentication flow callback URL. This is helpful when deploying Meshery behind multiple layers of networking infrastructure.
For production deployments, it is recommended to access the Meshery UI by setting up a reverse proxy or using a LoadBalancer. By specifying a custom redirect endpoint, you can ensure that authentication flows complete successfully, even when multiple routing layers are involved.
Note: For production deployments, it is important to preselect the choice of Remote Provider in order to control which identity providers authorized. Learn more about this in the Extensibility: Providers guide.
Define a custom callback URL by setting up the MESHERY_SERVER_CALLBACK_URL environment variable before installing Meshery.
To customize the authentication flow callback URL, use the following command:
$ MESHERY_SERVER_CALLBACK_URL=https://custom-host mesheryctl system start
Meshery should now be running in your Kubernetes cluster and the Meshery UI should be accessible at the EXTERNAL IP of the meshery service.
Out-of-cluster Installation
Install Meshery on Docker (out-of-cluster) and connect it to your Kubernetes cluster.
Set up Ingress on Minikube with the NGINX Ingress Controller
- Run the below command to enable the NGINX Ingress controller for your cluster:
minikube addons enable ingress
- To check if NGINX Ingress controller is running
kubectl get pods -n ingress-nginx
## Installing cert-manager with kubectl
- Run the below command to install cert-manager for your cluster:
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.15.3/cert-manager.yaml
Recent Discussions with "meshery" Tag
- Nov 20 | Meshery Development Meeting | Nov 20th 2024
- Nov 10 | Error in "make server" and "make ui-server"
- Nov 11 | Difference in dev Environments on port 9081 and 3000
- Nov 10 | npm run lint:fix error
- Oct 30 | Getting Meshery locally using Docker Desktop for Meshery UI contribution
- Nov 07 | Meshery + GCP Connector
- Oct 24 | Getting error when using utils.SetupContextEnv() when writing tests for relationship command
- Nov 16 | Where's the Cortex Integration of Meshmap?
- Oct 09 | I created an environment but it cannot be listed
- Oct 14 | Explore Meshery's Published Relationship Design Examples
Suggested Reading
- AKS - Manage your AKS clusters with Meshery. Deploy Meshery in AKS in-cluster or out-of-cluster.
- Codespaces - Build and contribute to Meshery using GitHub Codespaces
- EKS - Install Meshery on Elastic Kubernetes Service. Deploy Meshery in EKS in-cluster or outside of EKS out-of-cluster.
- GKE - Install Meshery on Google Kubernetes Engine. Deploy Meshery in GKE in-cluster or outside of GKE out-of-cluster.
- Helm - Install Meshery on Kubernetes using Helm. Deploy Meshery in Kubernetes in-cluster.
- KinD - Install Meshery on KinD. Deploy Meshery in KinD in-cluster or outside of KinD out-of-cluster.
- KubeSphere - Install Meshery on KubeSphere
- Minikube - Install Meshery on Minikube. Deploy Meshery in Minikube in-cluster or outside of Minikube out-of-cluster.