*** PLEASE NOTE: This document applies to the HEAD of the source tree only. If you are using a released version of Kubernetes, you almost certainly want the docs that go with that version.

Documentation for specific releases can be found at releases.k8s.io.

This directory contains diagrams for the clustering design doc.

This depends on the seqdiag utility. Assuming you have a non-borked python install, this should be installable with

pip install seqdiag

Just call make to regenerate the diagrams.

Building with Docker

If you are on a Mac or your pip install is messed up, you can easily build with docker.

make docker

The first run will be slow but things should be fast after that.

To clean up the docker containers that are created (and other cruft that is left around) you can run make docker-clean.

If you are using boot2docker and get warnings about clock skew (or if things aren't building for some reason) then you can fix that up with make fix-clock-skew.

Automatically rebuild on file changes

If you have the fswatch utility installed, you can have it monitor the file system and automatically rebuild when files have changed. Just do a make watch.