mirror of https://github.com/k3s-io/k3s
Merge pull request #36817 from skippbox/readme
Automatic merge from submit-queue improve readme for contributor experience **What this PR does / why we need it**: This improves the top-level README. Removes broken links, removes links to make you bounce to another page, adds proper links to docs. Shuffles things around a bit and improves reading. @kubernetes/contributor-experiencepull/6/head
Kubernetes Submit Queue
GitHub
commit
5143bae599
|
|
@ -1,4 +0,0 @@
|
|||
[Moved to CONTRIBUTING.md](CONTRIBUTING.md)
|
||||
|
||||
|
||||
[]()
|
||||
|
|
@ -12,7 +12,7 @@ please feel free to send a Pull Request.
|
|||
## Filing issues
|
||||
|
||||
If you have a question about Kubernetes or have a problem using it, please
|
||||
start with the [troubleshooting guide](docs/troubleshooting.md). If that
|
||||
start with the [troubleshooting guide](http://kubernetes.io/docs/troubleshooting/). If that
|
||||
doesn't answer your questions, or if you think you found a bug, please [file an
|
||||
issue](https://github.com/kubernetes/kubernetes/issues/new).
|
||||
|
||||
|
|
|
|||
10
DESIGN.md
10
DESIGN.md
|
|
@ -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.
|
||||
|
||||
|
||||
[]()
|
||||
165
README.md
165
README.md
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
[![Submit Queue Widget]][Submit Queue] [![GoDoc Widget]][GoDoc] [![Coverage Status Widget]][Coverage Status]
|
||||
|
||||
<img src="https://github.com/kubernetes/kubernetes/raw/master/logo/logo.png" width="100">
|
||||
|
||||
[Submit Queue]: http://submit-queue.k8s.io/#/e2e
|
||||
[Submit Queue Widget]: http://submit-queue.k8s.io/health.svg?v=1
|
||||
[GoDoc]: https://godoc.org/k8s.io/kubernetes
|
||||
|
|
@ -9,155 +11,60 @@
|
|||
[Coverage Status]: https://coveralls.io/r/kubernetes/kubernetes
|
||||
[Coverage Status Widget]: https://coveralls.io/repos/kubernetes/kubernetes/badge.svg
|
||||
|
||||
## Introduction
|
||||
|
||||
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))
|
||||
|
||||
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>
|
||||
|
||||
### Are you ...
|
||||
|
||||
* Interested in learning more about using Kubernetes? Please see our user-facing documentation on [kubernetes.io](http://kubernetes.io) or try the [Scalable Microservices with Kubernetes](https://www.udacity.com/course/scalable-microservices-with-kubernetes--ud615) course
|
||||
* Interested in hacking on the core Kubernetes code base? Keep reading!
|
||||
* Interested in learning more about using Kubernetes?
|
||||
- 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!
|
||||
|
||||
<hr>
|
||||
## Code of Conduct
|
||||
|
||||
Kubernetes is an open source system for managing [containerized applications](https://github.com/kubernetes/kubernetes/wiki/Why-Kubernetes%3F#why-containers) across multiple hosts,
|
||||
providing basic mechanisms for deployment, maintenance, and scaling of applications.
|
||||
The Kubernetes community abides by the CNCF [code of conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). Here is an excerpt:
|
||||
|
||||
Kubernetes is:
|
||||
_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._
|
||||
|
||||
* **lean**: lightweight, simple, accessible
|
||||
* **portable**: public, private, hybrid, multi cloud
|
||||
* **extensible**: modular, pluggable, hookable, composable
|
||||
* **self-healing**: auto-placement, auto-restart, auto-replication
|
||||
## Community
|
||||
|
||||
Kubernetes builds upon a [decade and a half of experience at Google running production workloads at scale](https://research.google.com/pubs/pub43438.html), combined with best-of-breed ideas and practices from the 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 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.
|
||||
|
||||
<hr>
|
||||
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/)
|
||||
|
||||
### Kubernetes is ready for Production!
|
||||
Ask questions and help answer them on [Slack](http://slack.k8s.io/) or [Stack Overflow](http://stackoverflow.com/questions/tagged/kubernetes)
|
||||
|
||||
Since the Kubernetes 1.0 release in July 2015 Kubernetes is ready for your production workloads.
|
||||
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))
|
||||
|
||||
### Kubernetes can run anywhere!
|
||||
Join a Special Interest Group ([SIG](https://github.com/kubernetes/community))
|
||||
|
||||
You can run Kubernetes on your local workstation under Vagrant, cloud providers (e.g. GCE, AWS, Azure), and physical hardware. Essentially, anywhere Linux runs you can run Kubernetes. Checkout the [Getting Started Guides](http://kubernetes.io/docs/getting-started-guides/) for details.
|
||||
## Contribute
|
||||
|
||||
## Concepts
|
||||
If you're interested in being a contributor and want to get involved in developing Kubernetes, get started with with this reading:
|
||||
|
||||
Kubernetes works with the following concepts:
|
||||
* The community [expectations](docs/devel/community-expectations.md)
|
||||
* The [contributor guidelines](CONTRIBUTING.md)
|
||||
* The [Kubernetes Developer Guide](docs/devel/README.md)
|
||||
|
||||
[**Cluster**](docs/admin/README.md)
|
||||
: A cluster is a set of physical or virtual machines and other infrastructure resources used by Kubernetes to run your applications. Kubernetes can run anywhere! See the [Getting Started Guides](docs/getting-started-guides/) for instructions for a variety of services.
|
||||
You will then most certainly gain a lot from joining a [SIG](https://github.com/kubernetes/community), attending the regular hangouts as well as the community [meeting](https://github.com/kubernetes/community/blob/master/community/README.md).
|
||||
|
||||
[**Node**](docs/admin/node.md)
|
||||
: A node is a physical or virtual machine running Kubernetes, onto which pods can be scheduled.
|
||||
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.
|
||||
|
||||
[**Pod**](docs/user-guide/pods.md)
|
||||
: 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.
|
||||
## Support
|
||||
|
||||
[**Replication controller**](docs/user-guide/replication-controller.md)
|
||||
: 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.
|
||||
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.
|
||||
|
||||
[**Service**](docs/user-guide/services.md)
|
||||
: Services provide a single, stable name and address for a set of pods.
|
||||
They act as basic load balancers.
|
||||
|
||||
[**Label**](docs/user-guide/labels.md)
|
||||
: Labels are used to organize and select groups of objects based on key:value pairs.
|
||||
|
||||
## Documentation
|
||||
|
||||
Kubernetes documentation is organized into several categories.
|
||||
|
||||
- **Getting started guides**
|
||||
- for people who want to create a Kubernetes cluster
|
||||
- in [Creating a Kubernetes Cluster](http://kubernetes.github.io/docs/getting-started-guides/)
|
||||
- for people who want to port Kubernetes to a new environment
|
||||
- in [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
|
||||
- in the [Kubernetes User Guide: Managing Applications](http://kubernetes.github.io/docs/user-guide/)
|
||||
*Tip: You can also view help documentation out on [http://kubernetes.io/docs/](http://kubernetes.io/docs/).*
|
||||
- the [Kubectl Command Line Interface](http://kubernetes.io/docs/user-guide/kubectl-overview/) is a detailed reference on
|
||||
the `kubectl` CLI
|
||||
- [User FAQ](https://github.com/kubernetes/kubernetes/wiki/User-FAQ)
|
||||
- **Cluster administrator documentation**
|
||||
- for people who want to create a Kubernetes cluster and administer it
|
||||
- in 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, write plugins
|
||||
or extensions, or modify the core Kubernetes code
|
||||
- in the [Kubernetes Developer Guide](docs/devel/README.md)
|
||||
- see also [notes on the API](docs/api.md)
|
||||
- see also the [API object documentation](docs/api-reference/README.md), a
|
||||
detailed description of all fields found in the core API objects
|
||||
- **Walkthroughs and examples**
|
||||
- hands-on introduction and example config files
|
||||
- in the [user guide](http://kubernetes.github.io/docs/user-guide/)
|
||||
- in the [docs/examples directory](examples/)
|
||||
- **Contributions from the Kubernetes community**
|
||||
- in the [docs/contrib directory](contrib/)
|
||||
- **Design documentation and design proposals**
|
||||
- for people who want to understand the design of Kubernetes, and feature proposals
|
||||
- design docs in the [Kubernetes Design Overview](docs/design/README.md) and the [docs/design directory](docs/design/)
|
||||
- proposals in the [docs/proposals directory](docs/proposals/)
|
||||
- **Wiki/FAQ**
|
||||
- in the [wiki](https://github.com/kubernetes/kubernetes/wiki)
|
||||
- troubleshooting information in the [troubleshooting guide](http://kubernetes.io/docs/troubleshooting/)
|
||||
|
||||
## Community, discussion, contribution, and support
|
||||
|
||||
See which companies are committed to driving quality in Kubernetes on our [community page](http://kubernetes.io/community/).
|
||||
|
||||
Do you want to help "shape the evolution of technologies that are container packaged, dynamically scheduled and microservices oriented?"
|
||||
|
||||
You should consider joining the [Cloud Native Computing Foundation](https://cncf.io/about). For details about who's involved and how Kubernetes plays a role, read [their announcement](https://cncf.io/news/announcement/2015/07/new-cloud-native-computing-foundation-drive-alignment-among-container).
|
||||
|
||||
### Code of conduct
|
||||
|
||||
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
|
||||
|
||||
### Are you ready to add to the discussion?
|
||||
|
||||
We have presence on:
|
||||
|
||||
* [Twitter](https://twitter.com/kubernetesio)
|
||||
* [Google+](https://plus.google.com/u/0/b/116512812300813784482/116512812300813784482)
|
||||
* [Blogger](http://blog.kubernetes.io/)
|
||||
|
||||
You can also view recordings of past events and presentations on our [Media page](http://kubernetes.io/media/).
|
||||
|
||||
For Q&A, our threads are at:
|
||||
|
||||
* [Stack Overflow](http://stackoverflow.com/questions/tagged/kubernetes)
|
||||
* [Slack](http://slack.k8s.io/)
|
||||
|
||||
### Want to contribute to Kubernetes?
|
||||
|
||||
If you're interested in being a contributor and want to get involved in developing Kubernetes, start in the [Kubernetes Developer Guide](docs/devel/README.md) and also review the [contributor guidelines](CONTRIBUTING.md).
|
||||
|
||||
Or, if you just have an idea for a new feature, see the [Kubernetes Features](https://github.com/kubernetes/features) repository for details on how to propose it.
|
||||
|
||||
Also, please see our [expectations](docs/devel/community-expectations.md) for members of
|
||||
the Kubernetes community.
|
||||
|
||||
### Support
|
||||
|
||||
While there are many different channels that you can use to get ahold of us, you can help make sure that we are efficient in getting you the help that you need.
|
||||
|
||||
If you need support, start with the [troubleshooting guide](docs/troubleshooting.md#getting-help) and work your way through the process that we've outlined.
|
||||
If you need support, start with the [troubleshooting guide](http://kubernetes.io/docs/troubleshooting/) and work your way through the process that we've outlined.
|
||||
|
||||
That said, if you have questions, reach out to us one way or another. We don't bite!
|
||||
|
||||
### Community resources
|
||||
|
||||
* **Awesome-kubernetes** - [http://ramitsurana.github.io/awesome-kubernetes](http://ramitsurana.github.io/awesome-kubernetes)
|
||||
|
||||
You can find more projects, tools and articles related to Kubernetes on the [awesome-kubernetes](https://github.com/ramitsurana/awesome-kubernetes) list. Add your project there and help us make it better.
|
||||
|
||||
* **CoreKube** - [https://corekube.com](https://corekube.com):
|
||||
|
||||
Instructive & educational resources for the Kubernetes community. By the community.
|
||||
|
||||
* **Community Documentation**
|
||||
|
||||
Here you can learn more about the current happenings in the [kubernetes community](https://github.com/kubernetes/community).
|
||||
|
||||
[]()
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +0,0 @@
|
|||
# Kubernetes Contrib is moving!
|
||||
|
||||
Checkout https://github.com/kubernetes/contrib for anything that is missing here!
|
||||
|
||||
|
||||
[]()
|
||||
|
|
@ -21,7 +21,7 @@
|
|||
* There are example files and walkthroughs in the [examples](../examples/)
|
||||
folder.
|
||||
|
||||
* If something went wrong, see the [troubleshooting](troubleshooting.md) document for how to debug.
|
||||
* If something went wrong, see the [troubleshooting](http://kubernetes.io/docs/troubleshooting/) guide for how to debug.
|
||||
You should also check the [known issues for the release](../CHANGELOG.md) you're using.
|
||||
|
||||
* To report a security issue, see [Reporting a Security Issue](reporting-security-issues.md).
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ The criteria for inclusion are as follows:
|
|||
specification, whereas there are countless different systems for definition workflows of dependent actions (e.g. Celery et al.).
|
||||
* The API object is expected to be generally useful to greater than 50% of the Kubernetes users. This is to ensure that we don't build up a collection of niche APIs
|
||||
that users rarely need.
|
||||
* There is general consensus in the Kubernetes community that the API object is in the "Kubernetes layer". See ["What is Kubernetes?"](whatisk8s.md) for a detailed
|
||||
* There is general consensus in the Kubernetes community that the API object is in the "Kubernetes layer". See ["What is Kubernetes?"](http://kubernetes.io/docs/whatisk8s/) for a detailed
|
||||
explanation of what we believe the "Kubernetes layer" to be.
|
||||
|
||||
Of course for every set of rules, we need to ensure that we are not hamstrung or limited by slavish devotion to those rules. Thus we also introduce two exceptions
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ redirect users to Slack. Also check out the
|
|||
In general, try to direct support questions to:
|
||||
|
||||
1. Documentation, such as the [user guide](../user-guide/README.md) and
|
||||
[troubleshooting guide](../troubleshooting.md)
|
||||
[troubleshooting guide](http://kubernetes.io/docs/troubleshooting/)
|
||||
|
||||
2. Stackoverflow
|
||||
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ These guidelines say *what* to do. See the Rationale section for *why*.
|
|||
|
||||
If you have a cluster partially working, but doing all the above steps seems like too much work,
|
||||
we still want to hear from you. We suggest you write a blog post or a Gist, and we will link to it on our wiki page.
|
||||
Just file an issue or chat us on [Slack](../troubleshooting.md#slack) and one of the committers will link to it from the wiki.
|
||||
Just file an issue or chat us on [Slack](http://slack.kubernetes.io) and one of the committers will link to it from the wiki.
|
||||
|
||||
## Development Distro Guidelines
|
||||
|
||||
|
|
|
|||
|
|
@ -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 -->
|
||||
[]()
|
||||
<!-- END MUNGE: GENERATED_ANALYTICS -->
|
||||
|
|
@ -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 -->
|
||||
[]()
|
||||
<!-- END MUNGE: GENERATED_ANALYTICS -->
|
||||
BIN
docs/warning.png
BIN
docs/warning.png
Binary file not shown.
|
Before Width: | Height: | Size: 2.3 KiB |
|
|
@ -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 -->
|
||||
[]()
|
||||
<!-- END MUNGE: GENERATED_ANALYTICS -->
|
||||
|
|
@ -644,7 +644,7 @@ $ <kubernetes>/cluster/kube-down.sh
|
|||
|
||||
If you are having trouble bringing up your guestbook app, double check that your external IP is properly defined for your frontend Service, and that the firewall for your cluster nodes is open to port 80.
|
||||
|
||||
Then, see the [troubleshooting documentation](../../docs/troubleshooting.md) for a further list of common issues and how you can diagnose them.
|
||||
Then, see the [troubleshooting documentation](http://kubernetes.io/docs/troubleshooting/) for a further list of common issues and how you can diagnose them.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ as well as for scale and functionality testing.
|
|||
|
||||
## Questions
|
||||
|
||||
For questions on running this app, you can ask on [Slack](../../docs/troubleshooting.md#slack).
|
||||
For questions on running this app, you can ask on [Slack](http://slack.kubernetes.io).
|
||||
|
||||
For questions about bigpetstore, and how the data is generated, ask on the apache bigtop mailing list.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +0,0 @@
|
|||
The Kubernetes UI has moved to [kube-ui](https://github.com/kubernetes/kube-ui)
|
||||
|
||||
|
||||
[]()
|
||||
Loading…
Reference in New Issue