Quick Start with Docker

Prerequisites

1. Install the Meshery command line client, mesheryctl .

Deploying Meshery on Docker

Follow these installation steps to use Docker and Docker Compose to run Meshery. Users often choose this installation approach in order to run Meshery on their local machine. If you need to install docker, see Getting Started with Docker and if you need to install docker-compose, see Installing Docker Compose.

Start Meshery by executing:


mesheryctl system start

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.

Accessing 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

Verify Kubernetes Connection

After installing Meshery, regardless of the installation type, it is important to verify that your kubeconfig file has been uploaded correctly via the UI.

  1. In the Meshery UI, navigate to Lifecycle from the menu on the left.
  2. Click on Connections.
  3. Ensure that your cluster appears in the list of connections and is marked as Connected.
  4. Click on the cluster name to perform a ping test and confirm that Meshery can communicate with your cluster.
Customizing Your Meshery Provider Callback URL

Meshery Server supports customizing your Meshery Provider authentication flow callback URL. This is helpful when deploying Meshery behind multiple layers of networking infrastructure.

For production deployments, it is recommended to access the Meshery UI by setting up a reverse proxy or using a LoadBalancer. By specifying a custom redirect endpoint, you can ensure that authentication flows complete successfully, even when multiple routing layers are involved.

Note: For production deployments, it is important to preselect the choice of Remote Provider in order to control which identity providers authorized. Learn more about this in the Extensibility: Providers guide.

Define a custom callback URL by setting up the MESHERY_SERVER_CALLBACK_URL environment variable before installing Meshery.

To customize the authentication flow callback URL, use the following command: 


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

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

Recent Discussions with "meshery" Tag

Suggested Reading