Skip to content

Latest commit

 

History

History
120 lines (78 loc) · 2.71 KB

HACKING.md

File metadata and controls

120 lines (78 loc) · 2.71 KB
Raw

Ingress Controller Operator Hacking

Building

To build the operator, run:

$ make build

Developing

Prerequisites

Building Locally & Deploying to the Cluster

To build the operator on your local machine and deploy it to the cluster, first uninstall the existing operator and all its managed components:

$ make uninstall

Build a new image and custom manifests using default Dockerfile:

$ REPO=docker.io/you/cluster-ingress-operator make release-local

or using the UBI based Dockerfile:

$ DOCKERFILE=Dockerfile.ubi REPO=docker.io/you/cluster-ingress-operator make release-local

Follow the instructions to install the operator, e.g.:

$ oc apply -f /tmp/manifests/path

Note, make uninstall scales the CVO to 0 replicas. To scale the CVO back up when testing is complete, run:

$ oc scale --replicas 1 -n openshift-cluster-version deployments/cluster-version-operator

Building & Running the Operator Locally

This allows you to quickly test changes to the operator without pushing any code or images to the cluster.

To build the operator binary locally:

$ make build

To run the operator binary in the cluster from your local machine (as opposed to on the cluster in a pod):

$ make run-local

Set ENABLE_CANARY=true in your environment (or inline with the run-local command) to enable the ingress canary.

Note, to rescale the operator on the cluster after local testing is complete, scale the CVO back up with:

$ oc scale --replicas 1 -n openshift-cluster-version deployments/cluster-version-operator

Building Remotely on the Cluster

To build the operator on the remote cluster, first create a buildconfig on the cluster:

$ make buildconfig

The above command will create a buildconfig using the current branch and the URL for the default push remote. You can also specify an explicit branch or repository URL:

$ make buildconfig GIT_BRANCH=<branch> \
     GIT_URL=https://github.com/<username>/cluster-ingress-operator.git

Note: If a buildconfig already exists from an earlier make buildconfig command, make buildconfig will update the existing buildconfig.

Next, start a build from this buildconfig:

$ make cluster-build

Alternatively, if you want to see the logs during the build, specify the V flag:

$ make cluster-build V=1

Use the DEPLOY flag to start a build and then patch the operator to use the newly built image:

$ make cluster-build DEPLOY=1

Tests

Run unit tests:

$ make test

Assuming KUBECONFIG is set, run end-to-end tests:

$ make test-e2e