k3s/docs
Brian Grant 6b24c518fb Merge pull request #3675 from hTrap/patch-3
typo in capitalisation
2015-01-21 10:36:49 -08:00
..
design Clarify name must be lowercase in docs, to match code 2015-01-20 13:55:17 -05:00
devel Merge pull request #3616 from hTrap/patch-1 2015-01-21 07:14:56 -08:00
getting-started-guides Fixed missing standalone.yaml fix to Docker overlay driver. Refs #3625. 2015-01-20 19:50:15 +00:00
man Fix up for posix flags 2015-01-15 09:12:19 -08:00
README.md Broken link in docs/README.md 2015-01-21 01:23:59 +00:00
accessing_the_api.md typo in capitalisation 2015-01-21 21:14:16 +05:30
annotations.md Label documentation improvements. Add annotations documentation. 2014-10-15 22:38:00 +00:00
api-conventions.md typo fixed 2015-01-21 21:36:43 +05:30
architecture.dia First take at architecture diagram. 2014-07-16 14:06:07 -07:00
architecture.png First take at architecture diagram. 2014-07-16 14:06:07 -07:00
architecture.svg First take at architecture diagram. 2014-07-16 14:06:07 -07:00
authentication.md Doc fixes 2015-01-11 21:20:49 -05:00
authorization.md typo in authorization.md 2014-12-16 09:21:09 -05:00
cli.md Autogenerate markdown docs for kubectl 2015-01-14 13:21:14 -08:00
client-libraries.md added php client library reference 2014-11-17 16:44:36 +00:00
container-environment.md Documentation improvements. Fixes #2004, #2115, #2171. 2014-11-17 21:32:44 +00:00
dns.md Update DNS doc 2015-01-17 19:42:09 -08:00
glossary.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
identifiers.md Clarify name must be lowercase in docs, to match code 2015-01-20 13:55:17 -05:00
images.md Document images. 2014-10-09 13:40:56 -07:00
kibana.png Launch Elasticsearch and Kibana automatically 2015-01-09 13:41:46 -08:00
kubeconfig-file.md add kubectl config 2015-01-13 16:19:57 -05:00
kubectl.md Fix typos in kubectl docs, via gendocs 2015-01-18 02:20:00 -06:00
labels.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
logging.md Launch Elasticsearch and Kibana automatically 2015-01-09 13:41:46 -08:00
namespaces.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
networking.md Fix grammar 2014-11-09 22:12:55 -05:00
node.md fixed resources field 2014-12-10 23:04:33 -08:00
overview.md remove .md from annotations link text 2015-01-18 09:15:15 -06:00
ovs-networking.md ovs networking document 2014-09-08 17:06:25 -07:00
ovs-networking.png ovs networking document 2014-09-08 17:06:25 -07:00
pod-states.md Add a doc on pod states 2014-09-23 08:40:17 -07:00
pods.md Documentation improvements. Fixes #2004, #2115, #2171. 2014-11-17 21:32:44 +00:00
replication-controller.md Add documentation of replication controller. 2014-10-01 23:22:10 +00:00
resources.md Document that the resource model has not yet been implemented. 2014-12-01 18:07:25 +00:00
roadmap.md Start to incorporate reliability work items into roadmap 2015-01-05 13:59:08 -08:00
salt.md Typo fix 2014-11-23 02:31:40 +01:00
services.md Clarify format of service environment variables. Fixes #1936. 2014-11-24 18:01:56 +00:00
services_detail.png Add and update docs. 2014-10-16 08:36:47 -07:00
services_detail.svg Add and update docs. 2014-10-16 08:36:47 -07:00
services_overview.png Add and update docs. 2014-10-16 08:36:47 -07:00
services_overview.svg Add and update docs. 2014-10-16 08:36:47 -07:00
ui.md Use UI instead of UX 2015-01-13 11:49:40 -08:00
volumes.md Remove a duplicate 'its' 2015-01-14 15:42:11 +01:00

README.md

Kubernetes Documentation

Getting started guides are in getting-started-guides.

There are example files and walkthroughs in the examples folder.

If you're developing Kubernetes, docs are in the devel folder.

Design docs are in design.

Primary concepts

  • Overview (overview.md): A brief overview of Kubernetes concepts.

  • Nodes (node.md): A node is a worker machine in Kubernetes.

  • Pods (pods.md): A pod is a tightly-coupled group of containers with shared volumes.

  • The Life of a Pod (pod-states.md): Covers the intersection of pod states, the PodStatus type, the life-cycle of a pod, events, restart policies, and replication controllers.

  • Replication Controllers (replication-controller.md): A replication controller ensures that a specified number of pod "replicas" are running at any one time.

  • Services (services.md): A Kubernetes service is an abstraction which defines a logical set of pods and a policy by which to access them.

  • Volumes (volumes.md): A Volume is a directory, possibly with some data in it, which is accessible to a Container.

  • Labels (labels.md): Labels are key/value pairs that are attached to objects, such as pods. Labels can be used to organize and to select subsets of objects.

  • Accessing the API (accessing_the_api.md): Ports, IPs, proxies, and firewall rules.

  • Kubernetes Web Interface (ui.md): Accessing the Kubernetes web user interface.

  • Kubecfg Command Line Interface (cli.md): The kubecfg command line reference.

  • Roadmap (roadmap.md): The set of supported use cases, features, docs, and patterns that are required before Kubernetes 1.0.

  • Glossary (glossary.md): Terms and concepts.

Further reading

  • Annotations (annotations.md): Attaching arbitrary non-identifying metadata.

  • API Conventions (api-conventions.md): Defining the verbs and resources used in the Kubernetes API.

  • Authentication Plugins (authentication.md): The current and planned states of authentication tokens.

  • Authorization Plugins (authorization.md): Authorization applies to all HTTP requests on the main apiserver port. This doc explains the available authorization implementations.

  • API Client Libraries (client-libraries.md): A list of existing client libraries, both supported and user-contributed.

  • Kubernetes Container Environment (container-environment.md): Describes the environment for Kubelet managed containers on a Kubernetes node.

  • DNS Integration with SkyDNS (dns.md): Resolving a DNS name directly to a Kubernetes service.

  • Identifiers (identifiers.md): Names and UIDs explained.

  • Images (images.md): Information about container images and private registries.

  • Logging (logging.md): Pointers to logging info.

  • Namespaces (namespaces.md): Namespaces help different projects, teams, or customers to share a kubernetes cluster.

  • Networking (networking.md): Pod networking overview.

  • OpenVSwitch GRE/VxLAN networking (ovs-networking.md): Using OpenVSwitch to set up networking between pods across Kubernetes nodes.

  • The Kubernetes Resource Model (resources.md): Provides resource information such as size, type, and quantity to assist in assigning Kubernetes resources appropriately.

  • Using Salt to configure Kubernetes (salt.md): The Kubernetes cluster can be configured using Salt.