k3s/docs/user-guide
k8s-merge-robot dcf58fe50c Merge pull request #16015 from feihujiang/fixMinorErrorsInNfsExample
Auto commit by PR queue bot
2015-10-22 11:41:41 -07:00
..
downward-api adding downward api volume plugin 2015-09-01 22:23:03 +02:00
environment-guide Copy edits for typos (resubmitted) 2015-08-25 10:47:58 -04:00
kubectl Merge pull request #15921 from brendandburns/fix2 2015-10-21 13:17:26 -07:00
liveness Delete an useless line in liveness 2015-09-06 18:54:23 +08:00
logging-demo Run gendocs 2015-07-17 15:35:43 -07:00
node-selection s|github.com/GoogleCloudPlatform/kubernetes|github.com/kubernetes/kubernetes| 2015-09-03 10:10:11 -04:00
persistent-volumes Replace IRC with Slack in docs. 2015-09-08 15:17:39 -07:00
resourcequota Provide a redirect to new resource quota location 2015-09-11 12:12:32 -04:00
secrets Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
update-demo Change deprecated 'kubectl stop' to 'delete' 2015-08-31 18:04:04 -07:00
walkthrough fixed incorrect service name 2015-10-11 20:32:41 -07:00
README.md Fix capitalization of Kubernetes in the documentation. 2015-07-20 14:39:36 -07:00
accessing-the-cluster.md Fix typo 2015-10-15 18:37:29 +08:00
annotations.md Fix JSON code block formatting for annotations doc 2015-07-18 23:27:58 +01:00
application-troubleshooting.md s|github.com/GoogleCloudPlatform/kubernetes|github.com/kubernetes/kubernetes| 2015-09-03 10:10:11 -04:00
cadvisor.png Move diagrams out of top-level docs/ directory and merge 2015-07-14 23:56:51 -07:00
compute-resources.md Replace limits with request where appropriate 2015-09-09 15:38:34 +08:00
config-best-practices.md rewrite all links to issues to k8s links 2015-08-05 21:11:11 -07:00
configuring-containers.md s|github.com/GoogleCloudPlatform/kubernetes|github.com/kubernetes/kubernetes| 2015-09-03 10:10:11 -04:00
connecting-applications.md s|github.com/GoogleCloudPlatform/kubernetes|github.com/kubernetes/kubernetes| 2015-09-03 10:10:11 -04:00
connecting-to-applications-port-forward.md Change port-forward example without -p 2015-08-25 16:55:49 +08: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 Update container-environment.md. Fixes #14127. 2015-10-10 14:32:00 +00:00
containers.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
debugging-services.md Replace IRC with Slack in docs. 2015-09-08 15:17:39 -07:00
deploying-applications.md s|github.com/GoogleCloudPlatform/kubernetes|github.com/kubernetes/kubernetes| 2015-09-03 10:10:11 -04:00
docker-cli-to-kubectl.md Fix minor errors in docker-cli-to-kubectl document 2015-09-28 11:26:39 +08:00
downward-api.md add raw flag for GitHub download links 2015-09-07 17:43:09 -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 fixed a markdown error in the title 2015-09-08 08:41:50 +00:00
identifiers.md Run gendocs 2015-07-17 15:35:43 -07:00
images.md Document describe fix 2015-09-11 22:42:45 +08:00
influx.png move user docs to their new home 2015-07-14 10:26:36 -07:00
introspection-and-debugging.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
job.yaml fix examples 2015-10-09 15:58:07 -07:00
jobs.md Doc: apigroups, alpha, beta, experimental/v1alpha1 2015-10-14 09:06:05 -07:00
jsonpath.md jsonpath user guide docs 2015-08-20 09:11:04 +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 rewrite all links to issues to k8s links 2015-08-05 21:11:11 -07:00
kubeconfig-file.md Added some clarity to kubeconfig around tokens and how it corresponds to 2015-09-17 16:18:37 -04:00
kubectl-overview.md add ingress 2015-10-04 11:47:01 +08:00
labels.md Add DoesNotExist label operator. 2015-10-13 20:13:19 +00:00
logging.md fix the dead link of logging.md 2015-09-16 15:49:36 +00:00
managing-deployments.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
monitoring-architecture.png move user docs to their new home 2015-07-14 10:26:36 -07:00
monitoring.md Replace IRC with Slack in docs. 2015-09-08 15:17:39 -07:00
multi-pod.yaml move user docs to their new home 2015-07-14 10:26:36 -07:00
namespaces.md Add 'svc.' before 'cluster.local' and fix some typos 2015-09-07 09:11:30 +00:00
overview.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
persistent-volumes.md Added volume.Deleter interface and simple HostPath implementation 2015-09-17 12:08:58 -04:00
pod-states.md Job and DaemonSet documentation. 2015-09-24 17:51:25 -07:00
pod.yaml Use example syncer tags instead of hard-coded examples in doc 2015-07-27 14:48:41 -07:00
pods.md Update container-environment.md. Fixes #14127. 2015-10-10 14:32:00 +00:00
prereqs.md s|github.com/GoogleCloudPlatform/kubernetes|github.com/kubernetes/kubernetes| 2015-09-03 10:10:11 -04:00
production-pods.md Merge pull request #12747 from smarterclayton/pending_deletion_docs 2015-09-21 19:49:00 -07:00
quick-start.md Fix the service printer to be a single line per service 2015-08-10 10:57:45 -07:00
replication-controller.md Edit to clarify rc's are for homogenous pods 2015-10-09 15:24:03 -07:00
replication.yaml move user docs to their new home 2015-07-14 10:26:36 -07:00
secrets.md Fix wording in secrets doc. 2015-09-28 11:34:15 -07:00
security-context.md Run gendocs 2015-07-17 15:35:43 -07:00
service-accounts.md Fixed some minor typos 2015-09-13 09:59:41 +00: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 Fix typo in services-firewall user guide. 2015-08-20 23:44:41 -07: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 update service&endpoint describe 2015-09-28 23:55:08 -04:00
sharing-clusters.md Fixed some typos in sharing-clusters.md 2015-09-16 20:53:05 +08:00
simple-nginx.md Run gendocs 2015-07-17 15:35:43 -07:00
simple-yaml.md add raw flag for GitHub download links 2015-09-07 17:43:09 -07:00
ui.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
volumes.md Merge pull request #16015 from feihujiang/fixMinorErrorsInNfsExample 2015-10-22 11:41:41 -07:00
working-with-resources.md Fix #15609 2015-10-21 18:36:10 +00: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