Contributing to Flippy

We welcome contributions :)

Setting up for local Development

Kubebuilder

Flippy uses Kubebuilder for CRD implementation. Kubebuilder is a framework for building Kubernetes APIs using custom resource definitions (CRDs).

To understand how kubebuilder you can refer to installation guide.

To install CRD -
make install

To run -
make run

Argo Rollouts

Flippy also support argo rollouts. Please install argo rollouts add on.

Golang

Flippy is developed on Golang Version 1.15.

Please install Golang specific version.

Kubectl

Please install kubectl tool

How to run from local machine

Specify kubernetes cluster config
export KUBECONFIG=<CONFIGFILE>
Install crd to kubernetes cluster
kubectl apply -f config/crd/bases/keikoproj.io_flippyconfigs.yaml
Building operator binary
go build -a -o manager main.go

Installation Docs