Moving docs from /vX to /docs; we will use branches for old versions.

2016-02-29 15:17:22 -08:00
parent 54ed50ecd7
commit 4c9e72c518
606 changed files with 1202 additions and 30698 deletions
@@ -0,0 +1,23 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: dapi-test-pod
+spec:
+  containers:
+    - name: test-container
+      image: gcr.io/google_containers/busybox
+      command: [ "/bin/sh", "-c", "env" ]
+      env:
+        - name: MY_POD_NAME
+          valueFrom:
+            fieldRef:
+              fieldPath: metadata.name
+        - name: MY_POD_NAMESPACE
+          valueFrom:
+            fieldRef:
+              fieldPath: metadata.namespace
+        - name: MY_POD_IP
+          valueFrom:
+            fieldRef:
+              fieldPath: status.podIP
+  restartPolicy: Never
@@ -0,0 +1,35 @@
+---
+---
+
+Following this example, you will create a pod with a container that consumes the pod's name and
+namespace using the [downward API](/docs/user-guide/downward-api/).
+
+## Step Zero: Prerequisites
+
+This example assumes you have a Kubernetes cluster installed and running, and that you have
+installed the `kubectl` command line tool somewhere in your path. Please see the [getting
+started](/docs/getting-started-guides/) for installation instructions for your platform.
+
+## Step One: Create the pod
+
+Containers consume the downward API using environment variables.  The downward API allows
+containers to be injected with the name and namespace of the pod the container is in.
+
+Use the [`dapi-pod.yaml`](/docs/user-guide/downward-api/dapi-pod.yaml) file to create a Pod with a container that consumes the
+downward API.
+
+```shell
+$ kubectl create -f docs/user-guide/downward-api/dapi-pod.yaml
+```
+
+### Examine the logs
+
+This pod runs the `env` command in a container that consumes the downward API.  You can grep
+through the pod logs to see that the pod was injected with the correct values:
+
+```shell
+$ kubectl logs dapi-test-pod | grep POD_
+2015-04-30T20:22:18.568024817Z MY_POD_NAME=dapi-test-pod
+2015-04-30T20:22:18.568087688Z MY_POD_NAMESPACE=default
+2015-04-30T20:22:18.568092435Z MY_POD_IP=10.0.1.6
+```
@@ -0,0 +1,30 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: kubernetes-downwardapi-volume-example
+  labels:
+    zone: us-est-coast
+    cluster: test-cluster1
+    rack: rack-22
+  annotations:
+    build: two
+    builder: john-doe
+spec:
+  containers:
+    - name: client-container
+      image: gcr.io/google_containers/busybox
+      command: ["sh", "-c", "while true; do if [[ -e /etc/labels ]]; then cat /etc/labels; fi; if [[ -e /etc/annotations ]]; then cat /etc/annotations; fi; sleep 5; done"]
+      volumeMounts:
+        - name: podinfo
+          mountPath: /etc
+          readOnly: false
+  volumes:
+    - name: podinfo
+      downwardAPI:
+        items:
+          - path: "labels"
+            fieldRef:
+              fieldPath: metadata.labels
+          - path: "annotations"
+            fieldRef:
+              fieldPath: metadata.annotations
@@ -0,0 +1,67 @@
+---
+---
+
+Following this example, you will create a pod with a downward API volume.
+A downward API volume is a k8s volume plugin with the ability to save some pod information in a plain text file. The pod information can be  for example some [metadata](/docs/devel/api-conventions/#metadata).
+
+Supported metadata fields:
+
+1. `metadata.annotations`
+2. `metadata.namespace`
+3. `metadata.name`
+4. `metadata.labels`
+
+### Step Zero: Prerequisites
+
+This example assumes you have a Kubernetes cluster installed and running, and the `kubectl`
+command line tool somewhere in your path. Please see the [gettingstarted](/docs/getting-started-guides/) for installation instructions for your platform.
+
+### Step One: Create the pod
+
+Use the `docs/user-guide/downward-api/dapi-volume.yaml` file to create a Pod with a  downward API volume which stores pod labels and pod annotations to `/etc/labels` and  `/etc/annotations` respectively.
+
+```shell
+$ kubectl create -f  docs/user-guide/downward-api/volume/dapi-volume.yaml
+```
+
+### Step Two: Examine pod/container output
+
+The pod displays (every 5 seconds) the content of the dump files which can be executed via the usual `kubectl log` command
+
+```shell
+$ kubectl logs kubernetes-downwardapi-volume-example
+cluster="test-cluster1"
+rack="rack-22"
+zone="us-est-coast"
+build="two"
+builder="john-doe"
+kubernetes.io/config.seen="2015-08-24T13:47:23.432459138Z"
+kubernetes.io/config.source="api"
+```
+
+### Internals
+
+In pod's `/etc` directory one may find the file created by the plugin (system files elided):
+
+```shell
+$ kubectl exec kubernetes-downwardapi-volume-example -i -t -- sh
+/ # ls -laR /etc
+/etc:
+total 32
+drwxrwxrwt    3 0        0              180 Aug 24 13:03 .
+drwxr-xr-x    1 0        0             4096 Aug 24 13:05 ..
+drwx------    2 0        0               80 Aug 24 13:03 ..2015_08_24_13_03_44259413923
+lrwxrwxrwx    1 0        0               30 Aug 24 13:03 ..downwardapi -> ..2015_08_24_13_03_44259413923
+lrwxrwxrwx    1 0        0               25 Aug 24 13:03 annotations -> ..downwardapi/annotations
+lrwxrwxrwx    1 0        0               20 Aug 24 13:03 labels -> ..downwardapi/labels
+
+/etc/..2015_08_24_13_03_44259413923:
+total 8
+drwx------    2 0        0               80 Aug 24 13:03 .
+drwxrwxrwt    3 0        0              180 Aug 24 13:03 ..
+-rw-r--r--    1 0        0              115 Aug 24 13:03 annotations
+-rw-r--r--    1 0        0               53 Aug 24 13:03 labels
+/ #
+```
+
+The file `labels` is stored in a temporary directory (`..2015_08_24_13_03_44259413923` in the example above) which is symlinked to by `..downwardapi`. Symlinks for annotations and labels in `/etc` point to files containing the actual metadata through the `..downwardapi` indirection.  This structure allows for dynamic atomic refresh of the metadata: updates are written to a new temporary directory, and the `..downwardapi` symlink is updated atomically using `rename(2)`.