Skip to content

/website

Permalink
Browse files

1.2 additions for user-guide/

  • Loading branch information
John Mulhausen
John Mulhausen committed Mar 7, 2016
1 parent e899d54 commit f16668b45f5a8ca4d734f0356c72d63451e8a6bb
Unified Split
Showing with 2,543 additions and 944 deletions.
  1. +1 −0 _config.yml
  2. +8 −4 _data/guides.yml
  3. +7 −5 _data/reference.yml
  4. +26 −22 _data/samples.yml
  5. +1 −1 docs/admin/daemons.md
  6. +12 −5 docs/user-guide/accessing-the-cluster.md
  7. +8 −8 docs/user-guide/compute-resources.md
  8. +105 −17 docs/user-guide/config-best-practices.md
  9. +511 −0 docs/user-guide/configmap.md
  10. +15 −31 docs/user-guide/configmap/README.md
  11. +8 −13 docs/user-guide/configuring-containers.md
  12. +18 −6 docs/user-guide/connecting-applications.md
  13. +4 −4 docs/user-guide/containers.md
  14. +43 −22 docs/user-guide/debugging-services.md
  15. +1 −2 docs/user-guide/deploying-applications.md
  16. +69 −86 docs/user-guide/deployments.md
  17. +2 −3 docs/user-guide/downward-api.md
  18. +3 −6 docs/user-guide/downward-api/{index.md → README.md}
  19. +1 −2 docs/user-guide/downward-api/volume/index.md
  20. +3 −3 docs/user-guide/environment-guide/index.md
  21. +78 −48 docs/user-guide/images.md
  22. +43 −62 docs/user-guide/index.md
  23. +19 −19 docs/user-guide/ingress.md
  24. +27 −27 docs/user-guide/introspection-and-debugging.md
  25. +1 −6 docs/user-guide/job.yaml
  26. +201 −41 docs/user-guide/jobs.md
  27. +2 −2 docs/user-guide/jsonpath.md
  28. +106 −5 docs/user-guide/kubeconfig-file.md
  29. +122 −0 docs/user-guide/kubectl-cheatsheet.md
  30. +28 −26 docs/user-guide/kubectl-overview.md
  31. +7 −2 docs/user-guide/labels.md
  32. +7 −22 docs/user-guide/liveness/index.md
  33. +1 −4 docs/user-guide/logging-demo/README.md
  34. +2 −2 docs/user-guide/logging.md
  35. +170 −91 docs/user-guide/managing-deployments.md
  36. +1 −1 docs/user-guide/monitoring.md
  37. +3 −1 docs/user-guide/namespaces.md
  38. +47 −15 docs/user-guide/node-selection/index.md
  39. +2 −2 docs/user-guide/persistent-volumes.md
  40. +3 −0 docs/user-guide/persistent-volumes/index.md
  41. +4 −7 docs/user-guide/pod-states.md
  42. +12 −0 docs/user-guide/pod-templates.md
  43. +94 −35 docs/user-guide/pods.md
  44. +1 −1 docs/user-guide/prereqs.md
  45. +10 −10 docs/user-guide/production-pods.md
  46. +5 −0 docs/user-guide/quick-start.md
  47. +186 −19 docs/user-guide/replication-controller.md
  48. +275 −94 docs/user-guide/secrets.md
  49. +2 −2 docs/user-guide/secrets/index.md
  50. +4 −3 docs/user-guide/service-accounts.md
  51. +78 −38 docs/user-guide/services.md
  52. +3 −3 docs/user-guide/simple-nginx.md
  53. +1 −49 docs/user-guide/simple-yaml.md
  54. +107 −28 docs/user-guide/ui.md
  55. +9 −23 docs/user-guide/update-demo/index.md
  56. +23 −8 docs/user-guide/volumes.md
  57. +7 −4 docs/user-guide/walkthrough/index.md
  58. +4 −2 docs/user-guide/walkthrough/k8s201.md
  59. +2 −2 docs/user-guide/working-with-resources.md
  60. BIN images/docs/kibana.png
