![]() Most of the contents of docs/ has moved to kubernetes.github.io. Development of the docs and accompanying files has continued there, making the copies in this repo stale. I've removed everything but the .md files which remain to redirect old links. The .yaml config files in the docs were used by some tests, these have been moved to test/fixtures/doc-yaml, and can remain there to be used by tests or other purposes. |
||
---|---|---|
.. | ||
admin | ||
api-reference | ||
design | ||
devel | ||
getting-started-guides | ||
images | ||
man/man1 | ||
proposals | ||
user-guide | ||
yaml/kubectl | ||
api.md | ||
OWNERS | ||
README.md | ||
reporting-security-issues.md | ||
roadmap.md | ||
troubleshooting.md | ||
warning.png | ||
whatisk8s.md |
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 release of this document can be found [here](http://releases.k8s.io/release-1.3/docs/README.md).Documentation for other releases can be found at releases.k8s.io.
Kubernetes Documentation: releases.k8s.io/HEAD
-
The User's guide is for anyone who wants to run programs and services on an existing Kubernetes cluster.
-
The Cluster Admin's guide is for anyone setting up a Kubernetes cluster or administering it.
-
The Developer guide is for anyone wanting to write programs that access the Kubernetes API, write plugins or extensions, or modify the core code of Kubernetes.
-
The Kubectl Command Line Interface is a detailed reference on the
kubectl
CLI. -
The API object documentation is a detailed description of all fields found in core API objects.
-
An overview of the Design of Kubernetes
-
There are example files and walkthroughs in the examples folder.
-
If something went wrong, see the troubleshooting document for how to debug. You should also check the known issues for the release you're using.
-
To report a security issue, see Reporting a Security Issue.