developer-guide.md

Developer Guide

Prerequisites

• git
• go version v1.13+.
• docker version 17.03+.
• operator-sdk version v0.15.0+.
• kubectl version v1.12.0+.
• Access to a Kubernetes v1.12.0+ cluster.

Build the Operator

In case you want to build the operator from the source code, e.g., to test a fix or a feature you write, you can do so following the instructions below.

The easiest way to build the operator is by using docker command

$ docker build -t <image-tag> -f build/Dockerfile .

If you'd like to test/build the spark-operator locally, follow the instructions below:

$ mkdir -p $GOPATH/src/github.com/AmadeusITGroup
$ cd $GOPATH/src/github.com/AmadeusITGroup
$ git clone [email protected]:AmadeusITGroup/Kubernetes-Kafka-Connect-Operator.git
$ cd Kubernetes-Kafka-Connect-Operator
$ go test ./...
$ docker build -t <image-tag> -f build/Dockerfile .

Update the auto-generated code

To update the auto-generated CRD definitions, run the following command:

$ cd $GOPATH/src/github.com/AmadeusITGroup/Kubernetes-Kafka-Connect-Operator
$ operator-sdk generate crds

If you want to update the auto-generated code like deepcopy funtion, clientset, lister, informer, run the following commands to get the required Kubernetes code generators:

$ go get -u k8s.io/code-generator

Then run the following commands to update the code

$ $GOPATH/src/github.com/AmadeusITGroup/Kubernetes-Kafka-Connect-Operator/hack/update-codegen.sh