Lightweight Kubernetes
 
 
 
 
Go to file
Brendan Burns 56ca1ef328 Update README.md 2015-02-03 11:20:56 -08:00
Godeps Import ginkgo and gomega libraries into kubernetes 2015-01-28 15:09:53 -08:00
api Tighten validation of Name and Namespace 2015-01-27 17:04:59 -05:00
build Fix dockerfile for etcd.2.0.0 2015-01-30 15:32:13 +01:00
cluster Merge pull request #4062 from dchen1107/image 2015-02-03 10:50:28 -08:00
cmd Convert proxy server to hyperkube 2015-02-02 14:03:13 -08:00
contrib Merge pull request #4035 from brendandburns/webtest 2015-02-02 16:08:44 -08:00
docs Merge pull request #4054 from kargakis/docs 2015-02-03 09:50:27 -08:00
examples Add a missing header... 2015-02-02 16:39:53 -08:00
hack Merge pull request #3995 from filbranden/e2e_pod_update_remove_external_json 2015-02-02 11:37:19 -08:00
hooks Fix errant error message from boilerplate check 2015-01-19 14:23:24 -08:00
pkg Merge pull request #3592 from brendandburns/cli 2015-02-03 09:07:05 -08:00
plugin Merge pull request #3998 from jbeda/hyperkube-servers2 2015-02-02 12:33:55 -08:00
test Moved TestPodHasServiceEnvVars into the pods test suite and deleted the 2015-02-03 09:17:14 -05:00
third_party Swagger UI: Updating swagger-ui.js to list the resources and operations 2015-01-12 17:29:07 -08:00
www Moving swagger-ui files from www/swagger-ui to third-party/swagger-ui 2015-01-05 16:27:33 -08:00
.gitignore Generate JUnit XML for Jenkins from the Go e2e tests 2015-01-28 15:09:53 -08:00
.travis.yml Set max parallel builds on travis 2015-01-30 19:41:53 -05:00
CHANGELOG.md Update changelog. 2015-01-21 10:00:12 -08:00
CONTRIB.md Move CONTRIB{,UTING}.md so GitHub shows it 2014-07-28 17:06:29 -04:00
CONTRIBUTING.md Move developer documentation to docs/devel/ 2014-10-15 08:30:02 -07:00
DESIGN.md Removing TOC links to no-longer-extant sections 2014-10-29 15:34:01 -07:00
LICENSE First commit 2014-06-06 16:40:48 -07:00
MAINTAINERS.md Add self as local-up-cluster maintainer 2015-02-03 12:04:16 -05:00
Makefile Rework hack/ and build/ directories. 2014-11-01 17:56:41 -07:00
README.md Update README.md 2015-02-03 11:20:56 -08:00
Vagrantfile Reduce number of minions to improve user experience 2015-01-09 13:00:48 -05:00
logo.pdf change logo blue slightly 2014-08-15 09:54:00 -07:00
logo.png change logo blue slightly 2014-08-15 09:54:00 -07:00
logo.svg change logo blue slightly 2014-08-15 09:54:00 -07:00
logo_usage_guidelines.md Add logo usage guidelines doc. 2014-08-26 09:13:39 -07:00

README.md

Kubernetes

GoDoc Travis

Kubernetes is an open source system for managing containerized applications across multiple hosts, providing basic mechanisms for deployment, maintenance, and scaling of applications.

Kubernetes is:

  • lean: lightweight, simple, accessible
  • portable: public, private, hybrid, multi cloud
  • extensible: modular, pluggable, hookable, composable
  • self-healing: auto-placement, auto-restart, auto-replication

Kubernetes builds upon a decade and a half of experience at Google running production workloads at scale, combined with best-of-breed ideas and practices from the community.


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.

Concepts

Kubernetes works with the following concepts:

Clusters are the compute resources on top of which your containers are built. Kubernetes can run anywhere! See the Getting Started Guides for instructions for a variety of services.

Pods are a colocated group of Docker containers with shared volumes. They're the smallest deployable units that can be created, scheduled, and managed with Kubernetes. Pods can be created individually, but it's recommended that you use a replication controller even if creating a single pod. More about pods.

Replication controllers manage the lifecycle of pods. They ensure that a specified number of pods are running at any given time, by creating or killing pods as required. More about replication controllers.

Services provide a single, stable name and address for a set of pods. They act as basic load balancers. More about services.

Labels are used to organize and select groups of objects based on key:value pairs. More about labels.

Documentation

Kubernetes documentation is organized into several categories.

  • Getting Started Guides
  • User Documentation
    • User FAQ
    • in docs
    • for people who want to run programs on kubernetes
    • describes current features of the system (with brief mentions of planned features)
  • Developer Documentation
    • in docs/devel
    • for people who want to contribute code to kubernetes
    • covers development conventions
    • explains current architecture and project plans
  • ** Service Documentation***
    • Service FAQ
    • for people who are interested in how Services work
    • details of kube-proxy iptables
    • how to wire services to external internet
  • Design Documentation
    • in docs/design
    • for people who want to understand the design choices made
    • describes tradeoffs, alternative designs
    • descriptions of planned features that are too long for a github issue.
  • Walkthroughs and Examples
    • in examples
    • Hands on introduction and example config files
  • API documentation
  • Wiki/FAQ

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 channel on freenode.net. We also have the google-containers Google Groups mailing list for questions and discussion as well as the kubernetes-announce mailing list for important announcements (low-traffic, no chatter).

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.