1 _config.yml
View file
@@ -20,4 +20,5 @@ defaults:
layout: docwithnav
showedit: true
githubbranch: "release-1.2"
docsbranch: "master"
permalink: pretty
12 _data/guides.yml
View file
@@ -147,6 +147,8 @@ toc:
path: /docs/user-guide/getting-into-containers/
- title: The Lifecycle of a Pod
path: /docs/user-guide/pod-states/
- title: Pod Templates
path: /docs/user-guide/pod-templates/
- title: Assigning Pods to Nodes
path: /docs/user-guide/node-selection/
- title: Creating Pods with the Downward API
@@ -167,13 +169,13 @@ toc:
- title: Using DNS Pods and Services
path: /docs/admin/dns/
- title: Setting Up and Configuring DNS
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/cluster-dns
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/cluster-dns
- title: Deploying DNS
path: /docs/getting-started-guides/docker-multinode/deployDNS/
- title: Connecting Applications
path: /docs/user-guide/connecting-applications/
- title: Creating Servers with External IPs
path: https://github.com/kubernetes/kubernetes/blob/release-1.1/examples/simple-nginx.md
path: https://github.com/kubernetes/kubernetes/blob/release-1.2/examples/simple-nginx.md
- title: Connect with Proxies
path: /docs/user-guide/connecting-to-applications-proxy/
- title: Connect with Port Forwarding
@@ -193,6 +195,8 @@ toc:
path: /docs/user-guide/config-best-practices/
- title: Configuring Containers
path: /docs/user-guide/configuring-containers/
- title: Using ConfigMap
path: /docs/user-guide/configmap/
- title: Sharing Cluster Access with kubeconfig
path: /docs/user-guide/sharing-clusters/
- title: Using Environment Variables
@@ -228,11 +232,11 @@ toc:
- title: Testing a Kubernetes Cluster
path: /docs/getting-started-guides/docker-multinode/testing/
- title: Simulating Large Test Loads
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/k8petstore
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/k8petstore
- title: Checking Pod Health
path: /docs/user-guide/liveness/
- title: Using Explorer to Examine the Runtime Environment
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/explorer
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/explorer
- title: Resource Usage Monitoring
path: /docs/user-guide/monitoring/
- title: Logging
12 _data/reference.yml
View file
@@ -40,6 +40,8 @@ toc:
path: /docs/user-guide/docker-cli-to-kubectl/
- title: JSONpath Support
path: /docs/user-guide/jsonpath/
- title: kubectl Cheat Sheet
path: /docs/user-guide/kubectl-cheatsheet/
- title: kubectl Commands
section:
- title: kubectl
@@ -174,14 +176,14 @@ toc:
- title: Kubernetes Design Docs
section:
- title: Kubernetes Architecture
path: https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/design/architecture.md
path: https://github.com/kubernetes/kubernetes/blob/release-1.2/docs/design/architecture.md
- title: Kubernetes Design Overview
path: https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/design/
path: https://github.com/kubernetes/kubernetes/blob/release-1.2/docs/design/
- title: Security in Kubernetes
path: https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/design/security.md
path: https://github.com/kubernetes/kubernetes/blob/release-1.2/docs/design/security.md
- title: Kubernetes Identity and Access Management
path: https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/design/access.md
path: https://github.com/kubernetes/kubernetes/blob/release-1.2/docs/design/access.md
- title: Security Contexts
path: https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/design/security_context.md
path: https://github.com/kubernetes/kubernetes/blob/release-1.2/docs/design/security_context.md
- title: Kubernetes OpenVSwitch GRE/VxLAN networking
path: /docs/admin/ovs-networking/
48 _data/samples.yml
View file
@@ -7,52 +7,56 @@ toc:
- title: Clustered Application Samples
section:
- title: Apache Cassandra Database
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/cassandra
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/cassandra
- title: Apache Spark
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/spark
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/spark
- title: Apache Storm
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/storm
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/storm
- title: Distributed Task Queue
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/celery-rabbitmq
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/celery-rabbitmq
- title: Hazelcast
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/hazelcast
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/hazelcast
- title: Meteor Applications
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/meteor/
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/meteor/
- title: Redis
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/redis/
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/redis/
- title: RethinkDB
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/rethinkdb/
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/rethinkdb/
- title: Elasticsearch/Kibana Logging Demonstration
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/logging-demo/
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/logging-demo/
- title: Elasticsearch
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/elasticsearch/
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/elasticsearch/
- title: OpenShift Origin
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/openshift-origin/
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/openshift-origin/
- title: Ceph
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/rbd/
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/rbd/
- title: MEAN stack on Google Cloud Platform
path: /docs/getting-started-guides/meanstack/

