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.

Sign up for GitHub

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

Jump to bottom

Default make target to v1alpha2. #585

Merged
merged 1 commit into from
May 27, 2019
Merged

Default make target to v1alpha2. #585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 19 additions & 3 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,30 @@ vet: depend generate
update:
hack/update-gofmt.sh

# Build Katib images
# Build Katib images for v1alpha2
build:
bash scripts/v1alpha1/build.sh
bash scripts/v1alpha2/build.sh

# Deploy katib manifests into a k8s cluster
# Deploy katib v1alpha2 manifests into a k8s cluster
deploy:
bash scripts/v1alpha2/deploy.sh

# Undeploy katib v1alpha2 manifests into a k8s cluster
undeploy:
bash scripts/v1alpha2/undeploy.sh

# Build Katib images for v1alpha1
buildv1alpha1:
bash scripts/v1alpha1/build.sh

# Deploy katib v1alpha1 manifests into a k8s cluster
deployv1alpha1:
bash scripts/v1alpha1/deploy.sh

# Undeploy katib v1alpha1 manifests into a k8s cluster
undeployv1alpha1:
bash scripts/v1alpha1/undeploy.sh

# Generate code
generate:
ifndef GOPATH
Expand Down
27 changes: 25 additions & 2 deletions docs/developer-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [Developer Guide](#developer-guide)
- [Requirements](#requirements)
- [Build from source code](#build-from-source-code)
- [Implement new suggestion algorithm](#implement-new-suggestion-algorithm)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# Developer Guide

## Requirements
Expand All @@ -14,18 +25,30 @@ Check source code as follows:
make check
```

If there are some errors for go fmt, uodate the go fmt as follows:
If there are some errors for go fmt, update the go fmt as follows:

```
make update
```

You can build all images from source.
You can build all images from source for v1alpha2 as follows:

```bash
make build
```

You can deploy katib v1alpha2 manifests into a k8s cluster as follows:

```bash
make deploy
```

You can undeploy katib v1alpha2 manifests from a k8s cluster as follows:

```bash
make undeploy
```

## Implement new suggestion algorithm

Suggestion API is defined as GRPC service at `pkg/api/v1alpha1/api.proto`. Source code is [here](https://github.com/kubeflow/katib/blob/master/pkg/api/v1alpha1/api.proto). You can attach new algorithm easily.
Expand Down