Quick Start with KinD

Manage your KinD clusters with Meshery. Deploy Meshery in your KinD cluster.

Prerequisites

  1. Install the Meshery command line client, mesheryctl.
  2. Install kubectl on your local machine.
  3. Install KinD, on your local machine.

Also see: Install Meshery on Kubernetes

Available Deployment Methods

In-cluster Installation

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

Preflight Checks

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

Preflight: Cluster Connectivity

Start the KinD, if not started using the following command:


kind create cluster

Check up on your KinD cluster :


kind get clusters

Verify your kubeconfig’s current context.


kubectl config current-context

Installation: Using mesheryctl

Verify your Meshery context

Verify that your current Meshery context is set for an in-cluster deployment (`platform: kubernetes`) by executing: 


$ mesheryctl system context view

If the context is not set to platform: kubernetes, you can create a new context with Kubernetes as the platform using the following command. 


$ mesheryctl system context create context-name --platform kubernetes --url http://localhost:9081 --set --yes

With your KIND cluster configured your current-context, start Meshery.


$ mesheryctl system start -p kubernetes

Alternative Installation: Using Helm

See Helm Installation guide.

Post-Installation Steps

Meshery deploys with LoadBalancer service type by default. If you are using KinD, you may need to expose the Meshery service. A universal option is to use mesheryctl system dashboard --port-forward. A KIND-specific option to use use the Cloud Provider KIND. Cloud Provider KIND runs as a standalone binary in your host and connects to your KIND cluster and provisions new Load Balancer containers for your Services.

Note: The --port-forward flag is intended for use exclusively when Meshery is deployed in a Kubernetes cluster (platform: kubernetes).

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.

Recent Discussions with "meshery" Tag

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.
  • Kubernetes - Install Meshery on Kubernetes. Deploy Meshery in Kubernetes in-cluster or outside of Kubernetes 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.