Update tf-operator v1beta1 documentation and examples

developer_guide.md

@@ -1,6 +1,6 @@
 # Developer Guide
 
-There are two versions of operator: one for v1alpha1 and one for v1alpha2.
+There are two versions of the TF operator: one for v1alpha2 (to be deprecated) and one for v1beta1.
 
 ## Building the operator
 
@@ -24,7 +24,7 @@ dep ensure
 Build it
 
 ```sh
-go install github.com/kubeflow/tf-operator/cmd/tf-operator
+go install github.com/kubeflow/tf-operator/cmd/tf-operator.v1beta1
 ```
 
 If you want to build the operator for v1alpha2, please use the command here:
@@ -89,8 +89,8 @@ export KUBEFLOW_NAMESPACE=$(your_namespace)
 After the cluster is up, the TFJob CRD should be created on the cluster.
 
 ```bash
-# If you are using v1alpha1
-kubectl create -f ./examples/crd/crd.yml
+# If you are using v1beta1
+kubectl create -f ./examples/crd/crd-v1beta1.yml
 ```
 
 Or
@@ -111,8 +111,10 @@ tf-operator
 To verify local operator is working, create an example job and you should see jobs created by it.
 
 ```sh
-# If you are using v1alpha1
-kubectl create -f ./examples/tf_job.yaml
+# If you are using v1beta1
+cd ./examples/v1beta1/dist-mnist
+docker build -f Dockerfile -t kubeflow/tf-dist-mnist-test:1.0 .
+kubectl create -f ./tf-job-mnist.yaml
 ```
 
 Or

examples/crd/crd-v1beta1.yaml

@@ -0,0 +1,37 @@
+apiVersion: apiextensions.k8s.io/v1beta1
+kind: CustomResourceDefinition
+metadata:
+  name: tfjobs.kubeflow.org
+spec:
+  group: kubeflow.org
+  version: v1beta1
+  scope: Namespaced
+  names:
+    kind: TFJob
+    singular: tfjob
+    plural: tfjobs
+  validation:
+    openAPIV3Schema:
+      properties:
+        spec:
+          properties:
+            tfReplicaSpecs:
+              properties:
+                # The validation works when the configuration contains
+                # `Worker`, `PS` or `Chief`. Otherwise it will not be validated.
+                Worker:
+                  properties:
+                    replicas:
+                      type: integer
+                      minimum: 1
+                PS:
+                  properties:
+                    replicas:
+                      type: integer
+                      minimum: 1
+                Chief:
+                  properties:
+                    replicas:
+                      type: integer
+                      minimum: 1
+                      maximum: 1

examples/distribution_strategy/distributed_tfjob.yaml

@@ -1,4 +1,4 @@
-apiVersion: "kubeflow.org/v1alpha2"
+apiVersion: "kubeflow.org/v1beta1"
 kind: "TFJob"
 metadata:
   name: "distributed-training"

examples/v1beta1/dist-mnist/Dockerfile

@@ -0,0 +1,18 @@
+# Copyright 2016 The TensorFlow Authors. All Rights Reserved.
+#
+# 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.
+
+FROM tensorflow/tensorflow:1.5.0
+
+ADD . /var/tf_dist_mnist
+ENTRYPOINT ["python", "/var/tf_dist_mnist/dist_mnist.py"]

examples/v1beta1/dist-mnist/README.md

@@ -0,0 +1,17 @@
+### Distributed mnist model for e2e test
+
+This folder containers Dockerfile and distributed mnist model for e2e test.
+
+**Build Image**
+
+The default image name and tag is `kubeflow/tf-dist-mnist-test:1.0`.
+
+```shell
+docker build -f Dockerfile -t kubeflow/tf-dist-mnist-test:1.0 ./
+```
+
+**Create TFJob YAML**
+
+```
+kubectl create -f ./tf_job_mnist.yaml
+```