github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-13 13:14:05 +00:00
Code Issues Projects Releases Wiki Activity

Cloning docs for 0.19.0

Browse Source
This commit is contained in:
Brendan Burns
2015-06-10 09:23:42 -07:00
parent 1dc723b4cb
commit f3208ad4c0
514 changed files with 43289 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
release-0.19.0/docs/user-guide.md Normal file
View File

@@ -0,0 +1,99 @@
# Kubernetes User Guide
The user guide is intended for anyone who wants to run programs and services
on an existing Kubernetes cluster. Setup and administration of a
Kubernetes cluster is described in the [Cluster Admin Guide](cluster-admin-guide.md).
The developer guide is for anyone wanting to either write code which directly accesses the
kubernetes API, or to contribute directly to the kubernetes project.
## 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.
* **Secrets** ([secrets.md](secrets.md)): A Secret stores sensitive data
(e.g. ssh keys, passwords) separately from the Pods that use them, protecting
the sensitive data from proliferation by tools that process pods.
* **Accessing the API and other cluster services via a Proxy** [accessing-the-cluster.md](../docs/accessing-the-cluster.md)
* **API Overview** ([api.md](api.md)): Pointers to API documentation on various topics
and explanation of Kubernetes's approaches to API changes and API versioning.
* **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.
* **Sharing Cluster Access** ([sharing-clusters.md](sharing-clusters.md)):
How to share client credentials for a kubernetes cluster.
* **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.
## Further reading
* **Annotations** ([annotations.md](annotations.md)): Attaching
arbitrary non-identifying metadata.
* **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.
* **The Kubernetes Resource Model** ([resources.md](resources.md)):
Provides resource information such as size, type, and quantity to assist in
assigning Kubernetes resources appropriately.
* The [API object documentation](http://kubernetes.io/third_party/swagger-ui/).
* Frequently asked questions are answered on this project's [wiki](https://github.com/GoogleCloudPlatform/kubernetes/wiki).
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide.md?pixel)]()
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/release-0.19.0/docs/user-guide.md?pixel)]()