Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.89 KB

building.adoc

File metadata and controls

31 lines (20 loc) · 1.89 KB

Prerequisites

  • Java 11+

  • mvn

  • OpenShift Client (or kubernetes)

GitHub Packages Setup

This project uses GitHub packages for of its dependencies. Before you can build this project using mvn install you must configure Maven to authenticate to GitHub with a Personal Access Token that has packages:read permission. Please refer to [GitHub’s documentation fordetailed instructions.

Building and Developing

The operator is written in Java as a multi module Maven project. The easiest way to build and run the operator locally is

 mvn install
 cd source/rhoas
 mvn quarkus:dev

This will compile the operator and run it in development mode using Quarkus. Please note, it will connect to whichever OpenShift cluster you are logged into with oc login.

Updating Custom Resource Definitions

To update CRDs, you will need to edit the files in the OLM-template directory. It is very important that the files in the parent directory are not disturbed as they are part of the OLM catalog history and are used by the out GitHub actions to create new OLM bundles and deploy them correctly.

Operator Container Build

The Operator container is built by Quarkus JIB. The configuration is provided by application.properties. The GitHub action release workflow contains an example of these values being overidden to release the operator.