Official releases are built in Docker containers. Details are here. You can do simple builds and development with just a local Docker installation. If want to build go locally outside of docker, please continue below.
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. Ensure your version of Go is at least 1.3.
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 git@github.com:GoogleCloudPlatform/kubernetes.git
The commands above will not work if there are more than one directory in $GOPATH
.
(Obviously, clone your own fork of Kubernetes if you plan to do development.)
Kubernetes uses godep to manage dependencies. It is not strictly required for building Kubernetes but it is required when managing dependencies under the Godeps/ tree, and is required by a number of the build and test scripts. 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:
apt-get install mercurial
or yum install mercurial
on Linux, or brew.sh on OS X, or download
directly from mercurial.export GOPATH=$HOME/go-tools
mkdir -p $GOPATH
go get github.com/tools/godep
export GOPATH=$HOME/go-tools
export PATH=$PATH:$GOPATH/bin
Here is a quick summary of godep
. godep
helps manage third party dependencies by copying known versions into Godeps/_workspace. You can use godep
in three ways:
godep
to call your go
commands. For example: godep go test ./...
godep
to modify your $GOPATH
so that other tools know where to find the dependencies. Specifically: export GOPATH=$GOPATH:$(godep path)
godep
to copy the saved versions of packages into your $GOPATH
. This is done with godep 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.
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 install etcd, run:
cd kubernetes
hack/install-etcd.sh
sudo ln -s $(pwd)/third_party/etcd/bin/etcd /usr/bin/etcd
cd kubernetes
hack/test-integration.sh
You can run an end-to-end test which will bring up a master and two minions, perform some tests, and then tear everything down. Make sure you have followed the getting started steps for your chosen cloud platform (which might involve changing the KUBERNETES_PROVIDER
environment variable to something other than "gce".
cd kubernetes
hack/e2e-test.sh
Pressing control-C should result in an orderly shutdown but if something goes wrong and you still have some VMs running you can force a cleanup with the magical incantation:
hack/e2e-test.sh 1 1 1
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
:
godep restore
to make sure you have all dependancies pulled.go get foo/bar
.foo/bar
.godep save ./...
under kubernetes' root directory.To update a package foo/bar
:
godep restore
to make sure you have all dependancies pulled.go get -u foo/bar
.godep update foo/bar
under kubernetes' root directory.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
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。