Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

developer_guide: Add instructions for v1alpha2 #528

Merged
merged 1 commit into from
Apr 11, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not following here, does this mean that if i build with:

go install github.com/kubeflow/tf-operator/cmd/tf-operator

I have v1alpha1 support, but if I build it with:

go install github.com/kubeflow/tf-operator/cmd/tf-operator.v2

I have both v1alpha1 and v1alpha2?

Copy link
Member Author

@gaocegege gaocegege Apr 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, we have two binaries now. tf-operator and tf-operator.v2.

Because the code in cmd is also different between v1alpha1 and v1alpha2

```

## Building all the artifacts.

[pipenv](https://docs.pipenv.org/) is recommended to manage local Python environment.
Expand Down