k3s/docs/user-guide
Tim Hockin 1098ad83a1 Fix console syntax for highligting 2015-07-19 20:56:30 -07:00
..
downward-api Replace ``` with ` when emphasizing something inline in docs/ 2015-07-19 09:05:17 +00:00
environment-guide Better scary message 2015-07-17 09:28:49 -07:00
kubectl Run gendocs 2015-07-17 15:35:43 -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 Run gendocs 2015-07-17 15:35:43 -07:00
namespaces Improve markdown highlighting in namespaces user guide. 2015-07-19 03:54:28 +00:00
node-selection Run gendocs 2015-07-17 15:35:43 -07:00
persistent-volumes Replace ``` with ` when emphasizing something inline in docs/ 2015-07-19 09:05:17 +00:00
resourcequota Improve console output in resource quota doc. 2015-07-19 03:54:21 +00:00
secrets Replace ``` with ` when emphasizing something inline in docs/ 2015-07-19 09:05:17 +00:00
update-demo Improve console output in update demo. 2015-07-19 03:54:17 +00:00
walkthrough Improve console output in k8s201 walkthrough. 2015-07-18 18:31:22 -07:00
README.md Merge pull request #11452 from thockin/docs-munge-headerlines 2015-07-17 15:52:08 -07:00
accessing-the-cluster.md Fix namespace change and console output for accessing the cluster docs 2015-07-18 23:24:35 +01:00
annotations.md Fix JSON code block formatting for annotations doc 2015-07-18 23:27:58 +01:00
application-troubleshooting.md Replace ``` with ` when emphasizing something inline in docs/ 2015-07-19 09:05:17 +00:00
cadvisor.png Move diagrams out of top-level docs/ directory and merge 2015-07-14 23:56:51 -07:00
compute-resources.md Fix broken table of contents sections. 2015-07-18 22:18:55 -07:00
config-best-practices.md add tip to store all config in VCS before pushing to cluster 2015-07-17 17:04:40 -07:00
configuring-containers.md Fix console output formatting for configuring containers doc 2015-07-18 23:38:35 +01:00
connecting-applications.md Fix console output formatting in conneting applications documentation 2015-07-18 23:45:35 +01:00
connecting-to-applications-port-forward.md Fix doc formatting in connecting to app port forwarding 2015-07-18 23:49:38 +01:00
connecting-to-applications-proxy.md Fix console output formatting for connecting to apps via proxy doc 2015-07-18 23:52:41 +01:00
container-environment.md Replace ``` with ` when emphasizing something inline in docs/ 2015-07-19 09:05:17 +00:00
containers.md Run gendocs 2015-07-17 15:35:43 -07:00
debugging-services.md Fix console syntax for highligting 2015-07-19 20:56:30 -07:00
deploying-applications.md Fix console output for deploying applications 2015-07-19 00:01:31 +01:00
docker-cli-to-kubectl.md Fix formatting for docker-cli-to-kubectl doc 2015-07-19 00:07:35 +01:00
downward-api.md Run gendocs 2015-07-17 15:35:43 -07: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 Fix output formatting for Getting Into Containers doc 2015-07-19 00:13:42 +01:00
identifiers.md Run gendocs 2015-07-17 15:35:43 -07:00
images.md Fix console output formatting for images doc 2015-07-19 00:18:12 +01:00
influx.png move user docs to their new home 2015-07-14 10:26:36 -07:00
introspection-and-debugging.md Replace ``` with ` when emphasizing something inline in docs/ 2015-07-19 09:05:17 +00: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
kubeconfig-file.md Fix formatting for kubeconfig file documentation 2015-07-19 00:29:49 +01:00
labels.md Replace ``` with ` when emphasizing something inline in docs/ 2015-07-19 09:05:17 +00:00
logging.md Fix console outout of logging doc 2015-07-19 00:48:49 +01:00
managing-deployments.md Fix console formatting of managing deployments doc 2015-07-19 00:56:02 +01:00
monitoring-architecture.png move user docs to their new home 2015-07-14 10:26:36 -07:00
monitoring.md Run gendocs 2015-07-17 15:35:43 -07:00
multi-pod.yaml move user docs to their new home 2015-07-14 10:26:36 -07:00
namespaces.md Replace ``` with ` when emphasizing something inline in docs/ 2015-07-19 09:05:17 +00:00
overview.md Gut stale roadmaps. Move useful content elsewhere. 2015-07-18 00:41:06 +00:00
persistent-volumes.md Add YAML formatting to persisent volumes doc 2015-07-19 01:05:32 +01:00
pod-states.md Run gendocs 2015-07-17 15:35:43 -07:00
pod.yaml move user docs to their new home 2015-07-14 10:26:36 -07:00
pods.md Run gendocs 2015-07-17 15:35:43 -07:00
prereqs.md Fix console output for prereqs.md doc 2015-07-19 01:10:34 +01:00
production-pods.md Fix console output in production-pods.md 2015-07-19 01:15:02 +01:00
quick-start.md Fix console output in quick-start.md 2015-07-19 01:18:40 +01:00
replication-controller.md Merge pull request #11452 from thockin/docs-munge-headerlines 2015-07-17 15:52:08 -07:00
replication.yaml move user docs to their new home 2015-07-14 10:26:36 -07:00
secrets.md Improve console output in secrets.md 2015-07-19 01:23:08 +01:00
security-context.md Run gendocs 2015-07-17 15:35:43 -07:00
service-accounts.md Improve console outout formatting in service-accounts.md 2015-07-19 01:34:49 +01:00
services-detail.png move user docs to their new home 2015-07-14 10:26:36 -07:00
services-detail.svg move user docs to their new home 2015-07-14 10:26:36 -07:00
services-firewalls.md Replace ``` with ` when emphasizing something inline in docs/ 2015-07-19 09:05:17 +00:00
services-overview.png move user docs to their new home 2015-07-14 10:26:36 -07:00
services-overview.svg move user docs to their new home 2015-07-14 10:26:36 -07:00
services.md Fix console output of services documents 2015-07-19 01:38:40 +01:00
sharing-clusters.md Improve console output in sharing-clusters.md doc 2015-07-19 01:50:12 +01:00
simple-nginx.md Run gendocs 2015-07-17 15:35:43 -07:00
simple-yaml.md Replace ``` with ` when emphasizing something inline in docs/ 2015-07-19 09:05:17 +00:00
ui.md Run gendocs 2015-07-17 15:35:43 -07:00
volumes.md Replace ``` with ` when emphasizing something inline in docs/ 2015-07-19 09:05:17 +00:00
working-with-resources.md Improve console output of working-with-resources.md 2015-07-19 01:55:04 +01: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