Lightweight Kubernetes
 
 
 
 
Go to file
Brendan Burns ba95c8a176 Merge pull request #7014 from a-robinson/dirname
Move the logging-related directories to where I think they belong
2015-04-20 10:50:09 -07:00
Godeps Merge pull request #6939 from yichengq/bump-go-etcd 2015-04-17 15:46:27 -07:00
api/swagger-spec Update swagger spec 2015-04-11 11:20:22 -04:00
build use busybox as base image for kube-master docker images 2015-04-16 22:22:04 -07:00
cluster Merge pull request #7014 from a-robinson/dirname 2015-04-20 10:50:09 -07:00
cmd Merge pull request #6943 from lavalamp/fix4 2015-04-17 16:30:31 -07:00
contrib Move the logging-related directories to where I think they belong. 2015-04-17 23:59:50 +00:00
docs Mark a couple items as complete in the roadmap 2015-04-20 08:33:40 -07:00
examples Merge pull request #7014 from a-robinson/dirname 2015-04-20 10:50:09 -07:00
hack Remove -installsuffix from go build 2015-04-17 15:33:00 -04:00
hooks Turn on "description:" verification for v1beta3 API. 2015-03-06 23:53:35 +00:00
pkg Merge pull request #7000 from deads2k/deads-allow-many-modifications 2015-04-20 10:46:12 -07:00
plugin Merge pull request #6969 from erictune/use_kubeconfig 2015-04-17 15:07:04 -07:00
test Merge pull request #6941 from a-robinson/metrics 2015-04-17 14:40:06 -07:00
third_party add bower components to third party 2015-04-13 16:55:01 -07:00
www Moving swagger-ui files from www/swagger-ui to third-party/swagger-ui 2015-01-05 16:27:33 -08:00
.gitignore git Ignore .kubeconfig 2015-03-23 10:31:55 -04:00
.travis.yml Limit the number of concurrent tests in integration.go 2015-04-09 16:54:23 -07:00
CHANGELOG.md Add command and argument control to changelog 2015-04-09 22:54:48 -04:00
CONTRIB.md Move CONTRIB{,UTING}.md so GitHub shows it 2014-07-28 17:06:29 -04:00
CONTRIBUTING.md Surface godep usage instructions better. 2015-03-18 12:00:40 -07:00
DESIGN.md Update docs. Add design principles. Fixes #6133. Fixes #4182. 2015-04-16 22:13:44 +00:00
LICENSE First commit 2014-06-06 16:40:48 -07:00
Makefile Remove unneeded make rule name. 2015-03-16 12:04:36 +01:00
README.md Update docs. Add design principles. Fixes #6133. Fixes #4182. 2015-04-16 22:13:44 +00:00
Vagrantfile Fix #2741. Add support for alternate Vagrant providers: VMWare Fusion, VMWare Workstation, and Parallels. 2015-04-17 11:26:29 -07:00
logo.pdf Simplify the SVG for the logo 2015-02-20 21:15:31 -08:00
logo.png change logo blue slightly 2014-08-15 09:54:00 -07:00
logo.svg Simplify the SVG for the logo 2015-02-20 21:15:31 -08:00
logo_usage_guidelines.md Add logo usage guidelines doc. 2014-08-26 09:13:39 -07:00
shippable.yml Limit the number of concurrent tests in integration.go 2015-04-09 16:54:23 -07:00

README.md

Kubernetes

GoDoc Travis Coverage Status

I am ...

  • Interested in learning more about using Kubernetes? Please see our user-facing documentation on kubernetes.io
  • Interested in hacking on the core Kubernetes code base? Keep reading!

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
    • in docs/services.md
    • Service FAQ
    • for people who are interested in how Services work
    • details of kube-proxy iptables
    • how to wire services to external internet
  • API documentation
    • in the API doc
    • and automatically generated API documentation served by the master
  • 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
  • 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. This client may be overloaded from time to time. If this happens you can use any IRC client out there to talk to us.

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.