Skip to content

Commit

Permalink
developer_guide: Add instructions for v1alpha2 (kubeflow#528)
Browse files Browse the repository at this point in the history
Signed-off-by: Ce Gao <gaoce@caicloud.io>
  • Loading branch information
gaocegege authored and Penghui Yan committed Jun 18, 2018
1 parent 792d399 commit 60c47e6
Showing 1 changed file with 9 additions and 74 deletions.
83 changes: 9 additions & 74 deletions developer_guide.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.
Expand Down

0 comments on commit 60c47e6

Please sign in to comment.