che-operator/olm

Pre-Requisites

OLM packages scripts are using some required dependencies that need to be installed

• curl
• https://github.com/kislyuk/yq and not http://mikefarah.github.io/yq/
• Operator SDK v0.10.0

WARNING: Please make sure to use the precise v0.10.0 version of the operator-sdk. If you use a more recent version, you might generate a CRD that is not compatible with Kubernetes 1.11 and Openshift 3.11 (see issue https://github.com/eclipse/che/issues/15396).

If these dependencies are not installed, docker-run.sh can be used as a container bootstrap to run a given script with the appropriate dependencies.

Example : $ docker-run.sh update-nightly-olm-files.sh

Make new changes to OLM artifacts

Every change needs to be done in a new OLM artifact as previous artifacts are frozen.

A script is generating new folders/files that can be edited.

In olm folder

• If all dependencies are installed on the system:

$ update-nightly-olm-files.sh

• To use a docker environment

$ docker-run.sh update-nightly-olm-files.sh

Then the changes can be applied in the newly created CSV files.

Local testing che-operator development version using OLM

To test a che-operator with OLM you need to have an application registry. You can register on the quay.io and use application registry from this service. Build your custom che-operator image and push it to the image registry(you also can use quay.io). Change in the deploy/operator.yaml operator image from official to development.

Generate new nightly olm bundle packages:

$ ./update-nightly-olm-files.sh

Olm bundle packages will be generated in the folders olm/eclipse-che-preview-${platform}.

Push che-operator bundles to your application registry:

$ export QUAY_ECLIPSE_CHE_USERNAME=${username} && \
export QUAY_ECLIPSE_CHE_PASSWORD=${password} && \
export APPLICATION_REGISTRY=${application_registry_namespace} && \
./push-olm-files-to-quay.sh

Go to the quay.io and use ui(tab Settings) to make your application public. Start minikube(or CRC) and after that launch test script in the olm folder:

$ export APPLICATION_REGISTRY=${application_registry_namespace} && ./testCSV.sh ${platform} ${package_version} ${optional-namespace}

Where are:

• platform - 'openshift' or 'kubernetes'
• package_version - your generated che-operator package version(for example: 7.8.0 or 9.9.9-nightly.1562083645)
• optional-namespace - kubernetes namespace to deploy che-operator. Optional parameter, by default operator will be deployed to the namespace eclipse-che-preview-test

To test che-operator with OLM files without push to a related Quay.io application, we can build a required docker image of a dedicated catalog, in order to install directly through a CatalogSource. To test this options start minikube and after that launch test script in the olm folder:

$ ./testCatalogSource.sh {platform} ${channel} ${namespace}

This scripts should install che-operator using OLM and check that the Che server was deployed.