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

Available Deployment Methods

Follow the steps below to install Meshery in your kubernetes cluster.

Read through the following considerations prior to deploying Meshery on kubernetes.

Verify your kubeconfig’s current context is set the kubernetes cluster you want to deploy Meshery.


kubectl config current-context

If you are using port-forwarding, please refer to the port-forwarding guide for detailed instructions.
Customize your Meshery Provider Callback URL. Meshery Server supports customizing authentication flow callback URL, which can be configured in the following way:


$ MESHERY_SERVER_CALLBACK_URL=https://custom-host mesheryctl system start

Meshery should now be running in your Kubernetes cluster and Meshery UI should be accessible at the EXTERNAL IP of meshery service.

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

If you encounter any authentication issues, you can use mesheryctl system login. For more information, click here to learn more.

For detailed instructions on installing Meshery using Helm V3, please refer to the Helm Installation guide.

To access Meshery’s UI, please refer to the instruction for detailed guidance.

Install Meshery on Docker (out-of-cluster) and connect it to your Kubernetes cluster.

Run the below command to generate the “config_minikube.yaml” file for your cluster:


 kubectl config view --minify --flatten > config_minikube.yaml

Upload the generated config file by navigating to Settings > Environment > Out of Cluster Deployment in the Web UI and using the “Upload kubeconfig” option.