# Kubernetes Virtual Kubelet with ACI Azure Container Instances (ACI) provide a hosted environment for running containers in Azure. When using ACI, there is no need to manage the underlying compute infrastructure, Azure handles this management for you. When running containers in ACI, you are charged by the second for each running container. The Azure Container Instances provider for the Virtual Kubelet configures an ACI instance as a node in any Kubernetes cluster. When using the Virtual Kubelet ACI provider, pods can be scheduled on an ACI instance as if the ACI instance is a standard Kubernetes node. This configuration allows you to take advantage of both the capabilities of Kubernetes and the management value and cost benefit of ACI. This document details configuring the Virtual Kubelet ACI provider. #### Table of Contents * [Feature set](#current-feature-set) * [Prerequiste](#prerequisite) * [Set-up virtual node in AKS](#set-up-virtual-node-in-AKS) * [Quick set-up with the ACI Connector](#quick-set-up-with-the-aci-connector) * [Manual set-up](#manual-set-up) * [Create a cluster with a Virtual Network](#create-an-aks-cluster-with-vnet) * [Validate the Virtual Kubelet ACI provider](#validate-the-virtual-kubelet-aci-provider) * [Schedule a pod in ACI](#schedule-a-pod-in-aci) * [Work arounds](#work-arounds-for-the-aci-connector) * [Upgrade the ACI Connector ](#upgrade-the-aci-connector) * [Remove the Virtual Kubelet](#remove-the-virtual-kubelet) ## Current feature set Virtual Kubelet's ACI provider relies heavily on the feature set that Azure Container Instances provide. Please check the Azure documentation accurate details on region avaliability, pricing and new features. The list here attempts to give an accurate reference for the features we support in ACI and the ACI provider within Virtual Kubelet. *WIP* **Features** * Volumes: empty dir, github repo, Azure Files * Secure env variables, config maps * Bring your own virtual network (VNet) * Deploy to GPU enabled container instances *(documentation in progress)* * Network security group support * Basic Azure Networking support within AKS virtual node * [Exec support](https://docs.microsoft.com/en-us/azure/container-instances/container-instances-exec) for container instances * Azure Monitoring integration or formally known as OMS **Limitations** * Using service principal credentials to pull ACR images * Liveness and readiness probes (WIP) * [Limitations](https://docs.microsoft.com/en-us/azure/container-instances/container-instances-vnet) with VNet * VNet peering * Argument support for exec * [Host aliases](https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/) support ## Prerequisite This guide assumes that you have a Kubernetes cluster up and running (can be `minikube`) and that `kubectl` is already configured to talk to it. Other pre-requesites are: * A [Microsoft Azure account](https://azure.microsoft.com/en-us/free/). * Install the [Azure CLI](#install-the-azure-cli). * Install the [Kubernetes CLI](#install-the-kubernetes-cli). * Install the [Helm CLI](#install-the-helm-cli). ### Install the Azure CLI Install `az` by following the instructions for your operating system. See the [full installation instructions](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest) if yours isn't listed below. #### MacOS ```cli brew install azure-cli ``` #### Windows Download and run the [Azure CLI Installer (MSI)](https://aka.ms/InstallAzureCliWindows). #### Ubuntu 64-bit 1. Add the azure-cli repo to your sources: ```cli echo "deb [arch=amd64] https://packages.microsoft.com/repos/azure-cli/ wheezy main" | \ sudo tee /etc/apt/sources.list.d/azure-cli.list ``` 2. Run the following commands to install the Azure CLI and its dependencies: ```cli sudo apt-key adv --keyserver packages.microsoft.com --recv-keys 52E16F86FEE04B979B07E28DB02C46DF417A0893 sudo apt-get install apt-transport-https sudo apt-get update && sudo apt-get install azure-cli ``` ### Install the Kubernetes CLI Install `kubectl` by running the following command: ```cli az aks install-cli ``` ### Install the Helm CLI [Helm](https://github.com/kubernetes/helm) is a tool for installing pre-configured applications on Kubernetes. Install `helm` by running the following command: #### MacOS ```cli brew install kubernetes-helm ``` #### Windows 1. Download the latest [Helm release](https://storage.googleapis.com/kubernetes-helm/helm-v2.7.2-windows-amd64.tar.gz). 2. Decompress the tar file. 3. Copy **helm.exe** to a directory on your PATH. #### Linux ```cli curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash ``` --- ## Cluster and Azure Account Setup Now that we have all the tools, we will set up your Azure account to work with ACI. ### Configure your Azure account First let's identify your Azure subscription and save it for use later on in the quickstart. 1. Run `az login` and follow the instructions in the command output to authorize `az` to use your account 2. List your Azure subscriptions: ```cli az account list -o table ``` 3. Copy your subscription ID and save it in an environment variable: **Bash** ```cli export AZURE_SUBSCRIPTION_ID="" ``` **PowerShell** ```cli $env:AZURE_SUBSCRIPTION_ID = "" ``` 4. Enable ACI in your subscription: ```cli az provider register -n Microsoft.ContainerInstance ``` ## Set-up virtual node in AKS Azure Kubernetes Service has easy ways of setting up virtual kubelet with the ACI provider with a feature called virtual node. You can easily install a virtual node that will deploy Linux workloads to ACI. The pods that spin out will automatically get private IPs as the experience forces you to pick "advanced networking." To install virtual node in the Azure portal go [here](https://docs.microsoft.com/en-us/azure/aks/virtual-nodes-portal). To install virtual node in the Azure CLI go [here](https://docs.microsoft.com/en-us/azure/aks/virtual-nodes-cli). ## Quick set-up with the ACI Connector The Azure cli can be used to install the ACI provider. We like to say Azure's provider or implementation for Virtual Kubelet is the ACI Connector. Please note that this command has no Virtual Networking support. For this section Virtual Kubelet's specific ACI provider will be referenced as the the ACI Connector. If you continue with this section you can skip sections below up to "Schedule a pod in ACI", as we use Azure Container Service (AKS) to easily deploy and install the connector, thus it is assumed that you've created an [AKS cluster](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough). To install the ACI Connector use the az cli and the aks namespace. Make sure to use the resource group of the aks cluster you've created and the name of the aks cluster you've created. You can choose the connector name to be anything. Choose any command below to install the Linux, Windows, or both the Windows and Linux Connector. Note: You might need to specify the --aci-resource-group, due to a bug in the az cli. The resource group is then auto-generated. To find the name navigate to the Azure Portal resource groups, scroll down and find the name that matches MC_aks cluster name_aks rg_location. 1. Install the Linux ACI Connector **Bash** ```cli az aks install-connector --resource-group --name ``` 2. Install the Windows ACI Connector **Bash** ```cli az aks install-connector --resource-group --name --os-type windows ``` 3. Install both the Windows and Linux ACI Connectors **Bash** ```cli az aks install-connector --resource-group --name --os-type both ``` Now you are ready to deploy a pod to the connector so skip to the "Schedule a pod in ACI" section. ## Manual set-up ### Create a Resource Group for ACI To use Azure Container Instances, you must provide a resource group. Create one with the az cli using the following command. ```cli export ACI_REGION=eastus az group create --name aci-group --location "$ACI_REGION" export AZURE_RG=aci-group ``` ### Create a service principal This creates an identity for the Virtual Kubelet ACI provider to use when provisioning resources on your account on behalf of Kubernetes. This step is optional if you are provisoning Virtual Kubelet on AKS. 1. Create a service principal with RBAC enabled for the quickstart: ```cli az ad sp create-for-rbac --name virtual-kubelet-quickstart -o table ``` 2. Save the values from the command output in environment variables: **Bash** ```cli export AZURE_TENANT_ID= export AZURE_CLIENT_ID= export AZURE_CLIENT_SECRET= ``` **PowerShell** ```cli $env:AZURE_TENANT_ID = "" $env:AZURE_CLIENT_ID = "" $env:AZURE_CLIENT_SECRET = "" ``` ## Deployment of the ACI provider in your cluster Run these commands to deploy the virtual kubelet which connects your Kubernetes cluster to Azure Container Instances. ```cli export VK_RELEASE=virtual-kubelet-latest ``` Grab the public master URI for your Kubernetes cluster and save the value. ```cli kubectl cluster-info export MASTER_URI= ``` If your cluster is an AKS cluster: ```cli export RELEASE_NAME=virtual-kubelet export VK_RELEASE=virtual-kubelet-latest export NODE_NAME=virtual-kubelet export CHART_URL=https://github.com/virtual-kubelet/virtual-kubelet/raw/master/charts/$VK_RELEASE.tgz helm install "$CHART_URL" --name "$RELEASE_NAME" \ --set provider=azure \ --set providers.azure.targetAKS=true \ --set providers.azure.masterUri=$MASTER_URI ``` For any other type of Kubernetes cluster: ```cli RELEASE_NAME=virtual-kubelet NODE_NAME=virtual-kubelet CHART_URL=https://github.com/virtual-kubelet/virtual-kubelet/raw/master/charts/$VK_RELEASE.tgz helm install "$CHART_URL" --name "$RELEASE_NAME" \ --set provider=azure \ --set rbac.install=true \ --set providers.azure.targetAKS=false \ --set providers.azure.aciResourceGroup=$AZURE_RG \ --set providers.azure.aciRegion=$ACI_REGION \ --set providers.azure.tenantId=$AZURE_TENANT_ID \ --set providers.azure.subscriptionId=$AZURE_SUBSCRIPTION_ID \ --set providers.azure.clientId=$AZURE_CLIENT_ID \ --set providers.azure.clientKey=$AZURE_CLIENT_SECRET \ --set providers.azure.masterUri=$MASTER_URI ``` If your cluster has RBAC disabled set ```rbac.install=false``` Output: ```console NAME: virtual-kubelet LAST DEPLOYED: Thu Feb 15 13:17:01 2018 NAMESPACE: default STATUS: DEPLOYED RESOURCES: ==> v1/Secret NAME TYPE DATA AGE virtual-kubelet-virtual-kubelet Opaque 3 1s ==> v1beta1/Deployment NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE virtual-kubelet-virtual-kubelet 1 1 1 0 1s ==> v1/Pod(related) NAME READY STATUS RESTARTS AGE virtual-kubelet-virtual-kubelet-7bcf5dc749-6mvgp 0/1 ContainerCreating 0 1s NOTES: The virtual kubelet is getting deployed on your cluster. To verify that virtual kubelet has started, run: ```cli kubectl --namespace=default get pods -l "app=virtual-kubelet-virtual-kubelet" ``` ## Create an AKS cluster with VNet Run the following commands to create an AKS cluster with a new Azure virtual network. Also, create two subnets. One will be delegated to the cluster and the other will be delegated to Azure Container Instances. ### Create an Azure virtual network and subnets First, set the following variables for your VNet range and two subnet ranges within that VNet. The following ranges are recommended for those just trying out the connector with VNet. **Bash** ```cli export VNET_RANGE=10.0.0.0/8 export CLUSTER_SUBNET_RANGE=10.240.0.0/16 export ACI_SUBNET_RANGE=10.241.0.0/16 export VNET_NAME=myAKSVNet export CLUSTER_SUBNET_NAME=myAKSSubnet export ACI_SUBNET_NAME=myACISubnet export AKS_CLUSTER_RG=myresourcegroup export KUBE_DNS_IP=10.0.0.10 ``` Run the following command to create a virtual network within Azure, and a subnet within that VNet. The subnet will be dedicated to the nodes in the AKS cluster. ```cli az network vnet create \ --resource-group $AKS_CLUSTER_RG \ --name $VNET_NAME \ --address-prefixes $VNET_RANGE \ --subnet-name $CLUSTER_SUBNET_NAME \ --subnet-prefix $CLUSTER_SUBNET_RANGE ``` Create a subnet that will be delegated to just resources within ACI, note that this needs to be an empty subnet, but within the same VNet that you already created. ```cli az network vnet subnet create \ --resource-group $AKS_CLUSTER_RG \ --vnet-name $VNET_NAME \ --name $ACI_SUBNET_NAME \ --address-prefix $ACI_SUBNET_RANGE ``` ### Create a service principal (OPTIONAL) Create an Azure Active Directory service principal to allow AKS to interact with other Azure resources. You can use a pre-created service principal too. ```cli az ad sp create-for-rbac -n "virtual-kubelet-sp" --skip-assignment ``` The output should look similar to the following. ```console { "appId": "bef76eb3-d743-4a97-9534-03e9388811fc", "displayName": "azure-cli-2018-08-29-22-29-29", "name": "http://azure-cli-2018-08-29-22-29-29", "password": "1d257915-8714-4ce7-xxxxxxxxxxxxx", "tenant": "72f988bf-86f1-41af-91ab-2d7cd011db48" } ``` Save the output values from the command output in enviroment variables. ```cli export AZURE_TENANT_ID= export AZURE_CLIENT_ID= export AZURE_CLIENT_SECRET= ``` These values can be integrated into the `az aks create` as a field ` --service-principal $AZURE_CLIENT_ID \`. ### Integrating Azure VNet Resource If you want to integrate an already created Azure VNet resource with your AKS cluster than follow these steps. Grab the virtual network resource id with the following command: ```cli az network vnet show --resource-group $AKS_CLUSTER_RG --name $VNET_NAME --query id -o tsv ``` Grant access to the AKS cluster to use the virtual network by creating a role and assigning it. ```cli az role assignment create --assignee $AZURE_CLIENT_ID --scope --role NetworkContributor ``` ### Create an AKS cluster with a virtual network Grab the id of the cluster subnet you created earlier with the following command. ```cli az network vnet subnet show --resource-group $AKS_CLUSTER_RG --vnet-name $VNET_NAME --name $CLUSTER_SUBNET_NAME --query id -o tsv ``` Save the entire output starting witn "/subscriptions/..." in the following enviorment variable. ```cli export VNET_SUBNET_ID= ``` Use the following command to create an AKS cluster with the virtual network you've already created. ```cli az aks create \ --resource-group myResourceGroup \ --name myAKSCluster \ --node-count 1 \ --network-plugin azure \ --service-cidr 10.0.0.0/16 \ --dns-service-ip $KUBE_DNS_IP \ --docker-bridge-address 172.17.0.1/16 \ --vnet-subnet-id $VNET_SUBNET_ID \ --client-secret $AZURE_CLIENT_SECRET ``` ### Deploy Virtual Kubelet Manually deploy the Virtual Kubelet, the following env. variables have already been set earlier. You do need to pass through the subnet you created for ACI earlier, otherwise the container instances will not be able to participate with the other pods within the cluster subnet. Grab the public master URI for your Kubernetes cluster and save the value. ```cli kubectl cluster-info export MASTER_URI= ``` Set the following values for the helm chart. ```cli RELEASE_NAME=virtual-kubelet NODE_NAME=virtual-kubelet CHART_URL=https://github.com/virtual-kubelet/virtual-kubelet/raw/master/charts/$VK_RELEASE.tgz ``` If your cluster is an AKS cluster: ```cli helm install "$CHART_URL" --name "$RELEASE_NAME" \ --set provider=azure \ --set providers.azure.targetAKS=true \ --set providers.azure.vnet.enabled=true \ --set providers.azure.vnet.subnetName=$ACI_SUBNET_NAME \ --set providers.azure.vent.subnetCidr=$ACI_SUBNET_RANGE \ --set providers.azure.vnet.clusterCidr=$CLUSTER_SUBNET_RANGE \ --set providers.azure.vnet.kubeDnsIp=$KUBE_DNS_IP \ --set providers.azure.masterUri=$MASTER_URI ``` For any other type of cluster: ```cli helm install "$CHART_URL" --name "$RELEASE_NAME" \ --set provider=azure \ --set providers.azure.targetAKS=false \ --set providers.azure.vnet.enabled=true \ --set providers.azure.vnet.subnetName=$ACI_SUBNET_NAME \ --set providers.azure.vent.subnetCidr=$ACI_SUBNET_RANGE \ --set providers.azure.vnet.kubeDnsIp=$KUBE_DNS_IP \ --set providers.azure.tenantId=$AZURE_TENANT_ID \ --set providers.azure.subscriptionId=$AZURE_SUBSCRIPTION_ID \ --set providers.azure.aciResourceGroup=$AZURE_RG \ --set providers.azure.aciRegion=$ACI_REGION \ --set providers.azure.masterUri=$MASTER_URI ``` ## Validate the Virtual Kubelet ACI provider To validate that the Virtual Kubelet has been installed, return a list of Kubernetes nodes using the [kubectl get nodes][kubectl-get] command. You should see a node that matches the name given to the ACI connector. ```cli kubectl get nodes ``` Output: ```console NAME STATUS ROLES AGE VERSION virtual-kubelet-virtual-kubelet Ready 2m v1.8.3 aks-nodepool1-39289454-0 Ready agent 22h v1.7.7 aks-nodepool1-39289454-1 Ready agent 22h v1.7.7 aks-nodepool1-39289454-2 Ready agent 22h v1.7.7 ``` ## Schedule a pod in ACI Create a file named `virtual-kubelet-test.yaml` and copy in the following YAML. ```yaml apiVersion: v1 kind: Pod metadata: name: helloworld spec: containers: - image: microsoft/aci-helloworld imagePullPolicy: Always name: helloworld resources: requests: memory: 1G cpu: 1 ports: - containerPort: 80 name: http protocol: TCP - containerPort: 443 name: https dnsPolicy: ClusterFirst nodeSelector: kubernetes.io/role: agent beta.kubernetes.io/os: linux type: virtual-kubelet tolerations: - key: virtual-kubelet.io/provider operator: Exists - key: azure.com/aci effect: NoSchedule ``` Notice that Virtual-Kubelet nodes are tainted by default to avoid unexpected pods running on them, i.e. kube-proxy, other virtual-kubelet pods, etc. To schedule a pod to them, you need to add the toleration to the pod spec and a node selector: ``` nodeSelector: kubernetes.io/role: agent beta.kubernetes.io/os: linux type: virtual-kubelet tolerations: - key: virtual-kubelet.io/provider operator: Exists - key: azure.com/aci effect: NoSchedule ``` Also, specify a nodeSelector so the pods will be forced onto the Virtual-Kubelet node. ``` nodeSelector: kubernetes.io/role: agent beta.kubernetes.io/os: linux type: virtual-kubelet ``` Run the application with the [kubectl create][kubectl-create] command. ```cli kubectl create -f virtual-kubelet-test.yaml ``` Use the [kubectl get pods][kubectl-get] command with the `-o wide` argument to output a list of pods with the scheduled node. ```cli kubectl get pods -o wide ``` Notice that the `helloworld` pod is running on the `virtual-kubelet` node. ```console NAME READY STATUS RESTARTS AGE IP NODE aci-helloworld-2559879000-8vmjw 1/1 Running 0 39s 52.179.3.180 virtual-kubelet ``` If the AKS cluster was configured with a virtual network, then the output will look like the following. The container instance will get a private ip rather than a public one. ```console NAME READY STATUS RESTARTS AGE IP NODE aci-helloworld-9b55975f-bnmfl 1/1 Running 0 4m 10.241.0.4 virtual-kubelet ``` To validate that the container is running in an Azure Container Instance, use the [az container list][az-container-list] Azure CLI command. ```cli az container list -o table ``` Output: ```console Name ResourceGroup ProvisioningState Image IP:ports CPU/Memory OsType Location ------------------------------- --------------- ------------------- ------------------------ --------------- --------------- -------- ---------- helloworld-2559879000-8vmjw myResourceGroup Succeeded microsoft/aci-helloworld 52.179.3.180:80 1.0 core/1.5 gb Linux eastus ``` ## Work arounds for the ACI Connector If your pod that's scheduled onto the Virtual Kubelet node is in a pending state please add these workarounds to your Virtual Kubelet pod spec. First, grab the logs from your ACI Connector pod, with the following command. ```cli kubectl logs virtual-kubelet-virtual-kubelet-7bcf5dc749-6mvgp ``` ### Stream or pod watcher errors If you see the following errors in the logs: ```console ERROR: logging before flag.Parse: E0914 00:02:01.546132 1 streamwatcher.go:109] Unable to decode an event from the watch stream: stream error: stream ID 181; INTERNAL_ERROR time="2018-09-14T00:02:01Z" level=error msg="Pod watcher connection is closed unexpectedly" namespace= node=virtual-kubelet-myconnector-linux operatingSystem=Linux provider=azure ``` Then copy the master URI with cluster-info. ```cli kubectl cluster-info ``` Output: ```console Kubernetes master is running at https://aksxxxx-xxxxx-xxxx-xxxxxxx.hcp.uksouth.azmk8s.io:443 ``` Edit your aci-connector deployment by first getting the deployment name. ```cli kubectl get deploy ``` Output: ```console NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE virtual-kubelet-virtual-kubelet 1 1 1 1 5d aci-helloworld 1 1 1 0 12m ``` Edit the deployment. ```cli kubectl edit deploy virtual-kubelet-virtual-kubelet ``` Add the following name and value to the deployment in the enviorment section. Use your copied AKS master URI. ```yaml --name: MASTER_URI value: https://aksxxxx-xxxxx-xxxx-xxxxxxx.hcp.uksouth.azmk8s.io:443 ``` ### Taint deprecated errors If you see the following errors in the logs: ```console Flag --taint has been deprecated, Taint key should now be configured using the VK_TAINT_KEY environment variable ``` Then edit your aci-connector deployment by first grabbing the deployment name. ```cli kubectl get deploy ``` Output: ```console NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE virtual-kubelet-virtual-kubelet 1 1 1 1 5d aci-helloworld 1 1 1 0 12m ``` Edit the connector deployment. ```cli kubectl edit deploy virtual-kubelet-virtual-kubelet ``` Add the following as an enviorment variable within the deployment. ```yaml --name: VK_TAINT_KEY value: azure.com/aci ``` Also, delete the following argument in your pod spec: ```yaml - --taint - azure.com/aci ``` ## Upgrade the ACI Connector If you've installed Virtual Kubelet with the Azure cli so you're using the ACI Connector implementation, then you are also able to upgrade the connector to the latest release. Run the following command to upgrade your ACI Connector. ```cli az aks upgrade-connector --resource-group --name --connector-name virtual-kubelet --os-type linux ``` ## Remove the Virtual Kubelet You can remove your Virtual Kubelet node by deleting the Helm deployment. Run the following command: ```cli helm delete virtual-kubelet --purge ``` If you used the ACI Connector installation then use the following command to remove the the ACI Connector from your cluster. ```cli az aks remove-connector --resource-group --name --connector-name virtual-kubelet --os-type linux ``` [kubectl-create]: https://kubernetes.io/docs/user-guide/kubectl/v1.6/#create [kubectl-get]: https://kubernetes.io/docs/user-guide/kubectl/v1.8/#get [az-container-list]: https://docs.microsoft.com/en-us/cli/azure/container?view=azure-cli-latest#az_container_list [az-container-show]: https://docs.microsoft.com/en-us/cli/azure/container?view=azure-cli-latest#az_container_show