History

Eric Paris 3b7c39656c Split hack/{verify,update}-* files so we don't always go build Right now some of the hack/* tools use `go run` and build almost every time. There are some which expect you to have already run `go install`. And in all cases the pre-commit hook, which runs a full build wouldn't want to do either, since it just built! This creates a new hack/after-build/ directory and has the scripts which REQUIRE that the binary already be built. It doesn't test and complain. It just fails miserably. Users should not be in this directory. Users should just use hack/verify-* which will just do the build and then call the "after-build" version. The pre-commit hook or anything which KNOWS the binaries have been built can use the fast version.		2015-08-11 14:20:46 -04:00
..
admin	Merge pull request #12441 from vlajos/typofixes-vlajos-20150807	2015-08-10 16:33:52 +02:00
api-reference	typofix - https://github.com/vlajos/misspell_fixer	2015-08-08 22:31:48 +01:00
design	Fix the architecture diagram such that the arrow from the api server to the node doesn't go through/under etcd	2015-08-07 00:13:15 -07:00
devel	Split hack/{verify,update}-* files so we don't always go build	2015-08-11 14:20:46 -04:00
getting-started-guides	Merge pull request #12441 from vlajos/typofixes-vlajos-20150807	2015-08-10 16:33:52 +02:00
man/man1	Merge pull request #12421 from jlowdermilk/replace-help-text	2015-08-10 16:34:17 +02:00
proposals	Copy edits for typos	2015-08-09 14:18:06 -04:00
user-guide	Merge pull request #12421 from jlowdermilk/replace-help-text	2015-08-10 16:34:17 +02:00
api.md	Fix trailing whitespace in all docs	2015-07-30 20:41:30 -04:00
README.md	Vulnerability reporting doc.	2015-07-23 16:15:04 -07:00
reporting-security-issues.md	Fix trailing whitespace in all docs	2015-07-30 20:41:30 -04:00
roadmap.md	Gut stale roadmaps. Move useful content elsewhere.	2015-07-18 00:41:06 +00:00
troubleshooting.md	Add a known issues doc.	2015-07-20 17:28:20 -07:00
warning.png	Add an image to unversioned warnings	2015-07-14 15:28:59 -07:00
whatisk8s.md	Copy edits for typos	2015-08-09 14:18:06 -04:00

README.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 1.0.x release of this document can be found [here](http://releases.k8s.io/release-1.0/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.