Adds a local volume sample for the Viewer CRD

backend/src/crd/README.md

@@ -173,15 +173,15 @@ customresourcedefinition.apiextensions.k8s.io/viewers.kubeflow.org created
 To run the controller locally, execute:
 
 ```
-go run ./controller/viewer/ -kubeconfig=$HOME/.kube/config -alsologtostderr=true
+go run ./controller/viewer/ -kubecfg=$HOME/.kube/config -alsologtostderr=true
 ```
 
 Now, let's create a simple Tensorboard viewer using the supplied sample:
 ```
 $ kubectl create -f samples/viewer/mnist.yaml
 viewer.kubeflow.org/viewer-75tkf created
 
-$ kubectl getctl -n kubeflow vi
+$ kubectl get viewers -n kubeflow
 NAME           AGE
 viewer-75tkf   108s
 ```

backend/src/crd/samples/viewer/tensorboard-local-volume.yaml

@@ -0,0 +1,39 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+# This example shows how to use a Kubernetes local persistent volume with Tensorboard
+# viewer. The definition below assumes you have a volume called
+# 'argo-volume' in the cluster. This persistent volume will be mounted to
+# /workdir, and /workdir/tensorboard is specified as the logdir parameter for
+# Tensorboard. This assumes you have Tensorboard data in the logdir path.
+apiVersion: "kubeflow.org/v1beta1"
+kind: Viewer
+metadata:
+  generateName: viewer-
+  namespace: kubeflow
+spec:
+  type: tensorboard
+  tensorboardSpec:
+    logDir: /workdir/tensorboard/
+  podTemplateSpec:
+    spec:
+      containers:
+        - volumeMounts:
+          - name: argo-volume
+            mountPath: /workdir
+      volumes:
+        - name: argo-volume
+          persistentVolumeClaim:
+            claimName: argo-claim