github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/docs
History
Eric Paris 9e9fb9457f automatically generate man pages for kubectl 
generate man pages for kubectl using the cobra.Command information.
This will directly create files in (by default) docs/man/man1/ called
kubectl*.1.  Each child verb/cobra command will gets its own man page.
 		2015-02-12 19:08:52 -05:00
..
design Fix the broken links in the labels and access design docs. 2015-02-03 23:02:21 +00:00
devel Fix bad config in flaky test documentation and add script to help check 2015-02-11 12:28:34 -08:00
getting-started-guides locally.md: update the docker version requirement to 1.3 2015-02-12 14:05:26 -08:00
man automatically generate man pages for kubectl 2015-02-12 19:08:52 -05:00
README.md Adding links to http://kubernetes.io/third_party/swagger-ui/ in our docs 2015-02-03 12:21:16 -08: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 Adding links to http://kubernetes.io/third_party/swagger-ui/ in our docs 2015-02-03 12:21:16 -08:00
architecture.dia Update architecture diagram/png/svg to name 'kubectl' as client. 2015-01-26 11:35:53 -08:00
architecture.png Update architecture diagram/png/svg to name 'kubectl' as client. 2015-01-26 11:35:53 -08:00
architecture.svg Update architecture diagram/png/svg to name 'kubectl' as client. 2015-01-26 11:35:53 -08:00
authentication.md Doc fixes 2015-01-11 21:20:49 -05:00
authorization.md modify policy to correctly identify resource versus kind 2015-02-04 13:36:01 -05:00
availability.md Fix. 2015-01-21 13:28:35 -08:00
cli-roadmap.md First draft of CLI/config roadmap. 2015-01-22 18:18:46 +00:00
client-libraries.md added php client library reference 2014-11-17 16:44:36 +00:00
container-environment.md Update docs to reflect reality. 2015-02-02 16:34:20 -08:00
containers.md Add docker's add/drop capabilites 2015-01-30 15:09:31 +08:00
dns.md Fix link to the dns addon readme 2015-01-24 00:16:36 -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 Change PullPolicy constants to match 2015-01-21 12:48:56 -08: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 automatically generate man pages for kubectl 2015-02-12 19:08:52 -05:00
labels.md Add a few extra test cases for API validation of labels that would have 2015-02-04 22:24:46 +00: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 Make periodic sync nodes from cloud provider optional. 2015-02-09 13:42:44 -08:00
overview.md Update docs to refer to kubectl rather than kubecfg. Remove cli.md. 2015-01-22 18:58:04 +00: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 minor typo/spelling correction 2015-02-03 00:41:42 -08:00
resources.md docs: resources: minor spelling fix otr to or 2015-02-10 20:02:22 -08:00
roadmap.md Fix roadmap doc 2015-01-31 20:53:27 +01:00
salt.md Typo fix 2014-11-23 02:31:40 +01:00
services.md Refine services doc 2015-02-02 23:16:37 +01: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 Update docs to refer to kubectl rather than kubecfg. Remove cli.md. 2015-01-22 18:58:04 +00:00
volumes.md Now that we automatically format GCE PD, remove formatting from the e2e test. 2015-02-06 20:30:58 -08: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.

API objects are explained at http://kubernetes.io/third_party/swagger-ui/.

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.

  • Kubectl Command Line Interface (kubectl.md): The kubectl 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.