github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-23 19:56:01 +00:00
Code Issues Projects Releases Wiki Activity

Additional cleanups and addressing review

Browse Source
This commit is contained in:
sebgoa 2016-11-15 20:55:42 +01:00
parent ec02f3bcc3
commit db98a18898
9 changed files with 10 additions and 259 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIB.md
View File

@ -1,4 +0,0 @@
[Moved to CONTRIBUTING.md](CONTRIBUTING.md)
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/CONTRIB.md?pixel)]()

10
DESIGN.md
View File

@ -1,10 +0,0 @@
# Kubernetes Overview
See the [user guide overview](docs/user-guide/overview.md) for an introduction to Kubernetes and its core concepts.
See the [design overview](docs/design/) for an overview of the system design.
See the [API overview](docs/api.md) and [conventions](docs/devel/api-conventions.md) for an overview of the API design.
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/DESIGN.md?pixel)]()

103
README.md
View File

@ -16,31 +16,17 @@
Kubernetes is an open source system for managing [containerized applications](http://kubernetes.io/docs/whatisk8s/) across multiple hosts, Kubernetes is an open source system for managing [containerized applications](http://kubernetes.io/docs/whatisk8s/) across multiple hosts,
providing basic mechanisms for deployment, maintenance, and scaling of applications. Kubernetes is hosted by the Cloud Native Computing Foundation ([CNCF](https://www.cncf.io)) providing basic mechanisms for deployment, maintenance, and scaling of applications. Kubernetes is hosted by the Cloud Native Computing Foundation ([CNCF](https://www.cncf.io))
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 using a system called [Borg](https://research.google.com/pubs/pub43438.html), combined with best-of-breed ideas and practices from the community. Kubernetes builds upon a decade and a half of experience at Google running production workloads at scale using a system called [Borg](https://research.google.com/pubs/pub43438.html), combined with best-of-breed ideas and practices from the community.
<hr> <hr>
### Kubernetes is ready for Production !
Since the Kubernetes 1.0 release in July 2015 Kubernetes is ready for your production workloads. Check the [case studies](http://kubernetes.io/case-studies/).
### Kubernetes can run anywhere !
You can run Kubernetes on your local workstation, cloud providers (e.g. GCE, AWS, Azure), on-premises virtual machines and physical hardware. Essentially, anywhere Linux runs you can run Kubernetes. Checkout the [deployment solutions](http://kubernetes.io/docs/getting-started-guides/) for details.
<hr>
### Are you ... ### Are you ...
* Interested in learning more about using Kubernetes? Please see our user-facing documentation on [kubernetes.io](http://kubernetes.io). Try our [interactive tutorial](http://kubernetes.io/docs/tutorials/kubernetes-basics/) or take a free course on [Scalable Microservices with Kubernetes](https://www.udacity.com/course/scalable-microservices-with-kubernetes--ud615). * Interested in learning more about using Kubernetes?
* Interested in hacking on the core Kubernetes code base, developing tools using the Kubernetes API or helping in anyway possible ? Keep reading! - See see our documentation on [kubernetes.io](http://kubernetes.io)
- Try our [interactive tutorial](http://kubernetes.io/docs/tutorials/kubernetes-basics/)
- Take a free course on [Scalable Microservices with Kubernetes](https://www.udacity.com/course/scalable-microservices-with-kubernetes--ud615).
* Interested in developing the core Kubernetes code base, developing tools using the Kubernetes API or helping in anyway possible ? Keep reading!
## Code of Conduct ## Code of Conduct
@ -48,56 +34,21 @@ The Kubernetes community abides by the CNCF [code of conduct](https://github.com
_As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities._ _As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities._
## Concepts Overview
Kubernetes works with the following concepts:
[**Cluster**](http://kubernetes.io/docs/admin/)
: A cluster is a set of physical or virtual machines and other infrastructure resources used by Kubernetes to run your applications.
[**Node**](http://kubernetes.io/docs/admin/node/)
: A node is a physical or virtual machine running Kubernetes, onto which pods can be scheduled.
[**Pod**](http://kubernetes.io/docs/user-guide/pods/)
: Pods are a colocated group of application 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.
[**Replication controller**](http://kubernetes.io/docs/user-guide/replication-controller/)
: 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.
[**Service**](http://kubernetes.io/docs/user-guide/services/)
: Services provide a single, stable name and address for a set of pods.
They act as basic load balancers.
[**Label**](http://kubernetes.io/docs/user-guide/labels/)
: Labels are used to organize and select groups of objects based on key:value pairs.
## Community ## Community
Do you want to help " shape the evolution of technologies that are container packaged, dynamically scheduled and microservices oriented? ". If you are a company, you should consider joining the [CNCF](https://cncf.io/about). For details about who's involved and how Kubernetes plays a role, read [the announcement](https://cncf.io/news/announcement/2015/07/new-cloud-native-computing-foundation-drive-alignment-among-container). Do you want to help "shape the evolution of technologies that are container-packaged, dynamically-scheduled and microservices-oriented? ". If you are a company, you should consider joining the [CNCF](https://cncf.io/about). For details about who's involved in CNCF and how Kubernetes plays a role, read [the announcement](https://cncf.io/news/announcement/2015/07/new-cloud-native-computing-foundation-drive-alignment-among-container). For general information about our community see the website [community](http://kubernetes.io/community/) page.
Join us on social media and read our blog: Join us on social media ([Twitter](https://twitter.com/kubernetesio), [Google+](https://plus.google.com/u/0/b/116512812300813784482/116512812300813784482)) and read our [blog](http://blog.kubernetes.io/)
* [Twitter](https://twitter.com/kubernetesio) Ask questions and help answer them on [Slack](http://slack.k8s.io/) or [Stack Overflow](http://stackoverflow.com/questions/tagged/kubernetes)
* [Google+](https://plus.google.com/u/0/b/116512812300813784482/116512812300813784482)
* [Blog](http://blog.kubernetes.io/)
Ask questions and help answer them on: Attend our key events ([kubecon](http://events.linuxfoundation.org/events/kubecon), [cloudnativecon](http://events.linuxfoundation.org/events/cloudnativecon), weekly [community meeting](https://github.com/kubernetes/community/blob/master/community/README.md))
* [Stack Overflow](http://stackoverflow.com/questions/tagged/kubernetes)
* [Slack](http://slack.k8s.io/)
Attend our key events:
* [kubecon](http://events.linuxfoundation.org/events/kubecon)
* [cloudnativecon](http://events.linuxfoundation.org/events/cloudnativecon)
* weekly [community meeting](https://github.com/kubernetes/community/blob/master/community/README.md)
Join a Special Interest Group ([SIG](https://github.com/kubernetes/community)) Join a Special Interest Group ([SIG](https://github.com/kubernetes/community))
## Contribute ## Contribute
If you're interested in being a contributor and want to get involved in developing Kubernetes, get started with this light reading: If you're interested in being a contributor and want to get involved in developing Kubernetes, get started with with this reading:
* The community [expectations](docs/devel/community-expectations.md) * The community [expectations](docs/devel/community-expectations.md)
* The [contributor guidelines](CONTRIBUTING.md) * The [contributor guidelines](CONTRIBUTING.md)
@ -107,40 +58,6 @@ You will then most certainly gain a lot from joining a [SIG](https://github.com/
If you have an idea for a new feature, see the [Kubernetes Features](https://github.com/kubernetes/features) repository for a list of features that are coming in new releases as well as details on how to propose one. If you have an idea for a new feature, see the [Kubernetes Features](https://github.com/kubernetes/features) repository for a list of features that are coming in new releases as well as details on how to propose one.
## Documentation
The Kubernetes [documentation](http://kubernetes.io/docs/) is organized into several categories.
- **Getting started guides**
- For people who want to create a Kubernetes cluster
- See [Creating a Kubernetes Cluster](http://kubernetes.github.io/docs/getting-started-guides/)
- For people who want to port Kubernetes to a new environment
- See [Getting Started from Scratch](http://kubernetes.github.io/docs/getting-started-guides/scratch/)
- **User documentation**
- For people who want to run programs on an existing Kubernetes cluster
- See the [Kubernetes User Guide: Managing Applications](http://kubernetes.github.io/docs/user-guide/)
- **Administrator documentation**
- For people who want to administer a Kubernetes cluster
- See the [Kubernetes Cluster Admin Guide](http://kubernetes.io/docs/admin/)
- **Developer and API documentation**
- For people who want to write programs that access the Kubernetes [API](docs/api.md), write plugins
or extensions, or modify the core Kubernetes code
- See the [Kubernetes Developer Guide](docs/devel/README.md)
- **Walkthroughs and examples**
- For Hands-on introduction and example config files
- See the [user guide](http://kubernetes.github.io/docs/user-guide/)
- See the [examples](examples/) directory
- **Contributions from the Kubernetes community**
- See the [contrib](contrib/) repository
- See the [incubator](https://github.com/kubernetes-incubator) organisation
- **Design documentation and design proposals**
- For people who want to understand the design of Kubernetes, and feature proposals
- See the design docs in the [Kubernetes Design Overview](docs/design/README.md) and the [design](docs/design/) directory
- See the proposals in the [proposals](docs/proposals/) directory
- **Wiki/FAQ**
- For general developer information see the [wiki](https://github.com/kubernetes/kubernetes/wiki)
- For user and admin frequently asked questions, see the [troubleshooting guide](http://kubernetes.io/docs/troubleshooting/)
## Support ## Support
While there are many different channels that you can use to get hold of us ([Slack](http://slack.k8s.io/), [Stack Overflow](http://stackoverflow.com/questions/tagged/kubernetes), [Issues](https://github.com/kubernetes/kubernetes/issues/new), [Forums/Mailing lists](https://groups.google.com/forum/#!forum/kubernetes-users)), you can help make sure that we are efficient in getting you the help that you need. While there are many different channels that you can use to get hold of us ([Slack](http://slack.k8s.io/), [Stack Overflow](http://stackoverflow.com/questions/tagged/kubernetes), [Issues](https://github.com/kubernetes/kubernetes/issues/new), [Forums/Mailing lists](https://groups.google.com/forum/#!forum/kubernetes-users)), you can help make sure that we are efficient in getting you the help that you need.

6
contrib/README.md
View File

@ -1,6 +0,0 @@
# Kubernetes Contrib is moving!
Checkout https://github.com/kubernetes/contrib for anything that is missing here!
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/contrib/README.md?pixel)]()

8
docs/roadmap.md
View File

@ -1,8 +0,0 @@
# Kubernetes Roadmap
Please watch the [Github milestones] (https://github.com/kubernetes/kubernetes/milestones) for our future plans.
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/roadmap.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS -->

9
docs/troubleshooting.md
View File

@ -1,9 +0,0 @@
# Troubleshooting
This document has [moved to Kubernetes.io](http://kubernetes.io/docs/troubleshooting/)
This file will be removed on 2017-05-01.
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/troubleshooting.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS -->

BIN
docs/warning.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 2.3 KiB

125
docs/whatisk8s.md
View File

@ -1,125 +0,0 @@
# What is Kubernetes?
Kubernetes is an [open-source platform for automating deployment, scaling, and operations of application containers](http://www.slideshare.net/BrianGrant11/wso2con-us-2015-kubernetes-a-platform-for-automating-deployment-scaling-and-operations) across clusters of hosts, providing container-centric infrastructure.
With Kubernetes, you are able to quickly and efficiently respond to customer demand:
- Deploy your applications quickly and predictably.
- Scale your applications on the fly.
- Seamlessly roll out new features.
- Optimize use of your hardware by using only the resources you need.
Our goal is to foster an ecosystem of components and tools that relieve the burden of running applications in public and private clouds.
#### Kubernetes is:
* **portable**: public, private, hybrid, multi-cloud
* **extensible**: modular, pluggable, hookable, composable
* **self-healing**: auto-placement, auto-restart, auto-replication, auto-scaling
The Kubernetes project was started by Google in 2014. Kubernetes builds upon a [decade and a half of experience that Google has with running production workloads at scale](https://research.google.com/pubs/pub43438.html), combined with best-of-breed ideas and practices from the community.
##### Ready to [Get Started](getting-started-guides/README.md)?
<hr>
#### Why containers?
Looking for reasons why you should be using [containers](http://aucouranton.com/2014/06/13/linux-containers-parallels-lxc-openvz-docker-and-more/)?
The *Old Way* to deploy applications was to install the applications on a host using the operating system package manager. This had the disadvantage of entangling the applications' executables, configuration, libraries, and lifecycles with each other and with the host OS. One could build immutable virtual-machine images in order to achieve predictable rollouts and rollbacks, but VMs are heavyweight and non-portable.
The *New Way* is to deploy containers based on operating-system-level virtualization rather than hardware virtualization. These containers are isolated from each other and from the host: they have their own filesystems, they can't see each others' processes, and their computational resource usage can be bounded. They are easier to build than VMs, and because they are decoupled from the underlying infrastructure and from the host filesystem, they are portable across clouds and OS distributions.
Because containers are small and fast, one application can be packed in each container image. It is this one-to-one application-to-image relationship that unlocks the full benefits of containers:
1. Immutable container images can be created at build/release time rather than deployment time, since each application doesn't need to be composed with the rest of the application stack nor married to the production infrastructure environment. This enables a consistent environment to be carried from development into production.
2. Containers are vastly more transparent than VMs, which facilitates monitoring and management. This is especially true when the containers' process lifecycles are managed by the infrastructure rather than hidden by a process supervisor inside the container.
3. With a single application per container, managing the containers becomes tantamount to managing deployment of the application.
Summary of container benefits:
* **Agile application creation and deployment**:
Increased ease and efficiency of container image creation compared to VM image use.
* **Continuous development, integration, and deployment**:
Provides for reliable and frequent container image build and deployment with quick and easy rollbacks (due to image immutability).
* **Dev and Ops separation of concerns**:
Create application container images at build/release time rather than deployment time, thereby decoupling applications from infrastructure.
* **Environmental consistency across development, testing, and production**:
Runs the same on a laptop as it does in the cloud.
* **Cloud and OS distribution portability**:
Runs on Ubuntu, RHEL, CoreOS, on-prem, Google Container Engine, and anywhere else.
* **Application-centric management**:
Raises the level of abstraction from running an OS on virtual hardware to running an application on an OS using logical resources.
* **Loosely coupled, distributed, elastic, liberated [micro-services](http://martinfowler.com/articles/microservices.html)**:
Applications are broken into smaller, independent pieces and can be deployed and managed dynamically -- not a fat monolithic stack running on one big single-purpose machine.
* **Resource isolation**:
Predictable application performance.
* **Resource utilization**:
High efficiency and density.
#### Why do I need Kubernetes and what can it do?
Kubernetes can schedule and run application containers on clusters of physical or virtual machines.
It can also do much more than that.
In order to take full advantage of the potential benefits of containers and leave the old deployment methods behind, one needs to cut the cord to physical and virtual machines.
However, once specific containers are no longer bound to specific machines, **host-centric** infrastructure no longer works: managed groups, load balancing, auto-scaling, etc. One needs **container-centric** infrastructure. That's what Kubernetes provides.
Kubernetes satisfies a number of common needs of applications running in production, such as:
* [co-locating helper processes](user-guide/pods.md), facilitating composite applications and preserving the one-application-per-container model,
* [mounting storage systems](user-guide/volumes.md),
* [distributing secrets](user-guide/secrets.md),
* [application health checking](user-guide/production-pods.md#liveness-and-readiness-probes-aka-health-checks),
* [replicating application instances](user-guide/replication-controller.md),
* [horizontal auto-scaling](user-guide/horizontal-pod-autoscaler.md),
* [naming and discovery](user-guide/connecting-applications.md),
* [load balancing](user-guide/services.md),
* [rolling updates](user-guide/update-demo/),
* [resource monitoring](user-guide/monitoring.md),
* [log access and ingestion](user-guide/logging.md),
* [support for introspection and debugging](user-guide/introspection-and-debugging.md), and
* [identity and authorization](admin/authorization.md).
This provides the simplicity of Platform as a Service (PaaS) with the flexibility of Infrastructure as a Service (IaaS), and facilitates portability across infrastructure providers.
For more details, see the [user guide](user-guide/).
#### Why and how is Kubernetes a platform?
Even though Kubernetes provides a lot of functionality, there are always new scenarios that would benefit from new features. Application-specific workflows can be streamlined to accelerate developer velocity. Ad hoc orchestration that is acceptable initially often requires robust automation at scale. This is why Kubernetes was also designed to serve as a platform for building an ecosystem of components and tools to make it easier to deploy, scale, and manage applications.
[Labels](user-guide/labels.md) empower users to organize their resources however they please. [Annotations](user-guide/annotations.md) enable users to decorate resources with custom information to facilitate their workflows and provide an easy way for management tools to checkpoint state.
Additionally, the [Kubernetes control plane](admin/cluster-components.md) is built upon the same [APIs](api.md) that are available to developers and users. Users can write their own controllers, [schedulers](devel/scheduler.md), etc., if they choose, with [their own APIs](design/extending-api.md) that can be targeted by a general-purpose [command-line tool](user-guide/kubectl-overview.md).
This [design](design/principles.md) has enabled a number of other systems to build atop Kubernetes.
#### Kubernetes is not:
Kubernetes is not a traditional, all-inclusive PaaS (Platform as a Service) system. We preserve user choice where it is important.
* Kubernetes does not limit the types of applications supported. It does not dictate application frameworks (e.g., [Wildfly](http://wildfly.org/)), restrict the set of supported language runtimes (e.g., Java, Python, Ruby), cater to only [12-factor applications](http://12factor.net/), nor distinguish "apps" from "services". Kubernetes aims to support an extremely diverse variety of workloads, including stateless, stateful, and data-processing workloads. If an application can run in a container, it should run great on Kubernetes.
* Kubernetes does not provide middleware (e.g., message buses), data-processing frameworks (e.g., Spark), databases (e.g., mysql), nor cluster storage systems (e.g., Ceph) as built-in services. Such applications run on Kubernetes.
* Kubernetes does not have a click-to-deploy service marketplace.
* Kubernetes is unopinionated in the source-to-image space. It does not deploy source code and does not build your application. Continuous Integration (CI) workflow is an area where different users and projects have their own requirements and preferences, so we support layering CI workflows on Kubernetes but don't dictate how it should work.
* Kubernetes allows users to choose the logging, monitoring, and alerting systems of their choice. (Though we do provide some integrations as proof of concept.)
* Kubernetes does not provide nor mandate a comprehensive application configuration language/system (e.g., [jsonnet](https://github.com/google/jsonnet)).
* Kubernetes does not provide nor adopt any comprehensive machine configuration, maintenance, management, or self-healing systems.
On the other hand, a number of PaaS systems run *on* Kubernetes, such as [Openshift](https://github.com/openshift/origin), [Deis](http://deis.io/), and [Gondor](https://gondor.io/). You could also roll your own custom PaaS, integrate with a CI system of your choice, or get along just fine with just Kubernetes: bring your container images and deploy them on Kubernetes.
Since Kubernetes operates at the application level rather than at just the hardware level, it provides some generally applicable features common to PaaS offerings, such as deployment, scaling, load balancing, logging, monitoring, etc. However, Kubernetes is not monolithic, and these default solutions are optional and pluggable.
Additionally, Kubernetes is not a mere "orchestration system"; it eliminates the need for orchestration. The technical definition of "orchestration" is execution of a defined workflow: do A, then B, then C. In contrast, Kubernetes is comprised of a set of independent, composable control processes that continuously drive current state towards the provided desired state. It shouldn't matter how you get from A to C: make it so. Centralized control is also not required; the approach is more akin to "choreography". This results in a system that is easier to use and more powerful, robust, resilient, and extensible.
#### What does *Kubernetes* mean? K8s?
The name **Kubernetes** originates from Greek, meaning "helmsman" or "pilot", and is the root of "governor" and ["cybernetic"](http://www.etymonline.com/index.php?term=cybernetics). **K8s** is an abbreviation derived by replacing the 8 letters "ubernete" with 8.
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/whatisk8s.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS -->

4
www/README.md
View File

@ -1,4 +0,0 @@
The Kubernetes UI has moved to [kube-ui](https://github.com/kubernetes/kube-ui)
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/www/README.md?pixel)]()