- title: Persistent Volume Samples
section:
- title: WordPress on a Kubernetes Persistent Volume
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/mysql-wordpress-pd/
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/mysql-wordpress-pd/
- title: GlusterFS
path: /https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/glusterfs/
path: /https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/glusterfs/
- title: iSCSI
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/iscsi/
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/iscsi/
- title: NFS
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/nfs/
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/nfs/
- title: Downward API Volumes
path: /docs/user-guide/downward-api/volume/
path: /docs/user-guide/downward-api/volume

- title: Multi-tier Application Samples
section:
- title: Guestbook - Go Server
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/guestbook-go/
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/guestbook-go/
- title: GuestBook - PHP Server
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/guestbook/
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/guestbook/
- title: MySQL - Phabricator Server
path: https://github.com/kubernetes/kubernetes/tree/release-1.1/examples/phabricator/
- title: Elasticsearch/Kibana Logging Demo
path: https://github.com/kubernetes/kubernetes.github.io/tree/master/docs/user-guide/logging-demo
path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/phabricator/

- title: Elasticsearch/Kibana Logging Demo
path: https://github.com/kubernetes/kubernetes.github.io/tree/master/docs/user-guide/logging-demo

- title: ConfigMap Example
path: https://github.com/kubernetes/kubernetes.github.io/tree/master/docs/user-guide/configmap
2 docs/admin/daemons.md
View file
@@ -71,7 +71,7 @@ a node for testing.

