developer-guide.md

Table of Contents

• Developer Guide
  • Requirements
  • Build from source code
  • Implement a new algorithm and use it in katib
    • Implement the algorithm
    • Make the algorithm a GRPC server
    • Use the algorithm in katib.
    • Contribute the algorithm to katib
      • Unit Test
      • E2E Test (Optional)

Created by gh-md-toc

Developer Guide

Requirements

• Go
• Dep
• Docker (17.05 or later.)

Build from source code

Check source code as follows:

make build

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

make deploy

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

make undeploy