Build

Build Quarks-operator from source

The following steps layout the process of building quarks-operator (formerly cf-operator) from source and how to install it in your Kubernetes cluster.

Build it from source

Follow this steps to build a proper docker image and generate a deployable helm chart:

  1. Checkout the latest stable release / or run it from develop branch

    1
    
    git checkout v0.3.0
    
  2. Download the shared tools

    1
    
    bin/tools
    
  3. Build the quarks-operator binary, this will be embedded later on the docker image

    1
    
    bin/build
    
  4. Build the docker image

    When running in minikube, please run: eval $(minikube docker-env), to build the image directly on minikube docker.

    1
    
    bin/build-image
    

    Note: This will automatically generate a docker image tag based on your current commit, tag and SHA.

  5. Generated helm charts with a proper docker image tag, org and repository

    1
    
    bin/build-helm
    

    Note: This will generate a new directory under the base dir, named helm/

  6. Install the helm chart(apply Kubernetes Custom Resources)

    1
    
    helm install cf-operator-test helm/quarks-operator
    

    Note: The quarks-operator will be available under the namespace set in the context, usually default, running as a pod.

Last modified May 25, 2021: Fix code display in release docs (2bc24a5)