|
|
||
|---|---|---|
| .. | ||
| design | ||
| devel | ||
| getting-started-guides | ||
| man | ||
| README.md | ||
| annotations.md | ||
| api-conventions.md | ||
| architecture.dia | ||
| architecture.png | ||
| architecture.svg | ||
| cli.md | ||
| client-libraries.md | ||
| container-environment.md | ||
| dns.md | ||
| glossary.md | ||
| identifiers.md | ||
| images.md | ||
| labels.md | ||
| logging.md | ||
| namespaces.md | ||
| networking.md | ||
| overview.md | ||
| ovs-networking.md | ||
| ovs-networking.png | ||
| pod-states.md | ||
| pods.md | ||
| 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 | ||
| volumes.md | ||
README.md
Kubernetes Documentation
Kubernetes documentation is organized into several categories.
- Getting Started Guides
- for people who want to create a kubernetes cluster
- in docs/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
- in wiki