Back to Meshery

Codespaces

docs/content/en/installation/codespaces/index.md

1.0.184.3 KB
Original Source

Use Minikube in GitHub Codespaces to setup your development environment for Meshery.

<div class="prereqs"><p><strong style="font-size: 20px;">Prerequisites</strong> </p> <ol> <li>Install the Meshery command line client, <a href="/installation/mesheryctl" class="meshery-light">mesheryctl</a>.</li> </ol> </div>

Available Deployment Methods

In-cluster Installation

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

Preflight Checks

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

Preflight: Cluster Connectivity

You can develop and run Meshery in GitHub Codespaces using your choice of tool:

  • A command shell, via an SSH connection initiated using GitHub CLI.
  • One of the JetBrains IDEs, via the JetBrains Gateway.
  • The Visual Studio Code desktop application.
  • A browser-based version of Visual Studio Code.

{{% alert color="dark" title="Choice of Codespaces Tool" %}}For the best experience, run Codespaces in your locally <a href='https://docs.github.com/en/codespaces/developing-in-codespaces/developing-in-a-codespace'>installed IDE</a>. Alternatively, you can <a href='https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=157554479&machine=premiumLinux'></a>{{% /alert %}}

Start Minikube, if it is not already running, using the following command:

{{< code code="minikube start --cpus 4 --memory 4096" >}}

Please allocate CPUs based on the machine you selected in GitHub Codespaces. To check the status of your Minikube cluster:

{{< code code="minikube status" >}}

Verify your kubeconfig's current context.

{{< code code="kubectl cluster-info" >}}

Installation: Using mesheryctl

Use Meshery's CLI to streamline your connection to your Minikube cluster. Configure Meshery to connect to your Minikube cluster by executing:

{{< code code="mesheryctl system config minikube" >}}

Once configured, execute the following command to start Meshery.

{{< code code="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.

Installation: Manual Steps

You may also manually generate and load the kubeconfig file for Meshery to use:

The following configuration yaml will be used by Meshery. Copy and paste the following in your config file :

{{< code code=`apiVersion: v1 clusters:

  • cluster: certificate-authority-data: < cert shortcutted > server: https://192.168.99.100:8443 name: minikube contexts:
  • context: cluster: minikube user: minikube name: minikube current-context: minikube kind: Config preferences: {} users:
  • name: minikube user: client-certificate-data: < cert shortcutted > client-key-data: < key shortcutted >` >}}

Note: Make sure current-context is set to minikube.

To allow Meshery to auto detect your config file, Run :

{{< code code="kubectl config view --minify --flatten > config_minikube.yaml" >}}

Meshery should now be connected with your managed Kubernetes instance. Take a look at the Meshery guides for advanced usage tips.

Post-Installation Steps

Optionally, you can verify the health of your Meshery deployment using <a href='/reference/mesheryctl/system/check'>mesheryctl system check</a>.

You're ready to use Meshery! Open your browser and navigate to the Meshery UI.

{{< installation/accessing-meshery-ui >}}

For further information to access Meshery UI or port forwarding in GitHub Codespaces, read the docs

{{< related-discussions tag="meshery" >}}