github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/docs
History
Nikhil Jindal 4805aecff8 Merge pull request #5197 from erictune/coreos_fix_proxy 
Kube-proxy to use apiserver instead of etcd in CoreOS getting-started-guide.
 		2015-03-10 10:55:37 -07:00
..
design simple typo 2015-03-08 15:38:21 +00:00
devel Add a doc on making PRs easier to review 2015-03-10 06:25:40 -07:00
getting-started-guides Merge pull request #5197 from erictune/coreos_fix_proxy 2015-03-10 10:55:37 -07:00
man Fix typos in docs/man/README.md 2015-03-06 14:01:26 -08:00
proposals auto-scaler proposal 2015-03-04 08:53:18 -05:00
README.md Add cluster management doc 2015-03-04 13:47:49 -08:00
accessing-the-cluster.md Add documentation for redirect 2015-03-04 17:03:18 -08:00
accessing_the_api.md Update ports doc. 2015-02-13 09:18:40 -08:00
annotations.md Label documentation improvements. Add annotations documentation. 2014-10-15 22:38:00 +00:00
api-conventions.md Clarify documentation around resourceVersion 2015-03-05 20:57:22 -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 simple typo 2015-03-09 13:38:41 +00:00
cli-roadmap.md First draft of CLI/config roadmap. 2015-01-22 18:18:46 +00:00
client-libraries.md add kubeclient to list of ruby client libraries 2015-03-02 17:43:01 +02:00
cluster_management.md Add cluster management doc 2015-03-04 13:47:49 -08: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 update images doc to talk about GCR 2015-02-15 10:29:31 -08:00
kibana.png Launch Elasticsearch and Kibana automatically 2015-01-09 13:41:46 -08:00
kubeconfig-file.md Add documentation on legacy kubernetes_auth file to kubeconfig-file.md 2015-03-05 09:33:37 -08:00
kubectl-clusterinfo.md Added new command clusterinfo to kubectl 2015-03-03 20:14:24 +01:00
kubectl-config-set-cluster.md Simplify generating kubeconfig with embeded cert data 2015-03-03 12:18:07 -08:00
kubectl-config-set-context.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-config-set-credentials.md Simplify generating kubeconfig with embeded cert data 2015-03-03 12:18:07 -08:00
kubectl-config-set.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-config-unset.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-config-use-context.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-config-view.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-config.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-create.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-delete.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-describe.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-exec.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-expose.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-get.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-label.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-log.md Prompt the user to select a container if they don't provide one 2015-02-24 06:50:22 -08:00
kubectl-namespace.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-port-forward.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-proxy.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-resize.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-rollingupdate.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-run-container.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-stop.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-update.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl-version.md Generate new docs with the new changes 2015-02-20 16:41:31 -05:00
kubectl.md Added new command clusterinfo to kubectl 2015-03-03 20:14:24 +01:00
labels.md Clarify the documentation on label selectors. 2015-03-04 15:19:43 -08:00
logging.md Update cluster level docs for proxy access 2015-03-02 16:14:03 -08:00
namespaces.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
networking.md Add a better networking doc 2015-03-06 16:48:56 -08:00
node.md Make periodic sync nodes from cloud provider optional. 2015-02-09 13:42:44 -08:00
overview.md Respond to review comments 2015-03-05 00:34:33 -08: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 docs/pods: update to address comments 2015-02-21 14:03:55 -08:00
replication-controller.md minor typo/spelling correction 2015-02-03 00:41:42 -08:00
resources.md docs: fix ior to or 2015-03-03 14:17:42 -08:00
roadmap.md Update roadmap.md 2015-02-17 23:09:45 -08:00
salt.md Typo fix 2014-11-23 02:31:40 +01:00
services.md Better docs for Services and public IPs. 2015-03-04 22:13:57 -08:00
services_detail.png Better docs for Services and public IPs. 2015-03-04 22:13:57 -08:00
services_detail.svg Better docs for Services and public IPs. 2015-03-04 22:13:57 -08:00
services_overview.png Better docs for Services and public IPs. 2015-03-04 22:13:57 -08:00
services_overview.svg Better docs for Services and public IPs. 2015-03-04 22:13:57 -08:00
ui.md Fix the command in ui.md 2015-02-19 11:37:03 -08: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/.

Frequently asked questions are answered on this project's wiki.

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.

  • Cluster Management (cluster_management.md): Starting and upgrading clusters.

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.