Kubernetes is an open source implementation of container cluster management.
Kubernetes Design Document - Kubernetes @ Google I/O 2014
However, initial development was done on GCE and so our instructions and scripts are built around that. If you make it work on other infrastructure please let us know and contribute instructions/code.
While the concepts and architecture in Kubernetes represent years of experience designing and building large scale cluster manager at Google, the Kubernetes project is still under heavy development. Expect bugs, design and API changes as we bring it to a stable, production product over the coming year.
- Getting Started Guides
- kubecfg command line tool
- Kubernetes API Documentation
- Discussion and Community Support
- Hacking on Kubernetes
- Hacking on Kubernetes Salt configuration
Check out examples of Kubernetes in action, and community projects in the larger ecosystem:
- Detailed example application
- Example of dynamic updates
- Cluster monitoring with heapster and cAdvisor
- OpenShift 3 and developer focused workflows
- Kubernetes-on-Mesos framework
- Configure dynamic container networking with CoreOS Rudder
- Azure Kubernetes visualizer
Or fork and start hacking!
If you have questions or want to start contributing please reach out. We don't bite!
The Kubernetes team is hanging out on IRC on the #google-containers room on freenode.net. We also have the google-containers Google Groups mailing list.
If you are a company and are looking for a more formal engagement with Google around Kubernetes and containers at Google as a whole, please fill out this form. and we'll be in touch.
Kubernetes is written in Go programming language. If you haven't set up Go development environment, please follow this instruction to install go tool and set up GOPATH.
We highly recommend to put kubernetes' code into your GOPATH. For example, the following commands will download kubernetes' code under the current user's GOPATH (Assuming there's only one directory in GOPATH.):
$ echo $GOPATH
/home/user/goproj
$ mkdir -p $GOPATH/src/github.com/GoogleCloudPlatform/
$ cd $GOPATH/src/github.com/GoogleCloudPlatform/
$ git clone [email protected]:GoogleCloudPlatform/kubernetes.git
The commands above will not work if there are more than one directory in $GOPATH.
Kubernetes uses godep to manage dependencies. It is not required for building Kubernetes but it is required when managing dependencies under the Godeps/ tree. Please make sure that godep is installed and in your $PATH.
There are many ways to build and host go binaries. Here is an easy way to get utilities like godep installed:
- Ensure that mercurial is installed on your system. (some of godep's dependencies use the mercurial
source control system). Use
apt-get install mercurialoryum install mercurialon Linux, or brew.sh on OS X, or download directly from mercurial. - Create a new GOPATH for your tools and install godep:
GOPATH=$HOME/src/go-tools
mkdir -p $GOPATH
go get github.com/tools/godep
- Add $HOME/src/go-tools/bin to your path. Typically you'd add this to your ~/.profile:
export PATH=$PATH:$HOME/src/go-tools/bin
Here is a quick summary of godep. godep helps manage third party dependencies by copying known versions into Godep/_workspace. You can use godep in three ways:
- Use
godepto call yourgocommands. For example:godep go test ./... - Use
godepto modify your$GOPATHso that other tools know where to find the dependencies. Specifically:export GOPATH=$GOPATH:$(godep path) - Use
godepto copy the saved versions of packages into your$GOPATH. This is done withgodep restore.
We recommend using options #1 or #2.
Before committing any changes, please link/copy these hooks into your .git directory. This will keep you from accidentally committing non-gofmt'd go code.
NOTE: The ../.. part seems odd but is correct, since the newly created
links will be 2 levels down the tree.
cd kubernetes
ln -s ../../hooks/prepare-commit-msg .git/hooks/prepare-commit-msg
ln -s ../../hooks/commit-msg .git/hooks/commit-msg
cd kubernetes
hack/test-go.sh
Alternatively, you could also run:
cd kubernetes
godep go test ./...
If you only want to run unit tests in one package, you could run godep go test under the package directory. For example, the following commands will run all unit tests in package kubelet:
$ cd kubernetes # step into kubernetes' directory.
$ cd pkg/kubelet
$ godep go test
# some output from unit tests
PASS
ok github.com/GoogleCloudPlatform/kubernetes/pkg/kubelet 0.317s
cd kubernetes
godep go tool cover -html=target/c.out
You need an etcd somewhere in your path. To get from head:
go get github.com/coreos/etcd
go install github.com/coreos/etcd
sudo ln -s "$GOPATH/bin/etcd" /usr/bin/etcd
# Or just use the packaged one:
sudo ln -s "$REPO_ROOT/target/bin/etcd" /usr/bin/etcd
cd kubernetes
hack/test-integration.sh
With a GCE account set up for running cluster/kube-up.sh (see Setup above):
cd kubernetes
hack/e2e-test.sh
Kubernetes uses godep to manage dependencies. To add or update a package, please follow the instructions on godep's document.
To add a new package foo/bar:
- Download foo/bar into the first directory in GOPATH:
go get foo/bar. - Change code in kubernetes to use
foo/bar. - Run
godep save ./...under kubernetes' root directory.
To update a package foo/bar:
- Update the package with
go get -u foo/bar. - Change code in kubernetes accordingly if necessary.
- Run
godep update foo/bar.
One time after cloning your forked repo:
git remote add upstream https://github.com/GoogleCloudPlatform/kubernetes.git
Then each time you want to sync to upstream:
git fetch upstream
git rebase upstream/master
cd kubernetes/api
sudo docker build -t kubernetes/raml2html .
sudo docker run --name="docgen" kubernetes/raml2html
sudo docker cp docgen:/data/kubernetes.html .
View the API documentation using htmlpreview (works on your fork, too):
http://htmlpreview.github.io/?https://github.com/GoogleCloudPlatform/kubernetes/blob/master/api/kubernetes.html