Merge pull request #3183 from btat/aks

Add install Rancher on AKS
2026-05-16 18:13:17 +00:00 · 2021-05-10 12:55:53 -07:00
parent 0f5b694de5 473d1d6ada
commit e60eb3a2ef
1 changed files with 118 additions and 0 deletions
@@ -0,0 +1,118 @@
+---
+title: Installing Rancher on Azure Kubernetes Service
+shortTitle: AKS
+weight: 4
+---
+
+This page covers how to install Rancher on Microsoft's Azure Kubernetes Servcice (AKS).
+
+The guide uses command line tools to provision an AKS cluster with an ingress. If you prefer to provision your cluster using the Azure portal, refer to the [official documentation](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal).
+
+If you already have an AKS Kubernetes cluster, skip to the step about [installing an ingress.](#5-install-an-ingress) Then install the Rancher Helm chart following the instructions on [this page.]({{<baseurl>}}/rancher/v2.5/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart)
+
+# Prerequisites
+
+>**Note**
+>Deploying to Microsoft Azure will incur charges.
+
+- [Microsoft Azure Account](https://azure.microsoft.com/en-us/free/): A Microsoft Azure Account is required to create resources for deploying Rancher and Kubernetes.
+- [Microsoft Azure Subscription](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription#create-a-subscription-in-the-azure-portal): Use this link to follow a tutorial to create a Microsoft Azure subscription if you don't have one yet.
+- [Micsoroft Azure Tenant](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-create-new-tenant): Use this link and follow instructions to create a Microsoft Azure tenant.
+- Your subscription has sufficient quota for at least 2 vCPUs. For details on Rancher server resource requirements, refer to [this section]({{<baseurl>}}/rancher/v2.5/en/installation/requirements/#rke-and-hosted-kubernetes)
+
+# 1. Prepare your Workstation
+
+Install the following command line tools on your workstation:
+
+- The Azure CLI, **az:** For help, refer to these [installation steps.](https://docs.microsoft.com/en-us/cli/azure/)
+- **kubectl:** For help, refer to these [installation steps.](https://kubernetes.io/docs/tasks/tools/#kubectl)
+- **helm:** For help, refer to these [installation steps.](https://helm.sh/docs/intro/install/)
+
+# 2. Create a Resource Group
+
+After installing the CLI, you will need to log in with your Azure account.
+
+```
+az login
+```
+
+Create a [resource group](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal) to hold all relevant resources for your cluster. Use a location that applies to your use case.
+
+```
+az group create --name rancher-rg --location eastus
+```
+
+# 3. Create the AKS Cluster
+
+To create an AKS cluster, run the following command. Use a VM size that applies to your use case. Refer to [this article](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes) for available sizes and options.
+
+```
+az aks create create \
+  --resource-group rancher-rg
+  --name rancher-server \
+  --kubernetes-version 1.18.14 \
+  --node-count 3 \
+  --node-vm-size Standard_D2_v3
+```
+
+The cluster will take some time to be deployed.
+
+# 4. Get Access Credentials
+
+After the cluster is deployed, get the access credentials.
+
+```
+az aks get-credentials --resource-group rancher-rg --name rancher-server
+```
+
+This command merges your cluster's credentials into the existing kubeconfig and allows `kubectl` to interact with the cluster.
+
+# 5. Install an Ingress
+
+The cluster needs an Ingress so that Rancher can be accessed from outside the cluster.
+
+The following command installs an `nginx-ingress-controller` with a Kubernetes load balancer service.
+
+```
+helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
+helm repo update
+helm upgrade --install \
+  ingress-nginx ingress-nginx/ingress-nginx \
+  --namespace ingress-nginx \
+  --set controller.service.type=LoadBalancer \
+  --version 3.12.0 \
+  --create-namespace
+```
+
+# 6. Get Load Balancer IP
+
+To get the address of the load balancer, run:
+
+```
+kubectl get service ingress-nginx-controller --namespace=ingress-nginx
+```
+
+The result should look similar to the following:
+
+```
+NAME                       TYPE           CLUSTER-IP     EXTERNAL-IP    PORT(S)                     
+ AGE
+ingress-nginx-controller   LoadBalancer   10.0.116.18    40.31.180.83   80:31229/TCP,443:31050/TCP  
+ 67s
+```
+
+Save the `EXTERNAL-IP`.
+
+# 7. Set up DNS
+
+External traffic to the Rancher server will need to be directed at the load balancer you created.
+
+Set up a DNS to point at the `EXTERNAL-IP` that you saved. This DNS will be used as the Rancher server URL.
+
+There are many valid ways to set up the DNS. For help, refer to the [Azure DNS documentation](https://docs.microsoft.com/en-us/azure/dns/)
+
+# 8. Install the Rancher Helm Chart
+
+Next, install the Rancher Helm chart by following the instructions on [this page.]({{<baseurl>}}/rancher/v2.5/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) The Helm instructions are the same for installing Rancher on any Kubernetes distribution.
+
+Use that DNS name from the previous step as the Rancher server URL when you install Rancher. It can be passed in as a Helm option. For example, if the DNS name is `rancher.my.org`, you could run the Helm installation command with the option `--set hostname=rancher.my.org`.