diff --git a/README.md b/README.md index 3fab18d9d86d3755608fb6fdd3dcc7b600ea9ea6..abcf995f1cf64cb520dd6724e6e204328681cbcf 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,7 @@ including installing pre-releases. - [Quick Start](docs/quickstart.md) - [Installing Helm](docs/install.md) + - [Kubernetes Distribution Notes](docs/kubernetes_distros.md) - [Using Helm](docs/using_helm.md) - [Developing Charts](docs/charts.md) - [Chart Lifecycle Hooks](docs/charts_hooks.md) diff --git a/docs/kubernetes_distros.md b/docs/kubernetes_distros.md new file mode 100644 index 0000000000000000000000000000000000000000..ed6cbf208fb8b9e955b93b3fc5f8b1434cf63915 --- /dev/null +++ b/docs/kubernetes_distros.md @@ -0,0 +1,41 @@ +# Kubernetes Distribution Guide + +This document captures information about using Helm in specific Kubernetes +environments. + +We are trying to add more details to this document. Please contribute via Pull +Requests if you can. + +## MiniKube + +Helm is tested and known to work with [minikube](https://github.com/kubernetes/minikube). +It requires no additional configuration. + +## `scripts/local-cluster` and Hyperkube + +Hyperkube configured via `scripts/local-cluster.sh` is known to work. For raw +Hyperkube you may need to do some manual configuration. + +## GKE + +Google's GKE hosted Kubernetes platform is known to work with Helm, and requires +no additional configuration. + +## Ubuntu with 'kubeadm' + +Kubernetes bootstrapped with `kubeadm` is known to work on the following Linux +distributions: + +- Ubuntu 16.04 +- CAN SOMEONE CONFIRM ON FEDORA? + +Some versions of Helm (v2.0.0-beta2) require you to `export KUBECONFIG=/etc/kubernetes/admin.conf` +or create a `~/.kube/config`. + +## CoreOS + +Some versions of CoreOS's Kubernetes do not ship with `socat`, which is what +the Kubernetes API server uses to create tunnels. This will prevent Helm from +being able to tunnel to Tiller. + +