Quick Start with EKS

Manage your EKS clusters with Meshery. Deploy Meshery inside your EKS cluster (in-cluster) or outside of it (out-of-cluster). Note: We recommend installing Meshery in your EKS clusters.

Prerequisites

Install the Meshery command line client, mesheryctl.
Install kubectl on your local machine.
Install AWS CLI, configured for your environment.
Access to an active EKS cluster in an AWS account.

Also see: Install Meshery on Kubernetes

Available Deployment Methods

In-cluster Installation

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

Prerequisites: Cluster Connectivity

Use the AWS CLI to connect kubectl to your Elastic Kubernetes Service (EKS) cluster.

Sign in to your AWS account with aws configure. If you authenticate to AWS another way, see the AWS documentation.
Add the cluster to your kubeconfig and make it your current context:

	
		aws eks update-kubeconfig --name [YOUR_CLUSTER_NAME] --region [YOUR_REGION]

3. Optional: If you use eksctl, follow the AWS documentation. 4. Verify your kubeconfig’s current context:

	
		kubectl config current-context

Installation: Using `mesheryctl`

Run mesheryctl system start to deploy Meshery to your EKS cluster:

	
		mesheryctl system start -p kubernetes

Installation: Using Helm

To install Meshery with Helm 3, see the Helm Installation guide.

Post-Installation Steps

Optionally, verify the health of your Meshery deployment with mesheryctl system check.

You’re ready to use Meshery. Open Meshery UI in your browser.

Accessing Meshery UI

Once Meshery is running, mesheryctl system start opens Meshery UI in your default browser. On Docker, Meshery UI listens at http://localhost:9081 by default. On Kubernetes, mesheryctl opens the address of the meshery service in the meshery namespace, which the Helm chart creates as a LoadBalancer service on port 9081.

To open Meshery UI in your default browser at any time, run:


mesheryctl system dashboard

If your cluster does not give the meshery service a reachable address, forward a local port to Meshery instead. By default, mesheryctl listens on local port 9081; use -p to choose another port.


mesheryctl system dashboard --port-forward

You can also port-forward with kubectl:


kubectl port-forward svc/meshery 9081:9081 --namespace meshery

Verify Kubernetes Connection

Whichever way you installed Meshery, verify that Meshery is connected to your cluster:

In the Meshery UI, navigate to Lifecycle from the menu on the left.
Select Connections.
Ensure that your cluster appears in the list of connections and is marked as Connected.
Click the cluster name to run a connectivity test and confirm that Meshery can reach your cluster.

Customizing Your Meshery Provider Callback URL

You can customize the callback URL that your Meshery Provider redirects to after sign-in. This helps when Meshery runs behind several layers of networking infrastructure.

For production deployments, we recommend that you expose Meshery UI through a reverse proxy or a load balancer. A custom callback URL makes sure that sign-in completes even when requests pass through several routing layers.

Note: For production deployments, use a Remote Provider so that you control which identity providers can sign users in. Learn more about this in the Extensibility: Providers guide.

To set a custom callback URL, set the MESHERY_SERVER_CALLBACK_URL environment variable when you start Meshery:


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

On Kubernetes, Meshery UI is then available at the EXTERNAL-IP of the meshery service. Run kubectl get svc meshery -n meshery to find it.

Out-of-cluster Installation

Out-of-cluster EKS deployments not currently supported

Out-of-cluster support for EKS is still beta and on the roadmap.

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

Install Meshery on Docker

	
		mesheryctl system start -p docker

Once Meshery is running, sign in and connect it to your cluster. mesheryctl connection create prompts for the AWS region and cluster name, writes the cluster’s kubeconfig to ~/.meshery/kubeconfig.yaml, and uploads it to Meshery Server. (mesheryctl system config eks is deprecated.)

	
		mesheryctl system login
mesheryctl connection create --type eks

Meshery UI is available on your local machine at http://localhost:9081.

DigitalOcean

GKE