ACI docs & limitations (#502)

* adding limitations

* edits -1

* formatting

* making the docs usable :)
This commit is contained in:
Ria Bhatia
2019-01-15 13:05:30 -08:00
committed by GitHub
parent 20911aa3b5
commit 4f3bd20e15

View File

@@ -8,6 +8,7 @@ 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)
@@ -19,6 +20,30 @@ This document details configuring the Virtual Kubelet ACI provider.
* [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.
@@ -211,14 +236,15 @@ Grab the public master URI for your Kubernetes cluster and save the value.
```cli
kubectl cluster-info
export MASTER_URI=<public uri>
export MASTER_URI=<Kubernetes Master>
```
If your cluster is an AKS 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
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 \