k3s/docs/user-guide
k8s-merge-robot 739285b146 Merge pull request #21265 from stevekuznetsov/skuznets/new-sa
Auto commit by PR queue bot
2016-03-01 01:14:06 -08:00
..
configmap Add ConfigMap docs 2016-02-23 13:27:54 -05:00
downward-api run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
environment-guide Add boilerplate checks for Dockerfiles 2016-02-03 18:35:26 -05:00
horizontal-pod-autoscaling Fix hpa-php-apache.yaml. 2016-02-26 15:05:28 -05:00
kubectl Merge pull request #21265 from stevekuznetsov/skuznets/new-sa 2016-03-01 01:14:06 -08:00
liveness Add httpHeaders to httpGet liveness probe 2016-02-05 11:20:04 -05:00
logging-demo Add boilerplate checks for Makefiles 2016-02-03 18:35:26 -05:00
node-selection Update user guide and scheduler documentation to describe node affinity. 2016-02-18 17:09:41 -08:00
persistent-volumes Remove all instances of "/tmp" from unit tests and replace with a common 2016-01-27 16:11:22 -08:00
replicaset Allow replica set to be exposed as a service and add kubectl command tests for replica sets. 2016-02-10 16:20:08 -08:00
resourcequota run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
secrets Add ability to consume secrets in env vars 2016-01-18 12:20:51 -05:00
update-demo Add boilerplate checks for Dockerfiles 2016-02-03 18:35:26 -05:00
walkthrough Spelling fixes inspired by github.com/client9/misspell 2016-02-18 06:58:05 +07:00
README.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
accessing-the-cluster.md Docs for service account token namespace 2016-02-16 00:15:20 -05:00
annotations.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
application-troubleshooting.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
cadvisor.png Move diagrams out of top-level docs/ directory and merge 2015-07-14 23:56:51 -07:00
compute-resources.md Remove accidental cruft from compute-resources.md document. 2016-01-13 11:52:01 -08:00
config-best-practices.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
configmap.md Add ConfigMap docs 2016-02-23 13:27:54 -05:00
configuring-containers.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
connecting-applications.md Add docs for AWS LoadBalancers: use kubectl describe 2016-02-12 10:07:11 -05:00
connecting-to-applications-port-forward.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
connecting-to-applications-proxy.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
container-environment.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
containers.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
debugging-services.md Change iptables fwmark to use single configurable bit instead of whole mark space 2016-02-08 11:12:09 +00:00
deploying-applications.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
deployment.yaml Move deployment example to docs/user-guide 2016-02-10 10:46:12 -08:00
deployments.md Add link in deployments doc to container probes 2016-02-26 18:23:32 -08:00
docker-cli-to-kubectl.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
downward-api.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
gcm.png Move diagrams out of top-level docs/ directory and merge 2015-07-14 23:56:51 -07:00
getting-into-containers.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
horizontal-pod-autoscaler.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
horizontal-pod-autoscaler.png Added user guide for horizontal pod autoscaler. 2015-10-26 10:26:32 +01:00
horizontal-pod-autoscaler.svg Added user guide for horizontal pod autoscaler. 2015-10-26 10:26:32 +01:00
identifiers.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
images.md Improvements to ImagePullSecrets section of the images.md doc. 2016-02-29 15:05:09 -08:00
influx.png move user docs to their new home 2015-07-14 10:26:36 -07:00
ingress.md Spelling fixes inspired by github.com/client9/misspell 2016-02-18 06:58:05 +07:00
ingress.yaml Ingress docs 2015-10-22 19:09:50 -07:00
introspection-and-debugging.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
job.yaml Update docs and examples to batch/v1 Job 2016-02-25 09:28:07 -08:00
jobs.md Update docs and examples to batch/v1 Job 2016-02-25 09:28:07 -08:00
jsonpath.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
kibana.png move user docs to their new home 2015-07-14 10:26:36 -07:00
known-issues.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
kubeconfig-file.md explain kubeconfig path loading rules 2016-02-01 13:34:05 -05:00
kubectl-cheatsheet.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
kubectl-overview.md Spelling fixes inspired by github.com/client9/misspell 2016-02-18 06:58:05 +07:00
labels.md Corrected hyperlinks to other docs 2016-02-29 15:51:34 -06:00
logging.md Fix missing doc links 2016-02-24 16:06:59 +08:00
managing-deployments.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
monitoring-architecture.png move user docs to their new home 2015-07-14 10:26:36 -07:00
monitoring.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
multi-pod.yaml move user docs to their new home 2015-07-14 10:26:36 -07:00
namespaces.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
new-nginx-deployment.yaml Adding a user-guide doc for deployments 2015-10-28 13:14:08 -07:00
nginx-deployment.yaml Adding a user-guide doc for deployments 2015-10-28 13:14:08 -07:00
overview.md docs: replace Rocket with rkt 2016-02-09 13:52:25 +01:00
persistent-volumes.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
pod-states.md remove incomplete thought 2016-02-15 21:09:32 -05:00
pod-templates.md Update replication-controller docs 2016-02-08 15:51:53 -08:00
pod.yaml Use example syncer tags instead of hard-coded examples in doc 2015-07-27 14:48:41 -07:00
pods.md Merge pull request #18047 from caesarxuchao/munger-tag-new 2015-12-22 10:35:20 -08:00
prereqs.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
production-pods.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
quick-start.md Add docs for AWS LoadBalancers: use kubectl describe 2016-02-12 10:07:11 -05:00
replication-controller.md Spelling fixes inspired by github.com/client9/misspell 2016-02-18 06:58:05 +07:00
replication.yaml Update replication-controller docs 2016-02-08 15:51:53 -08:00
secrets.md Streamline secret docs and add env var doc 2016-02-07 15:52:43 -05:00
security-context.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
service-accounts.md Docs for service account token namespace 2016-02-16 00:15:20 -05:00
services-firewalls.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
services-iptables-overview.png Enable iptables kube-proxy by default in master 2015-11-13 18:38:01 -08:00
services-iptables-overview.svg Enable iptables kube-proxy by default in master 2015-11-13 18:38:01 -08:00
services-userspace-overview.png Enable iptables kube-proxy by default in master 2015-11-13 18:38:01 -08:00
services-userspace-overview.svg Enable iptables kube-proxy by default in master 2015-11-13 18:38:01 -08:00
services.md Change uppercase IP property to ip 2016-02-09 11:55:04 +01:00
sharing-clusters.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
simple-nginx.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
simple-yaml.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08:00
ui-dashboard-deploy-more.png Set kubernetes-dashboard as the default UI addon 2016-02-05 13:36:37 +01:00
ui-dashboard-deploy-simple.png Set kubernetes-dashboard as the default UI addon 2016-02-05 13:36:37 +01:00
ui-dashboard-rcs-detail.png Set kubernetes-dashboard as the default UI addon 2016-02-05 13:36:37 +01:00
ui-dashboard-rcs.png Set kubernetes-dashboard as the default UI addon 2016-02-05 13:36:37 +01:00
ui-dashboard-zerostate.png Set kubernetes-dashboard as the default UI addon 2016-02-05 13:36:37 +01:00
ui.md Tidied the documentation for the Dashboard UI 2016-02-08 17:57:18 +00:00
volumes.md fix another mistake 2016-02-16 16:55:30 +00:00
working-with-resources.md run hack/update-generated-docs.sh 2015-12-21 10:41:30 -08: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 release of this document can be found [here](http://releases.k8s.io/release-1.1/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