Skip to content

Commit 5cabec5

Browse files
Merge pull request #488 from danifr/patch-1
Add note about the kubernetes version format
2 parents 775a492 + 1d8b250 commit 5cabec5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ docker run --rm -v $(pwd):/mnt -e OS=ubuntu -e VERSION=1.10.2 -e CONTAINER_RUNTI
6464
The above parameters are:
6565

6666
* `OS`: The operating system Kubernetes runs on.
67-
* `VERSION`: The version of Kubernetes to deploy.
67+
* `VERSION`: The version of Kubernetes to deploy. Must follow X.Y.Z format. ([Check kubeadm regex rule](https://github.com/kubernetes/kubernetes/blob/master/cmd/kubeadm/app/util/version.go#L43) for more information)
6868
* `CONTAINER_RUNTIME`: The container runtime Kubernetes uses. Set this value to `docker` (officially supported) or `cri_containerd`. Advanced Kubernetes users can use `cri_containerd`, however this requires an increased understanding of Kubernetes, specifically when running applications in a HA cluster. To run a HA cluster and access your applications, an external load balancer is required in front of your cluster. Setting this up is beyond the scope of this module. For more information, see the Kubernetes [documentation](https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/).
6969
* `CNI_PROVIDER`: The CNI network to install. Set this value to `weave`, `flannel`, `calico` or `cilium`.
7070
* `CNI_PROVIDER_VERSION` The CNI version to use. `cilium` uses this variable to reference the correct deployment file. Current version `cilium` is `1.4.3`
@@ -592,7 +592,7 @@ Defaults to `undef`.
592592

593593
#### `kubernetes_version`
594594

595-
The version of the Kubernetes containers to install.
595+
The version of the Kubernetes containers to install. Must follow X.Y.Z format.
596596

597597
Defaults to `1.10.2`.
598598

0 commit comments

Comments
 (0)