diff --git a/Makefile b/Makefile index c0c55573087..2917fdce249 100644 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/docs/developer-guide.md b/docs/developer-guide.md index 6d63b652ca8..e15cd095063 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -1,3 +1,14 @@ + + +**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) + + + # Developer Guide ## Requirements @@ -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.