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.
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
Customizing Meshery Provider Callback URL
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.
Production deployments are recommended to access Meshery UI by setting up a reverse proxy or by using a LoadBalancer.
Log into the Provider of your choice.
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 16 | Where's the Cortex Integration of Meshmap?
- Oct 24 | Getting error when using utils.SetupContextEnv() when writing tests for relationship command
- Oct 09 | I created an environment but it cannot be listed
- Oct 14 | Explore Meshery's Published Relationship Design Examples
- Oct 09 | Meshery CLI Maintainer: Matthieu Evrin
- Oct 11 | Fatal: repository 'https://github.com/mitchellh/osext/' not found
- Sep 27 | How to connect sistent to meshery locally?
- Jun 27 | Meshery Build and Release Meeting | June 27th 2024
- Oct 08 | Make ui build issue
- Sep 25 | Problem with ruby installation on Linux
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.