k3s/docs/design
Paul Morie 3988e0e069 Merge pull request #7987 from pweil-/security-context-doc
Update Security Context Documentation
2015-05-11 10:07:41 -04:00
..
clustering Add Dockerfile for sequence diagram generation 2015-01-26 15:25:47 -08:00
README.md Update docs. Add design principles. Fixes #6133. Fixes #4182. 2015-04-16 22:13:44 +00:00
access.md Fix confusing use of "comprise" 2015-03-25 14:55:34 -07:00
admission_control.md Admission doc cleanup 2015-02-20 10:46:09 -05:00
admission_control_limit_range.md Update design doc for limit range change 2015-04-01 16:54:21 -04:00
admission_control_resource_quota.md Admission doc cleanup 2015-02-20 10:46:09 -05:00
architecture.md fix the link to services.md 2015-04-21 21:24:53 -07:00
clustering.md Tweaks based on comments 2015-01-09 09:11:26 -08:00
command_execution_port_forwarding.md Add streaming command execution & port forwarding 2015-02-20 09:57:02 -05:00
event_compression.md Fix event doc link 2015-05-05 18:11:58 -07:00
identifiers.md Changing the case of API to be consistent with surrounding uses. 2015-04-01 14:49:33 -07:00
namespaces.md Update namespaces design 2015-03-18 11:33:02 -04:00
networking.md Make docs links go through docs.k8s.io 2015-04-23 16:36:27 -07:00
persistent-storage.md PersistentVolumeClaimBinder implementation 2015-04-27 12:05:11 -04:00
principles.md Update docs. Add design principles. Fixes #6133. Fixes #4182. 2015-04-16 22:13:44 +00:00
secrets.md Make docs links go through docs.k8s.io 2015-04-23 16:36:27 -07:00
security.md Make docs links go through docs.k8s.io 2015-04-23 16:36:27 -07:00
security_context.md bring doc up to date with actual api types 2015-05-08 16:38:28 -04:00
service_accounts.md Fix wrong link for security context 2015-05-07 16:10:50 +08:00
simple-rolling-update.md Add support for --rollback. 2015-05-06 10:21:35 -07:00

README.md

Kubernetes Design Overview

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

Kubernetes establishes robust declarative primitives for maintaining the desired state requested by the user. We see these primitives as the main value added by Kubernetes. Self-healing mechanisms, such as auto-restarting, re-scheduling, and replicating containers require active controllers, not just imperative orchestration.

Kubernetes is primarily targeted at applications composed of multiple containers, such as elastic, distributed micro-services. It is also designed to facilitate migration of non-containerized application stacks to Kubernetes. It therefore includes abstractions for grouping containers in both loosely coupled and tightly coupled formations, and provides ways for containers to find and communicate with each other in relatively familiar ways.

Kubernetes enables users to ask a cluster to run a set of containers. The system automatically chooses hosts to run those containers on. While Kubernetes's scheduler is currently very simple, we expect it to grow in sophistication over time. Scheduling is a policy-rich, topology-aware, workload-specific function that significantly impacts availability, performance, and capacity. The scheduler needs to take into account individual and collective resource requirements, quality of service requirements, hardware/software/policy constraints, affinity and anti-affinity specifications, data locality, inter-workload interference, deadlines, and so on. Workload-specific requirements will be exposed through the API as necessary.

Kubernetes is intended to run on a number of cloud providers, as well as on physical hosts.

A single Kubernetes cluster is not intended to span multiple availability zones. Instead, we recommend building a higher-level layer to replicate complete deployments of highly available applications across multiple zones (see the availability doc and cluster federation proposal for more details).

Finally, Kubernetes aspires to be an extensible, pluggable, building-block OSS platform and toolkit. Therefore, architecturally, we want Kubernetes to be built as a collection of pluggable components and layers, with the ability to use alternative schedulers, controllers, storage systems, and distribution mechanisms, and we're evolving its current code in that direction. Furthermore, we want others to be able to extend Kubernetes functionality, such as with higher-level PaaS functionality or multi-cluster layers, without modification of core Kubernetes source. Therefore, its API isn't just (or even necessarily mainly) targeted at end users, but at tool and extension developers. Its APIs are intended to serve as the foundation for an open ecosystem of tools, automation systems, and higher-level API layers. Consequently, there are no "internal" inter-component APIs. All APIs are visible and available, including the APIs used by the scheduler, the node controller, the replication-controller manager, Kubelet's API, etc. There's no glass to break -- in order to handle more complex use cases, one can just access the lower-level APIs in a fully transparent, composable manner.

For more about the Kubernetes architecture, see architecture.