Merge pull request #19782 from pmorie/config-docs

docs/user-guide/configmap/README.md

+<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
+
+<!-- BEGIN STRIP_FOR_RELEASE -->
+
+<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
+     width="25" height="25">
+<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
+     width="25" height="25">
+<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
+     width="25" height="25">
+<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
+     width="25" height="25">
+<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
+     width="25" height="25">
+
+<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2>
+
+If you are using a released version of Kubernetes, you should
+refer to the docs that go with that version.
+
+Documentation for other releases can be found at
+[releases.k8s.io](http://releases.k8s.io).
+</strong>
+--
+
+<!-- END STRIP_FOR_RELEASE -->
+
+<!-- END MUNGE: UNVERSIONED_WARNING -->
+
+# ConfigMap example
+
+
+
+## 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 ConfigMap
+
+A ConfigMap contains a set of named strings.
+
+Use the [`examples/configmap/configmap.yaml`](configmap.yaml) file to create a ConfigMap:
+
+```console
+$ kubectl create -f docs/user-guide/configmap/configmap.yaml
+```
+
+You can use `kubectl` to see information about the ConfigMap:
+
+```console
+$ kubectl get configmap
+NAME          DATA
+test-secret   2
+
+$ kubectl describe configMap test-configmap
+Name:          test-configmap
+Labels:        <none>
+Annotations:   <none>
+
+Data
+====
+data-1: 7 bytes
+data-2: 7 bytes
+```
+
+View the values of the keys with `kubectl get`:
+
+```console
+$ cluster/kubectl.sh get configmaps test-configmap -o yaml
+apiVersion: v1
+data:
+  data-1: value-1
+  data-2: value-2
+kind: ConfigMap
+metadata:
+  creationTimestamp: 2016-02-18T20:28:50Z
+  name: test-configmap
+  namespace: default
+  resourceVersion: "1090"
+  selfLink: /api/v1/namespaces/default/configmaps/test-configmap
+  uid: 384bd365-d67e-11e5-8cd0-68f728db1985
+```
+
+## Step Two: Create a pod that consumes a configMap in environment variables
+
+Use the [`examples/configmap/env-pod.yaml`](env-pod.yaml) file to create a Pod that consumes the
+ConfigMap in environment variables.
+
+```console
+$ kubectl create -f docs/user-guide/configmap/env-pod.yaml
+```
+
+This pod runs the `env` command to display the environment of the container:
+
+```console
+$ kubectl logs secret-test-pod
+KUBE_CONFIG_1=value-1
+KUBE_CONFIG_2=value-2
+```
+
+## Step Three: Create a pod that sets the command line using ConfigMap
+
+Use the [`examples/configmap/command-pod.yaml`](env-pod.yaml) file to create a Pod with a container
+whose command is injected with the keys of a ConfigMap
+
+```console
+$ kubectl create -f docs/user-guide/configmap/env-pod.yaml
+```
+
+This pod runs an `echo` command to display the keys:
+
+```console
+value-1 value-2
+```
+
+## Step Four: Create a pod that consumes a configMap in a volume
+
+Pods can also consume ConfigMaps in volumes.  Use the [`examples/configmap/volume-pod.yaml`](volume-pod.yaml) file to create a Pod that consume the ConfigMap in a volume.
+
+```console
+$ kubectl create -f docs/user-guide/configmap/volume-pod.yaml
+```
+
+This pod runs a `cat` command to print the value of one of the keys in the volume:
+
+```console
+value-1
+```
+
+<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/configmap/README.md?pixel)]()
+<!-- END MUNGE: GENERATED_ANALYTICS -->

docs/user-guide/configmap/command-pod.yaml

+apiVersion: v1
+kind: Pod
+metadata:
+  name: config-cmd-test-pod
+spec:
+  containers:
+    - name: test-container
+      image: gcr.io/google_containers/busybox
+      command: [ "/bin/sh", "-c", "echo $(KUBE_CONFIG_1) $(KUBE_CONFIG_2)" ]
+      env:
+        - name: KUBE_CONFIG_1
+          valueFrom:
+            configMapKeyRef:
+              name: test-configmap
+              key: data-1
+        - name: KUBE_CONFIG_2
+          valueFrom:
+            configMapKeyRef:
+              name: test-configmap
+              key: data-2
+  restartPolicy: Never

docs/user-guide/configmap/env-pod.yaml

+apiVersion: v1
+kind: Pod
+metadata:
+  name: config-env-test-pod
+spec:
+  containers:
+    - name: test-container
+      image: gcr.io/google_containers/busybox
+      command: [ "/bin/sh", "-c", "env" ]
+      env:
+        - name: KUBE_CONFIG_1
+          valueFrom:
+            configMapKeyRef:
+              name: test-configmap
+              key: data-1
+        - name: KUBE_CONFIG_2
+          valueFrom:
+            configMapKeyRef:
+              name: test-configmap
+              key: data-2
+  restartPolicy: Never

docs/user-guide/configmap/kubectl/game.properties

+enemies=aliens
+lives=3
+enemies.cheat=true
+enemies.cheat.level=noGoodRotten
+secret.code.passphrase=UUDDLRLRBABAS
+secret.code.allowed=true
+secret.code.lives=30
\ No newline at end of file

docs/user-guide/configmap/kubectl/ui.properties

+color.good=purple
+color.bad=yellow
+allow.textmode=true
+how.nice.to.look=fairlyNice

docs/user-guide/configmap/redis/redis-config

+maxmemory 2mb
+maxmemory-policy allkeys-lru

docs/user-guide/configmap/redis/redis-pod.yaml

+apiVersion: v1
+kind: Pod
+metadata:
+  name: redis
+spec:
+  containers:
+  - name: redis
+    image: kubernetes/redis:v1
+    env:
+    - name: MASTER
+      value: "true"
+    ports:
+    - containerPort: 6379
+    resources:
+      limits:
+        cpu: "0.1"
+    volumeMounts:
+    - mountPath: /redis-master-data
+      name: data
+    - mountPath: /redis-master
+      name: config
+  volumes:
+    - name: data
+      emptyDir: {}
+    - name: config
+      configMap:
+        name: example-redis-config
+        items:
+        - key: redis-config
+          path: redis.conf

docs/user-guide/configmap/volume-pod.yaml

+apiVersion: v1
+kind: Pod
+metadata:
+  name: config-volume-test-pod
+spec:
+  containers:
+    - name: test-container
+      image: gcr.io/google_containers/busybox
+      command: [ "/bin/sh", "-c", "cat /etc/config/path/to/special-key" ]
+      volumeMounts:
+      - name: config-volume
+        mountPath: /etc/config
+  volumes:
+    - name: config-volume
+      configMap:
+        name: test-configmap
+        items:
+        - key: data-1
+          path: path/to/special-key
+  restartPolicy: Never
\ No newline at end of file

hack/test-cmd.sh

@@ -832,7 +832,7 @@ __EOF__
   # ConfigMap          #
   ######################
 
-  kubectl create -f docs/user-guide/configmap/config-map.yaml
+  kubectl create -f docs/user-guide/configmap/configmap.yaml
   kube::test::get_object_assert configmap "{{range.items}}{{$id_field}}{{end}}" 'test-configmap'
   kubectl delete configmap test-configmap "${kube_flags[@]}"
 
@@ -1303,7 +1303,6 @@ __EOF__
   # Post-condition: no replica set exists
   kube::test::get_object_assert rs "{{range.items}}{{$id_field}}:{{end}}" ''
 
-
   ######################
   # Multiple Resources #
   ######################