ardaguclu / run-once-duration-override-operator

Operator deploying webhook that makes it possible to override activeDeadlineSecondsOverride field during pod admission

Overview

This operator manages OpenShift RunOnceDurationOverride Admission Webhook Server.

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

Releases

rodoo version	ocp version	k8s version	golang
1.0.0	4.13, 4.14	1.26	1.20
1.0.1	4.13, 4.14	1.27	1.20
1.1.0	4.15, 4.16	1.28	1.20
1.1.1	4.15, 4.16	1.29	1.21

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