github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-06 03:33:26 +00:00
Code Issues Projects Releases Wiki Activity

User, Admin, and Developer guides.

Browse Source 
First pass at organizing our docs for three separate audiences:
User, Cluster Admin, and developer.  Wrote a top-level guide
for each one, by selecting parts of the old docs/README.md.
The new docs/README.md mostly points to these 3 guides.
This commit is contained in:
Eric Tune
2015-03-10 14:27:10 -07:00
parent 9022dbd3ea
commit 0510315e10
4 changed files with 197 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
docs/README.md
View File

@@ -1,113 +1,16 @@
# Kubernetes Documentation
* [Primary concepts](#primary-concepts)
* [Further reading](#further-reading)
* The [User's guide](user-guide.md) is for anyone who wants to run programs and services on an exisiting Kubernetes cluster.
* The [Cluster Admin's guide](cluster-admin-guide.md) is for anyone setting up a Kubernetes cluster or administering it.
Getting started guides are in [getting-started-guides](getting-started-guides).
* The [Developer guide](developer-guide.md) is for anyone wanting to write programs that access the kubernetes API,
write plugins or extensions, or modify the core code of kubernetes.
There are example files and walkthroughs in the [examples](../examples) folder.
* The [Kubectl Command Line Interface]([kubectl.md](kubectl.md)) is a detailed reference on the `kubectl` CLI.
If you're developing Kubernetes, docs are in the [devel](devel) folder.
* The [API object documentation](http://kubernetes.io/third_party/swagger-ui/) is a detailed description of all fields found in core API objects.
Design docs are in [design](design).
API objects are explained at [http://kubernetes.io/third_party/swagger-ui/](http://kubernetes.io/third_party/swagger-ui/).
Frequently asked questions are answered on this project's [wiki](https://github.com/GoogleCloudPlatform/kubernetes/wiki).
## Primary concepts
* **Overview** ([overview.md](overview.md)): A brief overview
of Kubernetes concepts.
* **Nodes** ([node.md](node.md)): A node is a worker machine in Kubernetes.
* **Pods** ([pods.md](pods.md)): A pod is a tightly-coupled group of containers
with shared volumes.
* **The Life of a Pod** ([pod-states.md](pod-states.md)):
Covers the intersection of pod states, the PodStatus type, the life-cycle
of a pod, events, restart policies, and replication controllers.
* **Replication Controllers** ([replication-controller.md](replication-controller.md)):
A replication controller ensures that a specified number of pod "replicas" are
running at any one time.
* **Services** ([services.md](services.md)): A Kubernetes service is an abstraction
which defines a logical set of pods and a policy by which to access them.
* **Volumes** ([volumes.md](volumes.md)): A Volume is a directory, possibly with some
data in it, which is accessible to a Container.
* **Labels** ([labels.md](labels.md)): Labels are key/value pairs that are
attached to objects, such as pods. Labels can be used to organize and to
select subsets of objects.
* **Accessing the API** ([accessing_the_api.md](accessing_the_api.md)):
Ports, IPs, proxies, and firewall rules.
* **Kubernetes Web Interface** ([ui.md](ui.md)): Accessing the Kubernetes
web user interface.
* **Kubectl Command Line Interface** ([kubectl.md](kubectl.md)):
The `kubectl` command line reference.
* **Roadmap** ([roadmap.md](roadmap.md)): The set of supported use cases, features,
docs, and patterns that are required before Kubernetes 1.0.
* **Glossary** ([glossary.md](glossary.md)): Terms and concepts.
* **Cluster Management** ([cluster_management.md](cluster_management.md)): Starting and upgrading clusters.
## Further reading
* **Annotations** ([annotations.md](annotations.md)): Attaching
arbitrary non-identifying metadata.
* **API Conventions** ([api-conventions.md](api-conventions.md)):
Defining the verbs and resources used in the Kubernetes API.
* **Authentication Plugins** ([authentication.md](authentication.md)):
The current and planned states of authentication tokens.
* **Authorization Plugins** ([authorization.md](authorization.md)):
Authorization applies to all HTTP requests on the main apiserver port.
This doc explains the available authorization implementations.
* **API Client Libraries** ([client-libraries.md](client-libraries.md)):
A list of existing client libraries, both supported and user-contributed.
* **Kubernetes Container Environment** ([container-environment.md](container-environment.md)):
Describes the environment for Kubelet managed containers on a Kubernetes
node.
* **DNS Integration with SkyDNS** ([dns.md](dns.md)):
Resolving a DNS name directly to a Kubernetes service.
* **Identifiers** ([identifiers.md](identifiers.md)): Names and UIDs
explained.
* **Images** ([images.md](images.md)): Information about container images
and private registries.
* **Logging** ([logging.md](logging.md)): Pointers to logging info.
* **Namespaces** ([namespaces.md](namespaces.md)): Namespaces help different
projects, teams, or customers to share a kubernetes cluster.
* **Networking** ([networking.md](networking.md)): Pod networking overview.
* **OpenVSwitch GRE/VxLAN networking** ([ovs-networking.md](ovs-networking.md)):
Using OpenVSwitch to set up networking between pods across
Kubernetes nodes.
* **The Kubernetes Resource Model** ([resources.md](resources.md)):
Provides resource information such as size, type, and quantity to assist in
assigning Kubernetes resources appropriately.
* **Using Salt to configure Kubernetes** ([salt.md](salt.md)): The Kubernetes
cluster can be configured using Salt.
* An overview of the [Design of Kubernetes](../DESIGN.md)
* There are example files and walkthroughs in the [examples](../examples) folder.