Initial checkin of v1.1 -- does not build

2016-02-10 16:55:31 -08:00
parent d1da8c3615
commit a0fb30a6fb
420 changed files with 49449 additions and 158 deletions
@@ -0,0 +1,88 @@
+---
+layout: docwithnav
+title: "Secrets example"
+---
+<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
+
+
+<!-- END MUNGE: UNVERSIONED_WARNING -->
+
+# Secrets example
+
+Following this example, you will create a [secret](../secrets.html) and a [pod](../pods.html) that consumes that secret in a [volume](../volumes.html). See [Secrets design document](../../design/secrets.html) for more information.
+
+## 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 secret
+
+A secret contains a set of named byte arrays.
+
+Use the [`examples/secrets/secret.yaml`](secret.yaml) file to create a secret:
+
+{% highlight console %}
+{% raw %}
+$ kubectl create -f docs/user-guide/secrets/secret.yaml
+{% endraw %}
+{% endhighlight %}
+
+You can use `kubectl` to see information about the secret:
+
+{% highlight console %}
+{% raw %}
+$ kubectl get secrets
+NAME          TYPE      DATA
+test-secret   Opaque    2
+
+$ kubectl describe secret test-secret
+Name:          test-secret
+Labels:        <none>
+Annotations:   <none>
+
+Type:   Opaque
+
+Data
+====
+data-1: 9 bytes
+data-2: 11 bytes
+{% endraw %}
+{% endhighlight %}
+
+## Step Two: Create a pod that consumes a secret
+
+Pods consume secrets in volumes.  Now that you have created a secret, you can create a pod that
+consumes it.
+
+Use the [`examples/secrets/secret-pod.yaml`](secret-pod.yaml) file to create a Pod that consumes the secret.
+
+{% highlight console %}
+{% raw %}
+$ kubectl create -f docs/user-guide/secrets/secret-pod.yaml
+{% endraw %}
+{% endhighlight %}
+
+This pod runs a binary that displays the content of one of the pieces of secret data in the secret
+volume:
+
+{% highlight console %}
+{% raw %}
+$ kubectl logs secret-test-pod
+2015-04-29T21:17:24.712206409Z content of file "/etc/secret-volume/data-1": value-1
+{% endraw %}
+{% endhighlight %}
+
+
+
+
+<!-- BEGIN MUNGE: IS_VERSIONED -->
+<!-- TAG IS_VERSIONED -->
+<!-- END MUNGE: IS_VERSIONED -->
+
+
+<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/secrets/README.md?pixel)]()
+<!-- END MUNGE: GENERATED_ANALYTICS -->
+
@@ -0,0 +1,88 @@
+---
+layout: docwithnav
+title: "Secrets example"
+---
+<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
+
+
+<!-- END MUNGE: UNVERSIONED_WARNING -->
+
+# Secrets example
+
+Following this example, you will create a [secret](../secrets.html) and a [pod](../pods.html) that consumes that secret in a [volume](../volumes.html). See [Secrets design document](../../design/secrets.html) for more information.
+
+## 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 secret
+
+A secret contains a set of named byte arrays.
+
+Use the [`examples/secrets/secret.yaml`](secret.yaml) file to create a secret:
+
+{% highlight console %}
+{% raw %}
+$ kubectl create -f docs/user-guide/secrets/secret.yaml
+{% endraw %}
+{% endhighlight %}
+
+You can use `kubectl` to see information about the secret:
+
+{% highlight console %}
+{% raw %}
+$ kubectl get secrets
+NAME          TYPE      DATA
+test-secret   Opaque    2
+
+$ kubectl describe secret test-secret
+Name:          test-secret
+Labels:        <none>
+Annotations:   <none>
+
+Type:   Opaque
+
+Data
+====
+data-1: 9 bytes
+data-2: 11 bytes
+{% endraw %}
+{% endhighlight %}
+
+## Step Two: Create a pod that consumes a secret
+
+Pods consume secrets in volumes.  Now that you have created a secret, you can create a pod that
+consumes it.
+
+Use the [`examples/secrets/secret-pod.yaml`](secret-pod.yaml) file to create a Pod that consumes the secret.
+
+{% highlight console %}
+{% raw %}
+$ kubectl create -f docs/user-guide/secrets/secret-pod.yaml
+{% endraw %}
+{% endhighlight %}
+
+This pod runs a binary that displays the content of one of the pieces of secret data in the secret
+volume:
+
+{% highlight console %}
+{% raw %}
+$ kubectl logs secret-test-pod
+2015-04-29T21:17:24.712206409Z content of file "/etc/secret-volume/data-1": value-1
+{% endraw %}
+{% endhighlight %}
+
+
+
+
+<!-- BEGIN MUNGE: IS_VERSIONED -->
+<!-- TAG IS_VERSIONED -->
+<!-- END MUNGE: IS_VERSIONED -->
+
+
+<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/secrets/README.md?pixel)]()
+<!-- END MUNGE: GENERATED_ANALYTICS -->
+
@@ -0,0 +1,18 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: secret-test-pod
+spec:
+  containers:
+    - name: test-container
+      image: kubernetes/mounttest:0.1
+      command: [ "/mt", "--file_content=/etc/secret-volume/data-1" ]
+      volumeMounts:
+          # name must match the volume name below
+          - name: secret-volume
+            mountPath: /etc/secret-volume
+  volumes:
+    - name: secret-volume
+      secret:
+        secretName: test-secret
+  restartPolicy: Never
@@ -0,0 +1,7 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: test-secret
+data:
+  data-1: dmFsdWUtMQ0K
+  data-2: dmFsdWUtMg0KDQo=