k3s/docs/user-guide
k8s-merge-robot ae2fbc6daf Merge pull request #18777 from erictune/image-doc-fix
Auto commit by PR queue bot
2015-12-18 10:37:19 -08:00
..
downward-api Run update-gendocs 2015-11-13 13:57:57 -08:00
environment-guide Run update-gendocs 2015-11-13 13:57:57 -08:00
horizontal-pod-autoscaling Merge pull request #17269 from janetkuo/autoscale-deployments 2015-11-21 22:23:23 -08:00
kubectl Merge pull request #16028 from derekwaynecarr/make_cmd 2015-12-16 08:41:59 -08:00
liveness Minion->Node rename: docs/ machine names only, except gce/aws 2015-12-03 23:34:50 -08:00
logging-demo Run update-gendocs 2015-11-13 13:57:57 -08:00
node-selection Run update-gendocs 2015-11-13 13:57:57 -08:00
persistent-volumes Run update-gendocs 2015-11-13 13:57:57 -08:00
resourcequota Run update-gendocs 2015-11-13 13:57:57 -08:00
secrets Run update-gendocs 2015-11-13 13:57:57 -08:00
update-demo Run update-gendocs 2015-11-13 13:57:57 -08:00
walkthrough Run update-gendocs 2015-11-13 13:57:57 -08:00
README.md config best practices doc edits 2015-12-16 07:35:31 -08:00
accessing-the-cluster.md Run update-gendocs 2015-11-13 13:57:57 -08:00
annotations.md Run update-gendocs 2015-11-13 13:57:57 -08:00
application-troubleshooting.md Run update-gendocs 2015-11-13 13:57:57 -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 Minion->Node rename: docs/ machine names only, except gce/aws 2015-12-03 23:34:50 -08:00
config-best-practices.md config best practices doc edits 2015-12-16 07:35:31 -08:00
configuring-containers.md change HEAD to blob/HEAD, and add blob in versioned-docs.sh 2015-11-16 17:13:49 -08:00
connecting-applications.md Minion->Node rename: docs/ machine names only, except gce/aws 2015-12-03 23:34:50 -08:00
connecting-to-applications-port-forward.md Run update-gendocs 2015-11-13 13:57:57 -08:00
connecting-to-applications-proxy.md Run update-gendocs 2015-11-13 13:57:57 -08:00
container-environment.md Run update-gendocs 2015-11-13 13:57:57 -08:00
containers.md Run update-gendocs 2015-11-13 13:57:57 -08:00
debugging-services.md Merge pull request #16344 from thockin/enable-iptables-proxy 2015-11-16 09:48:38 -08:00
deploying-applications.md change HEAD to blob/HEAD, and add blob in versioned-docs.sh 2015-11-16 17:13:49 -08:00
deployments.md Implement MinReadySeconds for Deployment 2015-12-04 12:58:34 -08:00
docker-cli-to-kubectl.md Run update-gendocs 2015-11-13 13:57:57 -08:00
downward-api.md Changed wrong volume mounted path 2015-12-02 03:37:26 +00: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 update-gendocs 2015-11-13 13:57:57 -08:00
horizontal-pod-autoscaler.md Updated hpa docs. 2015-11-19 14:21:41 +01: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 update-gendocs 2015-11-13 13:57:57 -08:00
images.md Update image docs to use .docker/config.json 2015-12-17 17:28:07 -08:00
influx.png move user docs to their new home 2015-07-14 10:26:36 -07:00
ingress.md Clarify that Ingress is a beta resource. 2015-11-18 18:45:31 -08:00
ingress.yaml Ingress docs 2015-10-22 19:09:50 -07:00
introspection-and-debugging.md Minion->Node rename: docs/ machine names only, except gce/aws 2015-12-03 23:34:50 -08:00
job.yaml Update job user-guide doc to reflect recent changes to .spec.selector 2015-10-17 12:32:01 +02:00
jobs.md Document several patterns for using Job. 2015-12-10 15:54:23 -08:00
jsonpath.md quote interpreted string 2015-11-19 11:15:10 +08:00
k8s-ui-explore-filter.png move user docs to their new home 2015-07-14 10:26:36 -07:00
k8s-ui-explore-groupby.png move user docs to their new home 2015-07-14 10:26:36 -07:00
k8s-ui-explore-poddetail.png move user docs to their new home 2015-07-14 10:26:36 -07:00
k8s-ui-explore.png move user docs to their new home 2015-07-14 10:26:36 -07:00
k8s-ui-nodes.png move user docs to their new home 2015-07-14 10:26:36 -07:00
k8s-ui-overview.png move user docs to their new home 2015-07-14 10:26:36 -07:00
kibana.png move user docs to their new home 2015-07-14 10:26:36 -07:00
known-issues.md Run update-gendocs 2015-11-13 13:57:57 -08:00
kubeconfig-file.md Run update-gendocs 2015-11-13 13:57:57 -08:00
kubectl-cheatsheet.md Revert the revert of kubernetes/kubernetes#15674 2015-12-01 09:16:06 -08:00
kubectl-overview.md Merge pull request #18184 from amygdala/docs 2015-12-18 10:34:44 -08:00
labels.md Run update-gendocs 2015-11-13 13:57:57 -08:00
logging.md Run update-gendocs 2015-11-13 13:57:57 -08:00
managing-deployments.md config best practices doc edits 2015-12-16 07:35:31 -08:00
monitoring-architecture.png move user docs to their new home 2015-07-14 10:26:36 -07:00
monitoring.md Run update-gendocs 2015-11-13 13:57:57 -08:00
multi-pod.yaml move user docs to their new home 2015-07-14 10:26:36 -07:00
namespaces.md Merge pull request #17210 from johscheuer/master 2015-11-17 00:21:02 -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 Run update-gendocs 2015-11-13 13:57:57 -08:00
persistent-volumes.md Run update-gendocs 2015-11-13 13:57:57 -08:00
pod-states.md Run update-gendocs 2015-11-13 13:57:57 -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 Tidy up Pod docs a bit 2015-12-09 15:23:01 -08:00
prereqs.md Run update-gendocs 2015-11-13 13:57:57 -08:00
production-pods.md Update image docs to use .docker/config.json 2015-12-17 17:28:07 -08:00
quick-start.md Run update-gendocs 2015-11-13 13:57:57 -08:00
replication-controller.md change HEAD to blob/HEAD, and add blob in versioned-docs.sh 2015-11-16 17:13:49 -08:00
secrets.md Run update-gendocs 2015-11-13 13:57:57 -08:00
security-context.md Run update-gendocs 2015-11-13 13:57:57 -08:00
service-accounts.md Update image docs to use .docker/config.json 2015-12-17 17:28:07 -08:00
services-firewalls.md Run update-gendocs 2015-11-13 13:57:57 -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 HEAD to blob/HEAD, and add blob in versioned-docs.sh 2015-11-16 17:13:49 -08:00
sharing-clusters.md Run update-gendocs 2015-11-13 13:57:57 -08:00
simple-nginx.md Run update-gendocs 2015-11-13 13:57:57 -08:00
simple-yaml.md Run update-gendocs 2015-11-13 13:57:57 -08:00
ui.md Run update-gendocs 2015-11-13 13:57:57 -08:00
volumes.md Run update-gendocs 2015-11-13 13:57:57 -08:00
working-with-resources.md Run update-gendocs 2015-11-13 13:57:57 -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