Lightweight Kubernetes
 
 
 
 
Go to file
Clayton Coleman bbf3b55e76 Extract RESTHandler and allow API groupings
Prepare for running multiple API versions on the same HTTP server
by decoupling some of the mechanics of apiserver.  Define a new
APIGroup object which represents a version of the API.
2014-08-13 10:53:34 -04:00
api Fix typo in API 2014-08-08 13:16:10 +02:00
build Fix go files with wrong boilerplate 2014-08-12 17:48:00 -07:00
cluster Fix kubecfg.sh 2014-08-12 16:46:34 -07:00
cmd Extract RESTHandler and allow API groupings 2014-08-13 10:53:34 -04:00
docs Proposed roadmap to 1.0 2014-08-11 15:18:55 -07:00
examples Update the guestbook example to show the current json files from the examples/guestbook directory. 2014-07-30 16:52:58 -07:00
hack Fix verification scripts to actually look at all go files. 2014-08-12 17:47:59 -07:00
hooks Make boilerplate hook work for .sh files, too. 2014-06-25 17:11:48 -07:00
pkg Extract RESTHandler and allow API groupings 2014-08-13 10:53:34 -04:00
release (Re)generate the build version when preparing a release. 2014-08-08 22:43:31 -06:00
third_party Merge pull request #826 from smarterclayton/git_check_wrong 2014-08-12 10:53:22 -07:00
.gitignore Remove executable permissions of files that do not need it. 2014-08-01 08:22:46 -07:00
.travis.yml Travis should test that build-go.sh generated something 2014-07-28 15:23:17 -04:00
CONTRIB.md Move CONTRIB{,UTING}.md so GitHub shows it 2014-07-28 17:06:29 -04:00
CONTRIBUTING.md Move CONTRIB{,UTING}.md so GitHub shows it 2014-07-28 17:06:29 -04:00
DESIGN.md Link to architecture diagram 2014-07-18 23:36:36 -07:00
LICENSE First commit 2014-06-06 16:40:48 -07:00
README.md Update README.md 2014-08-08 12:49:06 -07:00
Vagrantfile Initial vagrant setup and e2e testing support 2014-07-24 16:32:36 -04:00
logo.pdf Add logo files (.svg, .pdf, .png) 2014-08-01 16:49:26 -07:00
logo.png Add logo files (.svg, .pdf, .png) 2014-08-01 16:49:26 -07:00
logo.svg Add logo files (.svg, .pdf, .png) 2014-08-01 16:49:26 -07:00

README.md

Kubernetes

Kubernetes is an open source implementation of container cluster management.

Kubernetes Design Document - Kubernetes @ Google I/O 2014

GoDoc Travis

Kubernetes can run anywhere!

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.

Kubernetes is in pre-production beta!

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.

Contents

Where to go next?

Detailed example application

Example of dynamic updates

Or fork and start hacking!

Community, discussion and support

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.

Development

Hooks

# 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

Unit tests

cd kubernetes
hack/test-go.sh

Coverage

cd kubernetes
go tool cover -html=target/c.out

Integration tests

# 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/integration-test.sh

End-to-End tests

With a GCE account set up for running cluster/kube-up.sh (see Setup above):

cd kubernetes
hack/e2e-test.sh

Keeping your development fork in sync

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

Regenerating the documentation

cd kubernetes/api
sudo docker build -t kubernetes/raml2html .
sudo docker run --name="docgen" kubernetes/raml2html
sudo docker cp docgen:/data/kubernetes.html .