Skip to content

Files

Failed to load latest commit information.

Latest commit

 Cannot retrieve latest commit at this time.

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
design
design
 
 
devel
devel
 
 
getting-started-guides
getting-started-guides
 
 
man
man
 
 
README.md
README.md
 
 
accessing_the_api.md
accessing_the_api.md
 
 
annotations.md
annotations.md
 
 
api-conventions.md
api-conventions.md
 
 
architecture.dia
architecture.dia
 
 
architecture.png
architecture.png
 
 
architecture.svg
architecture.svg
 
 
authentication.md
authentication.md
 
 
authorization.md
authorization.md
 
 
cli.md
cli.md
 
 
client-libraries.md
client-libraries.md
 
 
container-environment.md
container-environment.md
 
 
dns.md
dns.md
 
 
glossary.md
glossary.md
 
 
identifiers.md
identifiers.md
 
 
images.md
images.md
 
 
labels.md
labels.md
 
 
logging.md
logging.md
 
 
namespaces.md
namespaces.md
 
 
networking.md
networking.md
 
 
node.md
node.md
 
 
overview.md
overview.md
 
 
ovs-networking.md
ovs-networking.md
 
 
ovs-networking.png
ovs-networking.png
 
 
pod-states.md
pod-states.md
 
 
pods.md
pods.md
 
 
replication-controller.md
replication-controller.md
 
 
resources.md
resources.md
 
 
roadmap.md
roadmap.md
 
 
salt.md
salt.md
 
 
services.md
services.md
 
 
services_detail.png
services_detail.png
 
 
services_detail.svg
services_detail.svg
 
 
services_overview.png
services_overview.png
 
 
services_overview.svg
services_overview.svg
 
 
ux.md
ux.md
 
 
volumes.md
volumes.md
 
 

README.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
  • Wiki