Use example syncer tags instead of hard-coded examples in doc

Author: janetkuo

cluster/saltbase/salt/fluentd-gcp/fluentd-gcp.yaml

@@ -12,8 +12,8 @@ spec:
         cpu: 100m
         memory: 200Mi
     env:
-    - name: "FLUENTD_ARGS"
-      value: "-qq"
+    - name: FLUENTD_ARGS
+      value: -qq
     volumeMounts:
     - name: varlog
       mountPath: /varlog

cmd/mungedocs/example_syncer.go

@@ -63,7 +63,9 @@ func exampleContent(filePath, linkPath, fileType string) (content string, err er
 	if err != nil {
 		return content, err
 	}
-	content = fmt.Sprintf("\n```%s\n%s\n```\n\n[Download example](%s)", fileType, string(dat), linkPath)
+	// remove leading and trailing spaces and newlines
+	trimmedFileContent := strings.TrimSpace(string(dat))
+	content = fmt.Sprintf("\n```%s\n%s\n```\n\n[Download example](%s)", fileType, trimmedFileContent, linkPath)
 	return
 }
 

docs/admin/namespaces/README.md

@@ -83,6 +83,8 @@ Let's create two new namespaces to hold our work.
 
 Use the file [`namespace-dev.json`](namespace-dev.json) which describes a development namespace:
 
+<!-- BEGIN MUNGE: EXAMPLE namespace-dev.json -->
+
 ```json
 {
   "kind": "Namespace",
@@ -96,6 +98,9 @@ Use the file [`namespace-dev.json`](namespace-dev.json) which describes a develo
 }
 ```
 
+[Download example](namespace-dev.json)
+<!-- END MUNGE: EXAMPLE -->
+
 Create the development namespace using kubectl.
 
 ```console

docs/getting-started-guides/logging.md

@@ -58,20 +58,24 @@ This diagram shows four nodes created on a Google Compute Engine cluster with th
 
 To help explain how cluster level logging works let’s start off with a synthetic log generator pod specification [counter-pod.yaml](../../examples/blog-logging/counter-pod.yaml):
 
+<!-- BEGIN MUNGE: EXAMPLE ../../examples/blog-logging/counter-pod.yaml -->
+
 ```yaml
- apiVersion: v1
- kind: Pod
- metadata:
-   name: counter
-   namespace: default
- spec:
-   containers:
-   - name: count
-     image: ubuntu:14.04
-     args: [bash, -c, 
-            'for ((i = 0; ; i++)); do echo "$i: $(date)"; sleep 1; done']
+apiVersion: v1
+kind: Pod
+metadata:
+  name: counter
+spec:
+  containers:
+  - name: count
+    image: ubuntu:14.04
+    args: [bash, -c, 
+           'for ((i = 0; ; i++)); do echo "$i: $(date)"; sleep 1; done']
 ```
 
+[Download example](../../examples/blog-logging/counter-pod.yaml)
+<!-- END MUNGE: EXAMPLE -->
+
 This pod specification has one container which runs a bash script when the container is born. This script simply writes out the value of a counter and the date once per second and runs indefinitely. Let’s create the pod in the default
 namespace.
 
@@ -152,7 +156,9 @@ We’ve lost the log lines from the first invocation of the container in this po
 
 When a Kubernetes cluster is created with logging to Google Cloud Logging enabled, the system creates a pod called `fluentd-cloud-logging` on each node of the cluster to collect Docker container logs. These pods were shown at the start of this blog article in the response to the first get pods command.
 
-This log collection pod has a specification which looks something like this [fluentd-gcp.yaml](http://releases.k8s.io/HEAD/cluster/saltbase/salt/fluentd-gcp/fluentd-gcp.yaml):
+This log collection pod has a specification which looks something like this:
+
+<!-- BEGIN MUNGE: EXAMPLE ../../cluster/saltbase/salt/fluentd-gcp/fluentd-gcp.yaml -->
 
 ```yaml
 apiVersion: v1
@@ -163,19 +169,31 @@ metadata:
 spec:
   containers:
   - name: fluentd-cloud-logging
-    image: gcr.io/google_containers/fluentd-gcp:1.6
+    image: gcr.io/google_containers/fluentd-gcp:1.9
+    resources:
+      limits:
+        cpu: 100m
+        memory: 200Mi
     env:
     - name: FLUENTD_ARGS
       value: -qq
     volumeMounts:
+    - name: varlog
+      mountPath: /varlog
     - name: containers
       mountPath: /var/lib/docker/containers
   volumes:
