From ecd792c089d82774ec74c78037e9c5e4538d63f9 Mon Sep 17 00:00:00 2001 From: Ce Gao Date: Wed, 11 Apr 2018 21:46:54 +0800 Subject: [PATCH] developer_guide: Add instructions for v1alpha2 (#528) Signed-off-by: Ce Gao --- developer_guide.md | 83 +++++----------------------------------------- 1 file changed, 9 insertions(+), 74 deletions(-) diff --git a/developer_guide.md b/developer_guide.md index 0da1682c45..af49e98222 100644 --- a/developer_guide.md +++ b/developer_guide.md @@ -1,79 +1,8 @@ -## Directories Layout +# Developer Guide -```sh -$ tree -d -I 'vendor|bin|.git' -. -├── build -│   ├── images -│   │   └── tf_operator -│   └── release -├── cmd -│   └── tf-operator -│   └── app -│   └── options -├── dashboard -│   ├── backend -│   │   ├── client -│   │   └── handler -│   └── frontend -│   ├── public -│   └── src -│   └── components -├── docs -│   └── diagrams -├── examples -│   ├── crd -│   ├── gke -│   │   └── notebook_image -│   ├── tensorflow-models -│   ├── tf_job -│   │   └── templates -│   └── tf_sample -│   └── tf_sample -├── hack -│   ├── grpc_tensorflow_server -│   └── scripts -├── pkg -│   ├── apis -│   │   └── tensorflow -│   │   ├── helper -│   │   ├── v1alpha1 -│   │   └── validation -│   ├── client -│   │   ├── clientset -│   │   │   └── versioned -│   │   │   ├── fake -│   │   │   ├── scheme -│   │   │   └── typed -│   │   │   └── tensorflow -│   │   │   └── v1alpha1 -│   │   │   └── fake -│   │   ├── informers -│   │   │   └── externalversions -│   │   │   ├── internalinterfaces -│   │   │   └── tensorflow -│   │   │   └── v1alpha1 -│   │   └── listers -│   │   └── tensorflow -│   │   └── v1alpha1 -│   ├── controller -│   ├── trainer -│   └── util -│   ├── k8sutil -│   └── retryutil -├── py -├── test -│   ├── e2e -│   └── test-infra -│   └── airflow -│   └── dags -├── tf-job-operator-chart -│   └── templates -│   └── tests -└── version -``` +There are two versions of operator: one for v1alpha1 and one for v1alpha2. -## Building the Operator +## Building the operator Create a symbolic link inside your GOPATH to the location you checked out the code @@ -98,6 +27,12 @@ Build it go install github.com/kubeflow/tf-operator/cmd/tf-operator ``` +If you want to build the operator for v1alpha2, please use the command here: + +```sh +go install github.com/kubeflow/tf-operator/cmd/tf-operator.v2 +``` + ## Building all the artifacts. [pipenv](https://docs.pipenv.org/) is recommended to manage local Python environment.