k3s/docs/user-guide
Alex Mohr 0e8020f9bb Merge pull request #11779 from JanetKuo/add-kubectl-annotation
Auto commit by PR queue bot
2015-08-04 18:28:12 -07:00
..
downward-api Use example syncer tags instead of hard-coded examples in doc 2015-07-27 14:48:41 -07:00
environment-guide Fix capitalization of Kubernetes in the documentation. 2015-07-20 14:39:36 -07:00
kubectl Merge pull request #11779 from JanetKuo/add-kubectl-annotation 2015-08-04 18:28:12 -07:00
limitrange Improve markdown highlighting in limit range user guide. 2015-07-19 03:54:28 +00:00
liveness Add markdown highlighting to liveness user guide. 2015-07-19 03:54:28 +00:00
logging-demo
node-selection Fix capitalization of Kubernetes in the documentation. 2015-07-20 14:39:36 -07:00
persistent-volumes Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
resourcequota Improve console output in resource quota doc. 2015-07-19 03:54:21 +00:00
secrets Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
update-demo Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
walkthrough Make munger begin/end less generic 2015-07-30 20:41:30 -04:00
README.md Fix capitalization of Kubernetes in the documentation. 2015-07-20 14:39:36 -07:00
accessing-the-cluster.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
annotations.md
application-troubleshooting.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
cadvisor.png
compute-resources.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
config-best-practices.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
configuring-containers.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
connecting-applications.md Missing argument to get documented result 2015-07-29 07:50:05 +02:00
connecting-to-applications-port-forward.md
connecting-to-applications-proxy.md
container-environment.md Merge pull request #12056 from pmorie/container-env-dapi 2015-07-31 12:16:04 -07:00
containers.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
debugging-services.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
deploying-applications.md Detailed walkthrough docs cleanup 2015-07-20 18:11:32 -07:00
docker-cli-to-kubectl.md Add support for attach to kubectl 2015-07-30 12:56:18 -07:00
downward-api.md Make munger begin/end less generic 2015-07-30 20:41:30 -04:00
gcm.png
getting-into-containers.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
identifiers.md
images.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
influx.png
introspection-and-debugging.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
k8s-ui-explore-filter.png
k8s-ui-explore-groupby.png
k8s-ui-explore-poddetail.png
k8s-ui-explore.png
k8s-ui-nodes.png
k8s-ui-overview.png
kibana.png
known-issues.md Add a known issues doc. 2015-07-20 17:28:20 -07:00
kubeconfig-file.md Collected markedown fixes around syntax. 2015-07-20 09:51:22 -07:00
labels.md Fix capitalization of Kubernetes in the documentation. 2015-07-20 14:39:36 -07:00
logging.md Make munger begin/end less generic 2015-07-30 20:41:30 -04:00
managing-deployments.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
monitoring-architecture.png
monitoring.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
multi-pod.yaml
namespaces.md Split namespace docs user vs admin. 2015-07-20 15:01:44 -07:00
overview.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
persistent-volumes.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
pod-states.md
pod.yaml Use example syncer tags instead of hard-coded examples in doc 2015-07-27 14:48:41 -07:00
pods.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
prereqs.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
production-pods.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
quick-start.md Fix console output in quick-start.md 2015-07-19 01:18:40 +01:00
replication-controller.md Delete overlapping controllers, add clarity to docs 2015-07-24 12:13:26 -07:00
replication.yaml
secrets.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
security-context.md
service-accounts.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
services-detail.png
services-detail.svg
services-firewalls.md Cleanup docs. 2015-07-20 16:25:37 -07:00
services-overview.png
services-overview.svg
services.md Remove equals from heading which breaks our links. 2015-07-20 14:44:10 -07:00
sharing-clusters.md Fix capitalization of Kubernetes in the documentation. 2015-07-20 14:39:36 -07:00
simple-nginx.md
simple-yaml.md Make munger begin/end less generic 2015-07-30 20:41:30 -04:00
ui.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
volumes.md capitalization 2015-07-27 16:01:26 -07:00
working-with-resources.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00

README.md

WARNING WARNING WARNING WARNING WARNING

PLEASE NOTE: This document applies to the HEAD of the source tree

If you are using a released version of Kubernetes, you should refer to the docs that go with that version.

The latest 1.0.x release of this document can be found [here](http://releases.k8s.io/release-1.0/docs/user-guide/README.md).

Documentation for other releases can be found at releases.k8s.io.

Kubernetes User Guide: Managing Applications

Table of Contents

The user guide is intended for anyone who wants to run programs and services on an existing Kubernetes cluster. Setup and administration of a Kubernetes cluster is described in the Cluster Admin Guide. The Developer Guide is for anyone wanting to either write code which directly accesses the Kubernetes API, or to contribute directly to the Kubernetes project.

Please ensure you have completed the prerequisites for running examples from the user guide.

Quick walkthrough

  1. Kubernetes 101
  2. Kubernetes 201

Thorough walkthrough

If you don't have much familiarity with Kubernetes, we recommend you read the following sections in order:

  1. Quick start: launch and expose an application
  2. Configuring and launching containers: configuring common container parameters
  3. Deploying continuously running applications
  4. Connecting applications: exposing applications to clients and users
  5. Working with containers in production
  6. Managing deployments
  7. Application introspection and debugging
    1. Using the Kubernetes web user interface
    2. Logging
    3. Monitoring
    4. Getting into containers via exec
    5. Connecting to containers via proxies
    6. Connecting to containers via port forwarding

Concept guide

Overview
A brief overview of Kubernetes concepts.
Cluster
A cluster is a set of physical or virtual machines and other infrastructure resources used by Kubernetes to run your applications.
Node
A node is a physical or virtual machine running Kubernetes, onto which pods can be scheduled.
Pod
A pod is a co-located group of containers and volumes.
Label
A label is a key/value pair that is attached to a resource, such as a pod, to convey a user-defined identifying attribute. Labels can be used to organize and to select subsets of resources.
Selector
A selector is an expression that matches labels in order to identify related resources, such as which pods are targeted by a load-balanced service.
Replication Controller
A replication controller ensures that a specified number of pod replicas are running at any one time. It both allows for easy scaling of replicated systems and handles re-creation of a pod when the machine it is on reboots or otherwise fails.
Service
A service defines a set of pods and a means by which to access them, such as single stable IP address and corresponding DNS name.
Volume
A volume is a directory, possibly with some data in it, which is accessible to a Container as part of its filesystem. Kubernetes volumes build upon Docker Volumes, adding provisioning of the volume directory and/or device.
Secret
A secret stores sensitive data, such as authentication tokens, which can be made available to containers upon request.
Name
A user- or client-provided name for a resource.
Namespace
A namespace is like a prefix to the name of a resource. Namespaces help different projects, teams, or customers to share a cluster, such as by preventing name collisions between unrelated teams.
Annotation
A key/value pair that can hold larger (compared to a label), and possibly not human-readable, data, intended to store non-identifying auxiliary data, especially data manipulated by tools and system extensions. Efficient filtering by annotation values is not supported.

Further reading

Analytics