Overview

This operator manages OpenShift RunOnceDurationOverride Admission Webhook Server.

RunOnceDurationOverride Admission Webhook Server is located at run-once-duration-override.

Releases

releases:
- {version: "1.0.0",       ocp: "4.13, 4.14", k8s: "1.26", go: "1.20", release_branch: "4.13"}
- {version: "1.0.1-1.0.4", ocp: "4.13, 4.14", k8s: "1.27", go: "1.20", release_branch: "4.14"}
- {version: "1.1.0",       ocp: "4.15, 4.16", k8s: "1.28", go: "1.20", release_branch: "4.15"}
- {version: "1.1.1-1.1.4", ocp: "4.15, 4.16", k8s: "1.29", go: "1.21", release_branch: "4.16"}
- {version: "1.2.0",       ocp: "4.17, 4.18", k8s: "1.30", go: "1.22", release_branch: "4.17"}
- {version: "1.2.1-1.2.4", ocp: "4.17, 4.18", k8s: "1.31", go: "1.22", release_branch: "4.18"}
- {version: "1.3.0",       ocp: "4.19, 4.20", k8s: "1.32", go: "1.23", release_branch: "4.19"}
- {version: "1.3.1-1.3.2", ocp: "4.19, 4.20", k8s: "1.33", go: "1.24", release_branch: "4.20"}
- {version: "1.4.0",       ocp: "4.21, 4.22", k8s: "1.34", go: "1.24", release_branch: "4.21"}
- {version: "1.4.1-1.4.2", ocp: "4.21, 4.22", k8s: "1.35", go: "1.25", release_branch: "4.22"}
- {version: "1.5.0",       ocp: "5.0",        k8s: "1.36", go: "1.26", release_branch: "5.0"}

Deploy the Operator

Quick Development

1. Build and push the operator image to a registry:

   export QUAY_USER=${your_quay_user_id}
   export IMAGE_TAG=${your_image_tag}
   podman build -t quay.io/${QUAY_USER}/run-once-duration-override-operator:${IMAGE_TAG} -f Dockerfile.rhel7 .
   podman login quay.io -u ${QUAY_USER}
   podman push quay.io/${QUAY_USER}/run-once-duration-override-operator:${IMAGE_TAG}

2. Update the image spec under .spec.template.spec.containers[0].image field in the deploy/07_deployment.yaml Deployment to point to the newly built image

3. Update the RELATED_IMAGE_OPERAND_IMAGE env value under .spec.template.spec.containers[0].envs field in the deploy/07_deployment.yaml to point to the admission webhook image

4. Update the .spec.runOnceDurationOverride.spec.activeDeadlineSeconds under deploy/08_cr.yaml as needed

5. Apply the manifests from deploy directory:

   oc apply -f deploy/

Building index image from a bundle image (built in Brew)

This process requires access to the Brew building system.

1. List available bundle images (as IMAGE):

$ brew list-builds --package=run-once-duration-override-operator-bundle-container

1. Get pull secret for selected bundle image (as IMAGE_PULL):

$ brew --noauth call --json getBuild IMAGE |jq -r '.extra.image.index.pull[0]'

1. Build the index image (with IMAGE_TAG):

$ opm index add --bundles IMAGE_PULL --tag quay.io/${QUAY_USER}/run-once-duration-override-operator-index:IMAGE_TAG

OperatorHub install with custom index image

This process refers to building the operator in a way that it can be installed locally via the OperatorHub with a custom index image

1. Build and push the operator image to a registry:

   export QUAY_USER=${your_quay_user_id}
   export IMAGE_TAG=${your_image_tag}
   podman build -t quay.io/${QUAY_USER}/run-once-duration-override-operator:${IMAGE_TAG} -f Dockerfile.rhel7 .
   podman login quay.io -u ${QUAY_USER}
   podman push quay.io/${QUAY_USER}/run-once-duration-override-operator:${IMAGE_TAG}

2. Update the .spec.install.spec.deployments[0].spec.template.spec.containers[0].image field in the RODOO CSV under manifests/runoncedurationoverride-operator.clusterserviceversion.yaml to point to the newly built image.

3. Update the RELATED_IMAGE_OPERAND_IMAGE env value under .spec.install.spec.deployments[0].spec.template.spec.containers[0].envs field in the RODOO CSV under manifests/runoncedurationoverride-operator.clusterserviceversion.yaml to point to the admission webhook image.

4. build and push the metadata image to a registry (e.g. https://quay.io):

   podman build -t quay.io/${QUAY_USER}/run-once-duration-override-operator-metadata:${IMAGE_TAG} -f Dockerfile.metadata .
   podman push quay.io/${QUAY_USER}/run-once-duration-override-operator-metadata:${IMAGE_TAG}

5. build and push image index for operator-registry (pull and build https://github.com/operator-framework/operator-registry/ to get the opm binary)

   opm index add --bundles quay.io/${QUAY_USER}/run-once-duration-override-operator-metadata:${IMAGE_TAG} --tag quay.io/${QUAY_USER}/run-once-duration-override-operator-index:${IMAGE_TAG}
   podman push quay.io/${QUAY_USER}/run-once-duration-override-operator-index:${IMAGE_TAG}

   Don't forget to increase the number of open files, .e.g. ulimit -n 100000 in case the current limit is insufficient.

6. create and apply catalogsource manifest (notice to change <<QUAY_USER>> and <<IMAGE_TAG>> to your own values)::

   apiVersion: operators.coreos.com/v1alpha1
   kind: CatalogSource
   metadata:
     name: run-once-duration-override-operator
     namespace: openshift-marketplace
   spec:
     sourceType: grpc
     image: quay.io/<<QUAY_USER>>/run-once-duration-override-operator-index:<<IMAGE_TAG>>

7. create openshift-run-once-duration-override-operator namespace:

   $ oc create ns openshift-run-once-duration-override-operator
   

8. open the console Operators -> OperatorHub, search for Run Once Duration Override Operator and install the operator

9. create CR for the Run Once Duration Override Operator in the console:

   apiVersion: operator.openshift.io/v1
   kind: RunOnceDurationOverride
   metadata:
     name: cluster
   spec:
     runOnceDurationOverride:
       spec:
         activeDeadlineSeconds: 3600
   

Tests

This repository is compatible with the OpenShift Tests Extension (OTE) framework.

Building the test binary

make build

Running test suites and tests

# Run a specific test suite or test
./run-once-duration-override-operator-tests-ext run-suite openshift/run-once-duration-override-operator/operator/serial
./run-once-duration-override-operator-tests-ext run-test "test-name"

# To run serial suites cases serially, use the following command:
./run-once-duration-override-operator-tests-ext run-suite openshift/run-once-duration-override-operator/operator/serial -c 1

# Run with JUnit output
./run-once-duration-override-operator-tests-ext run-suite openshift/run-once-duration-override-operator/operator/serial --junit-path=/tmp/junit.xml
./run-once-duration-override-operator-tests-ext run-test "test-name" --junit-path=/tmp/junit.xml

Listing available tests and suites

# List all test suites
./run-once-duration-override-operator-tests-ext list suites

# List tests in a suite
./run-once-duration-override-operator-tests-ext list tests --suite=openshift/run-once-duration-override-operator/operator/serial

For more information about the OTE framework, see the openshift-tests-extension documentation.