Lightweight Kubernetes
 
 
 
 
Go to file
Mark Maglana fd29104ff5 Fix confusing use of "comprise"
The word "comprise" means "be composed of" or "contain" so
"applications comprised of multiple containers" would mean
"applications composed of of multiple containers" or "applications
contained of multiple containers" which is confusing.

I understand that this is nitpicking and that "comprise" has a new
meaning which is the opposite of its original definition just like
how "literally" now means "figuratively" to some people. However, I
believe that clarity is of utmost importance in technical
documentation which is why I'm proposing this change.
2015-03-25 14:55:34 -07:00
Godeps Merge pull request #5934 from vmarmol/update 2015-03-25 13:45:41 -07:00
api Updating swagger-spec with the latest go-restful code 2015-03-25 11:34:33 -07:00
build Publish a gs://kubernetes-release/release/latest.txt when we publish a build 2015-03-17 13:53:05 -07:00
cluster Merge pull request #5916 from justinsb/aws_cleanup_loadbalancers 2015-03-25 10:32:14 -07:00
cmd nodecontroller: add event recorder support 2015-03-25 15:06:53 -04:00
contrib update example systemd files to be more obvious 2015-03-20 15:56:42 -04:00
docs Fix confusing use of "comprise" 2015-03-25 14:55:34 -07:00
examples Merge pull request #5803 from ihmccreery/guestbook-example-point-to-getting-started 2015-03-25 13:02:45 -07:00
hack Merge pull request #5687 from nikhiljindal/client_test 2015-03-25 14:07:47 -07:00
hooks Turn on "description:" verification for v1beta3 API. 2015-03-06 23:53:35 +00:00
pkg Merge pull request #5738 from smarterclayton/cleanup_clients 2015-03-25 13:59:47 -07:00
plugin Clients should not check conditions, UpdateStatus() is inconsistent 2015-03-25 16:25:04 -04:00
test Merge pull request #5881 from satnam6502/serve_hostnames 2015-03-25 12:13:47 -07:00
third_party Revert "Fix need for yaml in GCE kube-up by importing PyYAML into third_party" 2015-03-10 15:42:28 -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 Updating test-go.sh to be able to run tests twice - for v1beta1 and 3 2015-03-25 12:51:22 -07: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 Surface godep usage instructions better. 2015-03-18 12:00:40 -07:00
DESIGN.md Fix confusing use of "comprise" 2015-03-25 14:55:34 -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 Remove unneeded make rule name. 2015-03-16 12:04:36 +01:00
README.md Merge pull request #5226 from ghodss/patch-6 2015-03-10 10:45:34 -07:00
Vagrantfile Vagrant VM memory environment variable. 2015-03-04 14:45:01 -06: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

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
    • 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
    • Design Overview
    • More 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. 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.