Lightweight Kubernetes
 
 
 
 
Go to file
krousey 5aa0219ada Merge pull request #9292 from cjcullen/test_pull_8946
Add an ssh tunnel option to the /proxy endpoint
2015-06-08 14:30:12 -07:00
Godeps Update go-etcd client library version and add ugorji codec to dependencies 2015-06-08 12:50:12 +02:00
api/swagger-spec Merge pull request #9024 from markturansky/recyc_controllers 2015-06-05 11:39:08 -07:00
build Add some text about the docs being sync'd to HEAD 2015-06-04 21:53:15 -07:00
cluster Merge pull request #9292 from cjcullen/test_pull_8946 2015-06-08 14:30:12 -07:00
cmd Merge pull request #9292 from cjcullen/test_pull_8946 2015-06-08 14:30:12 -07:00
contrib Merge pull request #9319 from skonzem/fix_doc_typos 2015-06-05 12:00:37 -07:00
docs Merge pull request #9366 from justinsb/fix_8376 2015-06-08 12:55:36 -07:00
examples example/cluster-dns: Fix typo. 2015-06-08 10:32:12 -07:00
hack Do not overwrite bash variables in jenkins for scalability tests 2015-06-08 13:51:24 +02:00
hooks Use generated DeepCopy methods. 2015-05-28 09:03:27 +02:00
pkg Merge pull request #9292 from cjcullen/test_pull_8946 2015-06-08 14:30:12 -07:00
plugin Scheduler doesn't send all fit predicate failures as events 2015-06-05 18:52:55 -07:00
test Merge pull request #9392 from jszczepkowski/e2e-net 2015-06-08 11:35:28 -07:00
third_party Add missing license files for third party 2015-06-04 16:00:41 -07:00
www Clean up ui build and generated files. 2015-06-04 14:54:15 -07:00
.gitignore Clean up ui build and generated files. 2015-06-04 14:54:15 -07:00
.travis.yml Delete deprecated API versions 2015-05-29 17:17:35 -07:00
CHANGELOG.md Add ga-beacon analytics to gendocs scripts 2015-05-15 18:56:38 -07:00
CONTRIB.md Add ga-beacon analytics to gendocs scripts 2015-05-15 18:56:38 -07:00
CONTRIBUTING.md Add ga-beacon analytics to gendocs scripts 2015-05-15 18:56:38 -07:00
DESIGN.md Add ga-beacon analytics to gendocs scripts 2015-05-15 18:56:38 -07:00
LICENSE
Makefile Remove unneeded make rule name. 2015-03-16 12:04:36 +01:00
README.md Add ga-beacon analytics to gendocs scripts 2015-05-15 18:56:38 -07:00
Vagrantfile Upgrade to Fedora 21, Docker 1.6, clean-up SDN 2015-06-04 10:59:23 -04: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 ga-beacon analytics to gendocs scripts 2015-05-15 18:56:38 -07:00
shippable.yml Delete deprecated API versions 2015-05-29 17:17:35 -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.

Analytics