+  - name: varlog
+    hostPath:
+      path: /var/log
   - name: containers
     hostPath:
       path: /var/lib/docker/containers
 ```
 
+[Download example](../../cluster/saltbase/salt/fluentd-gcp/fluentd-gcp.yaml)
+<!-- END MUNGE: EXAMPLE -->
+
 This pod specification maps the directory on the host containing the Docker log files, `/var/lib/docker/containers`, to a directory inside the container which has the same path. The pod runs one image, `gcr.io/google_containers/fluentd-gcp:1.6`, which is configured to collect the Docker log files from the logs directory and ingest them into Google Cloud Logging. One instance of this pod runs on each node of the cluster. Kubernetes will notice if this pod fails and automatically restart it.
 
 We can click on the Logs item under the Monitoring section of the Google Developer Console and select the logs for the counter container, which will be called kubernetes.counter_default_count.  This identifies the name of the pod (counter), the namespace (default) and the name of the container (count) for which the log collection occurred. Using this name we can select just the logs for our counter container from the drop down menu:

docs/user-guide/downward-api.md

@@ -80,6 +80,8 @@ environment variable they want.
 This is an example of a pod that consumes its name and namespace via the
 downward API:
 
+<!-- BEGIN MUNGE: EXAMPLE downward-api/dapi-pod.yaml -->
+
 ```yaml
 apiVersion: v1
 kind: Pod
@@ -102,6 +104,9 @@ spec:
   restartPolicy: Never
 ```
 
+[Download example](downward-api/dapi-pod.yaml)
+<!-- END MUNGE: EXAMPLE -->
+
 Some more thorough examples:
    * [environment variables](environment-guide/)
    * [downward API](downward-api/)

docs/user-guide/downward-api/dapi-pod.yaml

@@ -8,11 +8,11 @@ spec:
       image: gcr.io/google_containers/busybox
       command: [ "/bin/sh", "-c", "env" ]
       env:
-        - name: POD_NAME
+        - name: MY_POD_NAME
           valueFrom:
             fieldRef:
               fieldPath: metadata.name
-        - name: POD_NAMESPACE
+        - name: MY_POD_NAMESPACE
           valueFrom:
             fieldRef:
               fieldPath: metadata.namespace

docs/user-guide/logging.md

@@ -43,19 +43,24 @@ The logs of a running container may be fetched using the command `kubectl logs`.
 this pod specification [counter-pod.yaml](../../examples/blog-logging/counter-pod.yaml), which has a container which writes out some text to standard
 output every second. (You can find different pod specifications [here](logging-demo/).)
 
+<!-- BEGIN MUNGE: EXAMPLE ../../examples/blog-logging/counter-pod.yaml -->
+
 ```yaml
- apiVersion: v1
- kind: Pod
- metadata:
-   name: counter
- spec:
-   containers:
-   - name: count
-     image: ubuntu:14.04
-     args: [bash, -c, 
-            'for ((i = 0; ; i++)); do echo "$i: $(date)"; sleep 1; done']
+apiVersion: v1
+kind: Pod
+metadata:
+  name: counter
+spec:
+  containers:
+  - name: count
+    image: ubuntu:14.04
+    args: [bash, -c, 
+           'for ((i = 0; ; i++)); do echo "$i: $(date)"; sleep 1; done']
 ```
 
+[Download example](../../examples/blog-logging/counter-pod.yaml)
+<!-- END MUNGE: EXAMPLE -->
+
 we can run the pod:
 
 ```console

docs/user-guide/pod.yaml

@@ -3,7 +3,7 @@ kind: Pod
 metadata:
   name: nginx
   labels:
-    name: nginx
+    app: nginx
 spec:
   containers:
   - name: nginx

docs/user-guide/simple-yaml.md

@@ -47,6 +47,8 @@ $ kubectl create -f ./pod.yaml
 
 Where pod.yaml contains something like:
 
+<!-- BEGIN MUNGE: EXAMPLE pod.yaml -->
+
 ```yaml
 apiVersion: v1
 kind: Pod
@@ -62,6 +64,9 @@ spec:
     - containerPort: 80
 ```
 
+[Download example](pod.yaml)
+<!-- END MUNGE: EXAMPLE -->
+
 You can see your cluster's pods:
 
 ```console
@@ -87,6 +92,8 @@ $ kubectl create -f ./replication.yaml
 
 Where `replication.yaml` contains:
 
+<!-- BEGIN MUNGE: EXAMPLE replication.yaml -->
+
 ```yaml
 apiVersion: v1
 kind: ReplicationController
@@ -109,6 +116,9 @@ spec:
         - containerPort: 80
 ```
 
+[Download example](replication.yaml)
+<!-- END MUNGE: EXAMPLE -->
+
 To delete the replication controller (and the pods it created):
 
 ```console

docs/user-guide/walkthrough/README.md

@@ -146,6 +146,8 @@ For this example we'll be creating a Redis pod with a named volume and volume mo
 
 Example Redis pod definition with a persistent storage volume ([pod-redis.yaml](pod-redis.yaml)):
 
+<!-- BEGIN MUNGE: EXAMPLE pod-redis.yaml -->
+
 ```yaml
 apiVersion: v1
 kind: Pod
@@ -163,6 +165,9 @@ spec:
     emptyDir: {}
 ```
 
+[Download example](pod-redis.yaml)
+<!-- END MUNGE: EXAMPLE -->
+
 Notes:
 - The volume mount name is a reference to a specific empty dir volume.
 - The volume mount path is the path to mount the empty dir volume within the container.