-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updated aks.md and added helm.md #9141
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,70 +8,75 @@ language: en | |
list: include | ||
image: /assets/img/platforms/aks.svg | ||
--- | ||
Use Meshery to manage your AKS clusters. Deploy Meshery on AKS or outside of AKS. | ||
<h1>Quick Start with {{ page.title }} <img src="{{ page.image }}" style="width:35px;height:35px;" /></h1> | ||
|
||
{% include installation_prerequisites.html %} | ||
Manage your AKS clusters with Meshery. Deploy Meshery in AKS [in-cluster](#in-cluster-installation) or outside of AKS [out-of-cluster](#out-of-cluster-installation). **_Note: It is advisable to [Install Meshery in your AKS clusters](#install-meshery-into-your-aks-cluster)_** | ||
|
||
#### Prequisites: | ||
1. Access to an active AKS cluster in one of your resource groups. | ||
2. Azure CLI `az` installed on your machine. | ||
<div class="prereqs"><p><strong style="font-size: 20px;">Prerequisites</strong> </p> | ||
<ol> | ||
<li>Install the Meshery command line client, <a href="{{ site.baseurl }}/installation/mesheryctl" class="meshery-light">mesheryctl</a>.</li> | ||
<li>Install <a href="https://kubernetes.io/docs/tasks/tools/">kubectl</a> on your local machine.</li> | ||
<li>Install <a href="https://learn.microsoft.com/en-us/cli/azure/install-azure-cli">Azure CLI</a>, configured for your environment.</li> | ||
<li>Access to an active AKS cluster in one of your resource groups.</li> | ||
</ol> | ||
</div> | ||
|
||
## Manage AKS clusters with Meshery | ||
Also see: [Install Meshery on Kubernetes]({{ site.baseurl }}/installation/platforms/kubernetes) | ||
|
||
- [Connect Meshery to your AKS cluster](#automatically-connect-meshery-to-azure-kubernetes-cluster) | ||
## Available Deployment Methods | ||
|
||
### Automatically connect Meshery to your Azure Kubernetes Cluster | ||
- [In-cluster Installation](#in-cluster-installation) | ||
- [Preflight Checks](#preflight-checks) | ||
- [Preflight: Cluster Connectivity](#preflight-cluster-connectivity) | ||
- [Preflight: Plan your access to Meshery UI](#preflight-plan-your-access-to-meshery-ui) | ||
- [Installation: Using `mesheryctl`](#installation-using-mesheryctl) | ||
- [Installation: Using Helm](#installation-using-helm) | ||
- [Post-Installation Steps](#post-installation-steps) | ||
- [Access Meshery UI](#access-meshery-ui) | ||
|
||
Use Meshery's CLI to automatically prepare your connection to your AKS cluster. Configure Meshery to connect to your AKS cluster by executing: | ||
# In-cluster Installation | ||
|
||
{% capture code_content %}mesheryctl system config aks{% endcapture %} | ||
{% include code.html code=code_content %} | ||
|
||
### [Optionally] Manually connect Meshery to your Azure Kubernetes Cluster | ||
Follow the steps below to install Meshery in your AKS cluster. | ||
|
||
Alternatively, you may execute the following steps to manually configure Meshery to connect to your AKS cluster. | ||
### Preflight Checks | ||
|
||
1. Install [Azure CLI(az)](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli), and login | ||
to your azure account using _az login_. | ||
Read through the following considerations prior to deploying Meshery on AKS. | ||
|
||
2. After successfull login, identify the subscription with which your AKS is associated. | ||
### Preflight: Cluster Connectivity | ||
|
||
1. Verfiy you connection to an Azure Kubernetes Services Cluster using Azure CLI. | ||
1. Login to Azure account using [az login](https://learn.microsoft.com/en-us/cli/azure/authenticate-azure-cli). | ||
1. After a successful login, identify the subscription associated with your AKS cluster: | ||
{% capture code_content %}az account set --subscription [SUBSCRIPTION_ID]{% endcapture %} | ||
{% include code.html code=code_content %} | ||
<br /> | ||
|
||
3. Get the `kubeconfig` from your AKS cluster | ||
|
||
1. After setting the subscription, set the cluster context. | ||
{% capture code_content %}az aks get-credentials --resource-group [RESOURCE_GROUP] --name [AKS_SERVICE_NAME]{% endcapture %} | ||
{% include code.html code=code_content %} | ||
<br /> | ||
|
||
4. Set your cluster context and check your cluster-info | ||
{% capture code_content %}kubectl config set-context AKS_SERVICE_NAME | ||
kubectl cluster-info{% endcapture %} | ||
{% include code.html code=code_content %} | ||
### Installation: Using `mesheryctl` | ||
|
||
## Install Meshery on your AKS cluster | ||
Use Meshery's CLI to streamline your connection to your AKS cluster. Configure Meshery to connect to your AKS cluster by executing: | ||
|
||
{% capture code_content %}helm repo add meshery https://meshery.io/charts/ | ||
helm install meshery meshery/meshery --namespace meshery --create-namespace{% endcapture %} | ||
{% capture code_content %}$ mesheryctl system config aks{% endcapture %} | ||
{% include code.html code=code_content %} | ||
<br /> | ||
|
||
Optionally, Meshery Server supports customizing callback URL for your remote provider, like so: | ||
Once configured, execute the following command to start Meshery. | ||
|
||
{% capture code_content %}helm install meshery meshery/meshery --namespace meshery --set env.MESHERY_SERVER_CALLBACK_URL=https://custom-host --create-namespace{% endcapture %} | ||
{% capture code_content %}$ mesheryctl system start{% endcapture %} | ||
{% include code.html code=code_content %} | ||
|
||
If you encounter any authentication issues, you can use `mesheryctl system login`. For more information, click [here](/guides/mesheryctl/authenticate-with-meshery-via-cli) to learn more. | ||
|
||
### Installation: Using Helm | ||
|
||
For detailed instructions on installing Meshery using Helm V3, please refer to the [Helm Installation](/installation/helm) guide. | ||
|
||
# Post-Installation Steps | ||
|
||
### Access Meshery UI | ||
|
||
Access Meshery UI by exposing it as a Kubernetes service or by port forwarding to Meshery UI. | ||
To access Meshery's UI, please refer to the [instruction](/reference/mesheryctl/system/dashboard) for detailed guidance. | ||
|
||
#### [Optional] Port Forward to Meshery UI | ||
Note: _You can also verify health of your system using [mesheryctl system check](/reference/mesheryctl/system/check)_ | ||
|
||
{% capture code_content %}export POD_NAME=$(kubectl get pods --namespace meshery -l "app.kubernetes.io/name=meshery,app.kubernetes.io/instance=meshery" -o jsonpath="{.items[0].metadata.name}") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Where else is this information being captured? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm copying and capturing in the central Kubernetes install page. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We might want to delete, though, once the dust has settled. |
||
kubectl --namespace meshery port-forward $POD_NAME 9081:8080{% endcapture %} | ||
{% include code.html code=code_content %} | ||
<br /> | ||
|
||
Meshery should now be running in your AKS cluster and the Meshery UI should be accessible at the specified endpoint you've exposed to. Navigate to the `meshery` service endpoint to log into Meshery. |
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good work getting a page going specifically for Helm. 👍 |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,33 @@ | ||||||
--- | ||||||
layout: default | ||||||
title: Helm Installation | ||||||
permalink: installation/helm | ||||||
type: installation | ||||||
display-title: "true" | ||||||
language: en | ||||||
list: exclude | ||||||
--- | ||||||
|
||||||
<div class="prereqs"><p><strong style="font-size: 20px;">Prerequisites</strong> </p> | ||||||
<ol> | ||||||
<li><a href="https://helm.sh/docs/intro/install/" class="meshery-light">Helm</a> should be installed on your local machine.</li> | ||||||
<li>You should have access to the cluster/platform where you want to deploy Meshery.</li> | ||||||
<li>Ensure that the kubeconfig file has the correct current context/cluster configuration.</li> | ||||||
</ol> | ||||||
</div> | ||||||
|
||||||
## Install Meshery on Your Kubernetes Cluster Using Helm V3 | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
{% capture code_content %}helm repo add meshery https://meshery.io/charts/ | ||||||
helm install meshery meshery/meshery --namespace meshery --create-namespace{% endcapture %} | ||||||
{% include code.html code=code_content %} | ||||||
<br /> | ||||||
|
||||||
Optionally, Meshery Server supports customizing the callback URL for your remote provider, like so: | ||||||
|
||||||
{% capture code_content %}helm install meshery meshery/meshery --namespace meshery --set env.MESHERY_SERVER_CALLBACK_URL=https://custom-host --create-namespace{% endcapture %} | ||||||
{% include code.html code=code_content %} | ||||||
|
||||||
### Accessing Meshery UI for Clusters | ||||||
|
||||||
To access Meshery's UI , please refer to the [accessing-ui](/tasks/accessing-meshery-ui) guide for detailed instructions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@aboobakersiddiqr63 typo *Verify
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@abhijeetgauravm Thanks for pointing out fixed the issue in the latest commit