cvp-trigger

README

CVP Trigger

CVP Trigger tool will be used by the CVP pipeline to parametrize and trigger the verification jobs for optional operator artifacts built internally in RH.

High-level CVP ↔ Prow Job Architecture

To test the optional operator images built internally in Red Hat, CVP triggers testing jobs via the cvp-trigger tool. Currently, the only implemented test workflow is the one executing the common operator tests (component-agnostic). For common operator tests, cvp-trigger creates a parameterized instance of the cpaas-cvp-optional-operator-common-tests job, living in openshift/release. See the Triggered Job Interface section for details about the parametrization.

The cpaas-cvp-optional-operator-common-tests job runs ci-operator using a config stored in redhat-openshift-ecosystem. The exact configuration to use is inferred from the desired OCP version. For example, for OCP version 4.5, ci-operator uses the config for the artificial cvp-ocp-4.5 branch of the redhat-openshift-ecosystem/playground repository. The ci-operator targets a test with a name inferred from the desired cloud platform. For example, when aws is requested, ci-operator targets the cvp-common-aws test from the config. This example shows how the job calls ci-operator:

$  ci-operator --org=redhat-openshift-ecosystem \
               --repo=playground \
               --branch=cvp-ocp-$(OCP_VERSION) \
               --target=cvp-common-$(CLOUD_PLATFORM) \
               < ...more irrelevant args... >

The cvp-common-$CLOUD_PLATFORM tests are using the optional-operators-cvp-workflow-$CLOUD_PLATFORM workflows. These workflows install an OCP cluster of a given version and install the requested optional operator in it. In its test section, the workflow executes the shared CVP tests against the installed cluster.

Triggered Job Interface

The tool should work by loading Prow and Job configuration, finding specific job configuration structs and modifying those structs so that their specified containers are executed with the specified environmental variables having the desired values.

Common CVP Tests for Optional Operators

CVP Trigger must load the configuration for the cpaas-cvp-optional-operator-common-tests Prowjob and modify its .Spec.Containers[0].Env list to have the following environmental variables set.

Parameters specifying OCP cluster

• OCP_VERSION: Required. A string specifying the desired minor OCP version which will be used when provisioning the ephemeral testing cluster. If RELEASE_IMAGE_LATEST is not specified, an ephemeral release payload will be created, corresponding to the collection of OCP images built from HEADs of appropriate release branches of OCP components (that is, latest development version of that minor release).
• CLUSTER_TYPE: Required. One of aws strings, specifying the cloud platform where the ephemeral cluster will be created.
• RELEASE_IMAGE_LATEST: Optional. A full pullspec of a release payload image which will be used when provisioning the ephemeral testing cluster.
• ENABLE_HYBRID_OVERLAY: Optional. Enables the hybrid overlay feature on a running cluster.

Parameters specifying optional operator to be installed on OCP cluster

• OO_INDEX: Required. A pullspec of the the index image.
• OO_PACKAGE: Required. The name of the operator package to be installed. Must be present in the index image referenced by $OO_INDEX.
• OO_CHANNEL: Required. The name of the operator channel to track.
• OO_INSTALL_NAMESPACE: Optional. The namespace into which the operator and catalog will be installed. If empty, a new namespace will be created.
• OO_TARGET_NAMESPACES: Optional. A comma-separated list of namespaces the operator will target. If empty, all namespaces will be targeted. If no OperatorGroup exists in $OO_INSTALL_NAMESPACE, a new one will be created with its target namespaces set to $OO_TARGET_NAMESPACES, otherwise the existing OperatorGroup's target namespace set will be replaced. The special value "!install" will set the target namespace to the operator's installation namespace.
• CUSTOM_SCORECARD_TESTCASE: Optional. Name of the custom scorecard test which is to be run.
• PYXIS_URL: Optional. URL that contains specific cvp product package name for specific ISV with unique pid.