kubernetes/docs
Brendan Burns 8928df79cc Merge pull request #2260 from brendandburns/Ch00k-kube-up-aws
Ch00k kube up aws - adapted by brendandburns
2014-11-10 20:57:32 -08:00
..
design Fix bad selector file link 2014-11-09 22:46:07 -05:00
devel Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
getting-started-guides Fix docs somewhat, add monitoring hooks. 2014-11-10 17:17:25 -08:00
man Fix minion_cache_ttl and minion_regexp flag change. 2014-11-02 00:36:34 -04:00
accessing_the_api.md Add a third port which has HTTPS and auth(n,z) 2014-11-10 15:16:46 -08:00
annotations.md
api-conventions.md Formatting tweaks to docs/api-conventions.md 2014-11-05 20:49:16 -08:00
architecture.dia
architecture.png
architecture.svg
authentication.md Basic ACL file. 2014-11-05 16:06:22 -08:00
authorization.md Basic ACL file. 2014-11-05 16:06:22 -08:00
cli.md
client-libraries.md
container-environment.md
dns.md rename the nd file 2014-10-16 16:37:47 -04:00
glossary.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
identifiers.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
images.md
labels.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
logging.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07: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
overview.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
ovs-networking.md
ovs-networking.png
pod-states.md
pods.md
README.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
replication-controller.md
resources.md
roadmap.md
salt.md
services.md
services_detail.png
services_detail.svg
services_overview.png
services_overview.svg
ux.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
volumes.md

Kubernetes Documentation

Kubernetes documentation is organized into several categories.

  • Getting Started Guides
  • User Documentation
    • in docs
    • for people who want to run programs on kubernetes
    • describes current features of the system (with brief mentions of planned features)
  • Developer Documentation
    • in docs/devel
    • for people who want to contribute code to kubernetes
    • covers development conventions
    • explains current architecture and project plans
  • Design Documentation
    • in docs/design
    • for people who want to understand the design choices made
    • describes tradeoffs, alternative designs
    • descriptions of planned features that are too long for a github issue.
  • Walkthroughs and Examples
    • in examples
    • Hands on introduction and example config files
  • API documentation
    • in api
    • automatically generated REST API documentation
  • Wiki