github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/docs
History
Mike Danese 4d85294bd0 fixed resources field 2014-12-10 23:04:33 -08:00
..
design Remove unused YAML tags and GetYAML/SetYAML methods 2014-12-02 16:25:28 -08:00
devel Merge pull request #2798 from brendandburns/master 2014-12-09 09:54:05 -08:00
getting-started-guides Add a note that vagrant suspend is not supported. 2014-12-09 16:20:47 -08:00
man Fix minion_cache_ttl and minion_regexp flag change. 2014-11-02 00:36:34 -04:00
README.md Document API doc path. 2014-12-02 01:36:21 +00: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 Label documentation improvements. Add annotations documentation. 2014-10-15 22:38:00 +00:00
api-conventions.md Documentation improvements. Fixes #2004, #2115, #2171. 2014-11-17 21:32:44 +00:00
architecture.dia First take at architecture diagram. 2014-07-16 14:06:07 -07:00
architecture.png First take at architecture diagram. 2014-07-16 14:06:07 -07:00
architecture.svg First take at architecture diagram. 2014-07-16 14:06:07 -07:00
authentication.md Basic ACL file. 2014-11-05 16:06:22 -08:00
authorization.md Fix link. 2014-12-02 13:55:36 -08:00
cli.md Adding link to logging conventions doc 2014-11-20 15:29:27 -08:00
client-libraries.md added php client library reference 2014-11-17 16:44:36 +00:00
container-environment.md Documentation improvements. Fixes #2004, #2115, #2171. 2014-11-17 21:32:44 +00:00
dns.md fix link to skydns docs 2014-11-20 15:31:09 -05: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 Document images. 2014-10-09 13:40:56 -07:00
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
node.md fixed resources field 2014-12-10 23:04:33 -08:00
overview.md Documentation improvements. Fixes #2004, #2115, #2171. 2014-11-17 21:32:44 +00:00
ovs-networking.md ovs networking document 2014-09-08 17:06:25 -07:00
ovs-networking.png ovs networking document 2014-09-08 17:06:25 -07:00
pod-states.md Add a doc on pod states 2014-09-23 08:40:17 -07:00
pods.md Documentation improvements. Fixes #2004, #2115, #2171. 2014-11-17 21:32:44 +00:00
replication-controller.md Add documentation of replication controller. 2014-10-01 23:22:10 +00:00
resources.md Document that the resource model has not yet been implemented. 2014-12-01 18:07:25 +00:00
roadmap.md Update roadmap based on discussion at contributor meetup. 2014-12-08 18:54:34 +00:00
salt.md Typo fix 2014-11-23 02:31:40 +01:00
services.md Clarify format of service environment variables. Fixes #1936. 2014-11-24 18:01:56 +00:00
services_detail.png Add and update docs. 2014-10-16 08:36:47 -07:00
services_detail.svg Add and update docs. 2014-10-16 08:36:47 -07:00
services_overview.png Add and update docs. 2014-10-16 08:36:47 -07:00
services_overview.svg Add and update docs. 2014-10-16 08:36:47 -07:00
ux.md Add script to build ui assets, rebuild with latest go-bindata 2014-12-04 22:38:00 -08:00
volumes.md Convert gcutil to gcloud compute 2014-11-25 15:17:00 -08:00

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