DEVELOPMENT.md

Development Guide

This document provides guidelines and instructions for setting up the development environment and contributing to the project.

Set Environment Variables

Create .env file in the root directory of the project and add the following environment variables:

QUAY_AUTH_TOKEN=<your-quay-auth-token>
QUAY_USER_NAME=<your-quay-username>

Viewing available Make targets

To view all available Make targets, run:

make help

Building Operator image

To build and push the operator image to Quay.io, run:

make container-build
make container-push

Running Tests

You can run the unit tests using the following command:

make test

Running Lint

To run the lint checks, execute:

make lint

Deploying Operator

Ensure KUBECONFIG points to target OpenShift cluster. To deploy the operator, run:

make deploy

Create ConsoleApplication Custom Resource (CR)

To create a ConsoleApplication CR, run:

kubectl create -k examples/success.yaml

Uninstalling Operator

Ensure KUBECONFIG points to target OpenShift cluster. Let's begin by deleting the payload image first with:

kubectl delete -k examples/success.yaml

Subsequently, proceed with uninstalling the operator:

make undeploy