If you specify a `.spec.template.spec.nodeSelector`, then the DaemonSet controller will
create pods on nodes which match that [node
selector](/docs/user-guide/node-selection/).
selector](https://github.com/kubernetes/kubernetes.github.io/tree/{{page.docsbranch}}/docs/user-guide/node-selection).

If you do not specify a `.spec.template.spec.nodeSelector`, then the DaemonSet controller will
create pods on all nodes.
17 docs/user-guide/accessing-the-cluster.md
View file
@@ -85,7 +85,7 @@ The above example uses the `--insecure` flag. This leaves it subject to MITM
attacks. When kubectl accesses the cluster it uses a stored root certificate
and client certificates to access the server. (These are installed in the
`~/.kube` directory). Since cluster certificates are typically self-signed, it
make take special configuration to get your http client to use root
may take special configuration to get your http client to use root
certificate.

On some clusters, the apiserver does not require authentication; it may serve
@@ -119,6 +119,13 @@ is associated with a service account, and a credential (token) for that
service account is placed into the filesystem tree of each container in that pod,
at `/var/run/secrets/kubernetes.io/serviceaccount/token`.

If available, a certificate bundle is placed into the filesystem tree of each
container at `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt`, and should be
used to verify the serving certificate of the apiserver.

Finally, the default namespace to be used for namespaced API operations is placed in a file
at `/var/run/secrets/kubernetes.io/serviceaccount/namespace` in each container.

From within a pod the recommended ways to connect to API are:

- run a kubectl proxy as one of the containers in the pod, or as a background
@@ -195,17 +202,17 @@ at `https://104.197.5.247/api/v1/proxy/namespaces/kube-system/services/elasticse
#### Manually constructing apiserver proxy URLs

As mentioned above, you use the `kubectl cluster-info` command to retrieve the service's proxy URL. To create proxy URLs that include service endpoints, suffixes, and parameters, you simply append to the service's proxy URL:
`http://`*`kubernetes_master_address`*`/`*`service_path`*`/`*`service_name`*`/`*`service_endpoint-suffix-parameter`*
<!--- TODO: update this part of doc because it doesn't seem to be valid. What
about namespaces? 'proxy' verb? -->
`http://`*`kubernetes_master_address`*`/api/v1/proxy/namespaces/`*`namespace_name`*`/services/`*`service_name[:port_name]`*

If you haven't specified a name for your port, you don't have to specify *port_name* in the URL

##### Examples

* To access the Elasticsearch service endpoint `_search?q=user:kimchy`, you would use: `http://104.197.5.247/api/v1/proxy/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy`
* To access the Elasticsearch cluster health information `_cluster/health?pretty=true`, you would use: `https://104.197.5.247/api/v1/proxy/namespaces/kube-system/services/elasticsearch-logging/_cluster/health?pretty=true`

```json
{
{
"cluster_name" : "kubernetes_logging",
"status" : "yellow",
"timed_out" : false,
16 docs/user-guide/compute-resources.md
View file
@@ -185,7 +185,7 @@ on the pod you are interested in:
Name: simmemleak-hra99
Namespace: default
Image(s): saadali/simmemleak
Node: kubernetes-minion-tf0f/10.240.216.66
Node: kubernetes-node-tf0f/10.240.216.66
Labels: name=simmemleak
Status: Running
Reason:
@@ -208,14 +208,14 @@ Containers:
Restart Count: 5
Conditions:
Type Status
Ready False
Ready False
Events:
FirstSeen LastSeen Count From SubobjectPath Reason Message
Tue, 07 Jul 2015 12:53:51 -0700 Tue, 07 Jul 2015 12:53:51 -0700 1 {scheduler } scheduled Successfully assigned simmemleak-hra99 to kubernetes-minion-tf0f
Tue, 07 Jul 2015 12:53:51 -0700 Tue, 07 Jul 2015 12:53:51 -0700 1 {kubelet kubernetes-minion-tf0f} implicitly required container POD pulled Pod container image "gcr.io/google_containers/pause:0.8.0" already present on machine
Tue, 07 Jul 2015 12:53:51 -0700 Tue, 07 Jul 2015 12:53:51 -0700 1 {kubelet kubernetes-minion-tf0f} implicitly required container POD created Created with docker id 6a41280f516d
Tue, 07 Jul 2015 12:53:51 -0700 Tue, 07 Jul 2015 12:53:51 -0700 1 {kubelet kubernetes-minion-tf0f} implicitly required container POD started Started with docker id 6a41280f516d
Tue, 07 Jul 2015 12:53:51 -0700 Tue, 07 Jul 2015 12:53:51 -0700 1 {kubelet kubernetes-minion-tf0f} spec.containers{simmemleak} created Created with docker id 87348f12526a
Tue, 07 Jul 2015 12:53:51 -0700 Tue, 07 Jul 2015 12:53:51 -0700 1 {scheduler } scheduled Successfully assigned simmemleak-hra99 to kubernetes-node-tf0f
Tue, 07 Jul 2015 12:53:51 -0700 Tue, 07 Jul 2015 12:53:51 -0700 1 {kubelet kubernetes-node-tf0f} implicitly required container POD pulled Pod container image "gcr.io/google_containers/pause:0.8.0" already present on machine
Tue, 07 Jul 2015 12:53:51 -0700 Tue, 07 Jul 2015 12:53:51 -0700 1 {kubelet kubernetes-node-tf0f} implicitly required container POD created Created with docker id 6a41280f516d
Tue, 07 Jul 2015 12:53:51 -0700 Tue, 07 Jul 2015 12:53:51 -0700 1 {kubelet kubernetes-node-tf0f} implicitly required container POD started Started with docker id 6a41280f516d
Tue, 07 Jul 2015 12:53:51 -0700 Tue, 07 Jul 2015 12:53:51 -0700 1 {kubelet kubernetes-node-tf0f} spec.containers{simmemleak} created Created with docker id 87348f12526a
```

The `Restart Count: 5` indicates that the `simmemleak` container in this pod was terminated and restarted 5 times.
@@ -225,7 +225,7 @@ You can call `get pod` with the `-o go-template=...` option to fetch the status
```shell
[13:59:01] $ ./cluster/kubectl.sh get pod -o go-template='{{range.status.containerStatuses}}{{"Container Name: "}}{{.name}}{{"\r\nLastState: "}}{{.lastState}}{{end}}' simmemleak-60xbc
Container Name: simmemleak
LastState: map[terminated:map[exitCode:137 reason:OOM Killed startedAt:2015-07-07T20:58:43Z finishedAt:2015-07-07T20:58:43Z containerID:docker://0e4095bba1feccdfe7ef9fb6ebffe972b4b14285d5acdec6f0d3ae8a22fad8b2]][13:59:03] clusterScaleDoc ~/go/src/github.com/kubernetes/kubernetes $
LastState: map[terminated:map[exitCode:137 reason:OOM Killed startedAt:2015-07-07T20:58:43Z finishedAt:2015-07-07T20:58:43Z containerID:docker://0e4095bba1feccdfe7ef9fb6ebffe972b4b14285d5acdec6f0d3ae8a22fad8b2]]
```
We can see that this container was terminated because `reason:OOM Killed`, where *OOM* stands for Out Of Memory.

0 comments on commit f16668b

Please sign in to comment.
You can’t perform that action at this time.