If you are using a released version of Kubernetes, you should refer to the docs that go with that version.
The latest release of this document can be found [here](http://releases.k8s.io/release-1.1/docs/getting-started-guides/docker.md).Documentation for other releases can be found at releases.k8s.io.
Table of Contents
- Overview
- Prerequisites
- Run it
- Download kubectl
- Test it out
- Run an application
- Expose it as a service
- A note on turning down your cluster
- Troubleshooting
The following instructions show you how to set up a simple, single node Kubernetes cluster using Docker.
Here's a diagram of what the final result will look like:
- You need to have docker installed on one machine.
- Decide what Kubernetes version to use. Set the
${K8S_VERSION}
variable to a value such as "1.1.1".
docker run \
--volume=/:/rootfs:ro \
--volume=/sys:/sys:ro \
--volume=/dev:/dev \
--volume=/var/lib/docker/:/var/lib/docker:rw \
--volume=/var/lib/kubelet/:/var/lib/kubelet:rw \
--volume=/var/run:/var/run:rw \
--net=host \
--pid=host \
--privileged=true \
-d \
gcr.io/google_containers/hyperkube:v${K8S_VERSION} \
/hyperkube kubelet \
--containerized \
--hostname-override="127.0.0.1" \
--address="0.0.0.0" \
--api-servers=http://localhost:8080 \
--config=/etc/kubernetes/manifests \
--allow-privileged=true --v=10
This actually runs the kubelet, which in turn runs a pod that contains the other master components.
At this point you should have a running Kubernetes cluster. You can test this
by downloading the kubectl binary for ${K8S_VERSION}
(look at the URL in the
following links) and make it available by editing your PATH environment
variable.
(OS X)
(linux)
For example, OS X:
$ wget http://storage.googleapis.com/kubernetes-release/release/v${K8S_VERSION}/bin/darwin/amd64/kubectl
$ chmod 755 kubectl
$ PATH=$PATH:`pwd`
Linux:
$ wget http://storage.googleapis.com/kubernetes-release/release/v${K8S_VERSION}/bin/linux/amd64/kubectl
$ chmod 755 kubectl
$ PATH=$PATH:`pwd`
Create configuration:
$ kubectl config set-cluster test-doc --server=http://localhost:8080
$ kubectl config set-context test-doc --cluster=test-doc
$ kubectl config use-context test-doc
For Max OS X users instead of localhost
you will have to use IP address of your docker machine,
which you can find by running docker-machine env <machinename>
(see documentation
for details).
List the nodes in your cluster by running:
kubectl get nodes
This should print:
NAME LABELS STATUS
127.0.0.1 kubernetes.io/hostname=127.0.0.1 Ready
kubectl run nginx --image=nginx --port=80
Now run docker ps
you should see nginx running. You may need to wait a few minutes for the image to get pulled.
kubectl expose rc nginx --port=80
Run the following command to obtain the IP of this service we just created. There are two IPs, the first one is internal (CLUSTER_IP), and the second one is the external load-balanced IP.
kubectl get svc nginx
Alternatively, you can obtain only the first IP (CLUSTER_IP) by running:
kubectl get svc nginx --template={{.spec.clusterIP}}
Hit the webserver with the first IP (CLUSTER_IP):
curl <insert-cluster-ip-here>
Note that you will need run this curl command on your boot2docker VM if you are running on OS X.
Many of these containers run under the management of the kubelet
binary, which attempts to keep containers running, even if they fail. So, in order to turn down
the cluster, you need to first kill the kubelet container, and then any other containers.
You may use docker kill $(docker ps -aq)
, note this removes all containers running under Docker, so use with caution.
If you see your node as NotReady
it's possible that your OS does not have memcg and swap enabled.
-
Your kernel should support memory and swap accounting. Ensure that the following configs are turned on in your linux kernel:
CONFIG_RESOURCE_COUNTERS=y CONFIG_MEMCG=y CONFIG_MEMCG_SWAP=y CONFIG_MEMCG_SWAP_ENABLED=y CONFIG_MEMCG_KMEM=y
-
Enable the memory and swap accounting in the kernel, at boot, as command line parameters as follows:
GRUB_CMDLINE_LINUX="cgroup_enable=memory swapaccount=1"
NOTE: The above is specifically for GRUB2. You can check the command line parameters passed to your kernel by looking at the output of /proc/cmdline:
$cat /proc/cmdline BOOT_IMAGE=/boot/vmlinuz-3.18.4-aufs root=/dev/sda5 ro cgroup_enable=memory swapaccount=1