Quick Start with GKE

Manage your GKE clusters with Meshery. Deploy Meshery in GKE in-cluster or outside of GKE out-of-cluster. Note: It is advisable to Install Meshery in your GKE clusters

Prerequisites

Install the Meshery command line client, mesheryctl.
Install kubectl on your local machine.
Install gCloud CLI, configured for your environment.
Access to an active GKE cluster in your Google Cloud project.

Also see: Install Meshery on Kubernetes

Available Deployment Methods

In-cluster Installation

In-cluster Installation

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

Preflight Checks

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

Preflight: Cluster Connectivity

Verfiy you connection to an Google Kubernetes Engine Cluster using gCloud CLI.
Login to GCP account using gcloud auth login.
After a successful login, set the Project Id:


gcloud config set project [PROJECT_ID]

After setting the Project Id, set the cluster context.


gcloud container clusters get-credentials [CLUSTER_NAME] --zone [CLUSTER_ZONE]

Verify your kubeconfig’s current context.


kubectl config current-context

Preflight: Plan your access to Meshery UI

If you are using port-forwarding, please refer to the port-forwarding guide for detailed instructions.
If you are using a LoadBalancer, please refer to the LoadBalancer 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 GKE cluster and Meshery UI should be accessible at the EXTERNAL IP of meshery service.

Installation: Using `mesheryctl`

Use Meshery’s CLI to streamline your connection to your GKE cluster. Configure Meshery to connect to your GKE cluster by executing:


$ mesheryctl system config gke

Once configured, execute the following command to start Meshery.


$ mesheryctl system start

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

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.

Recent Discussions with "meshery" Tag

Oct 24 | Getting error when using utils.SetupContextEnv() when writing tests for relationship command by Sujai Gupta
Oct 30 | Getting Meshery locally using Docker Desktop for Meshery UI contribution by Davidudale
Nov 16 | Where's the Cortex Integration of Meshmap? by Aditya Gupta
Oct 09 | I created an environment but it cannot be listed by Pranjal Gupta
Oct 14 | Explore Meshery's Published Relationship Design Examples by Awani Alero
Oct 09 | Meshery CLI Maintainer: Matthieu Evrin by Vivek Vishal
Oct 11 | Fatal: repository 'https://github.com/mitchellh/osext/' not found by Lawrence Li
Sep 27 | How to connect sistent to meshery locally? by Yash Sharma
Jun 27 | Meshery Build and Release Meeting | June 27th 2024 by Yash Sharma
Oct 08 | Make ui build issue by Yash Sharma