feat: Remove API Dependency on Tekton and cert-manager

hasanawad94 · hasanawad94 · commit b9b7e3798f66 · 2025-11-26T11:24:41.000+02:00
Fixed unit tests: Added CRD establishment wait and Switched to controller-runtime client
Updated the e2e test script (hack/run-operator-catalog.sh) to install Tekton and cert-manager before creating the ShipwrightBuild.

Signed-off-by: Hasan Awad &lt;hasan.m.awad94@gmail.com&gt;
diff --git a/README.md b/README.md
@@ -13,11 +13,14 @@ Once OLM has been deployed, use the following command to install the latest oper
 $ kubectl apply -f https://operatorhub.io/install/shipwright-operator.yaml
 ```
 
-## OLM Dependencies
-When installed via OLM using the provided Shipwright Operator Bundle, the Shipwright operator will ask OLM to deploy the following operators:
-- The [Tekton operator](https://tekton.dev/docs/operator/) to deploy and manage Tekton Pipelines.
-- The [Cert-Manager operator](https://cert-manager.io/docs/installation/operator-lifecycle-manager/) to provision certificates for admission/conversion webhooks.
-For this to work, the Shipwright operator must be included in a catalog that includes these other operators.
+## Prerequisites
+
+Before installing the Shipwright operator, you must have the following components installed in your cluster:
+
+- **Tekton**: The Shipwright operator requires Tekton Pipelines to be installed. Follow the [Tekton installation instructions](https://tekton.dev/docs/setup/) to install Tekton in your cluster.
+- **cert-manager**: The Shipwright operator uses cert-manager to provision certificates for admission/conversion webhooks. Follow the [cert-manager installation instructions](https://cert-manager.io/docs/installation/) to install cert-manager in your cluster.
+
+**Note**: The cert-manager operator has been deprecated. Please install cert-manager directly using the recommended installation method from the [cert-manager documentation](https://cert-manager.io/docs/installation/).
 
 ## Usage
 
diff --git a/bundle/manifests/shipwright-operator.clusterserviceversion.yaml b/bundle/manifests/shipwright-operator.clusterserviceversion.yaml
@@ -36,18 +36,17 @@ spec:
       kind: ShipwrightBuild
       name: shipwrightbuilds.operator.shipwright.io
       version: v1alpha1
-    required:
-    - kind: TektonConfig
-      name: tektonconfigs.operator.tekton.dev
-      version: v1alpha1
-    - kind: Certificate
-      name: certificates.cert-manager.io
-      version: v1
   description: |
     Shipwright is a framework for building container images on Kubernetes.
 
     Read more: [https://shipwright.io](https://shipwright.io)
 
+    ## Prerequisites
+
+    Before installing the Shipwright operator, ensure the following components are installed:
+    - **Tekton**: Follow the [Tekton installation instructions](https://tekton.dev/docs/setup/) to install Tekton Pipelines.
+    - **cert-manager**: Follow the [cert-manager installation instructions](https://cert-manager.io/docs/installation/) to install cert-manager for webhook certificate provisioning.
+
     ## Usage
 
     To deploy and manage [Shipwright Builds](https://github.com/shipwright-io/build) in your cluster,
diff --git a/config/manifests/bases/shipwright-operator.clusterserviceversion.yaml b/config/manifests/bases/shipwright-operator.clusterserviceversion.yaml
@@ -22,18 +22,17 @@ spec:
       kind: ShipwrightBuild
       name: shipwrightbuilds.operator.shipwright.io
       version: v1alpha1
-    required:
-    - kind: TektonConfig
-      name: tektonconfigs.operator.tekton.dev
-      version: v1alpha1
-    - kind: Certificate
-      name: certificates.cert-manager.io
-      version: v1
   description: |
     Shipwright is a framework for building container images on Kubernetes.
 
     Read more: [https://shipwright.io](https://shipwright.io)
 
+    ## Prerequisites
+
+    Before installing the Shipwright operator, ensure the following components are installed:
+    - **Tekton**: Follow the [Tekton installation instructions](https://tekton.dev/docs/setup/) to install Tekton Pipelines.
+    - **cert-manager**: Follow the [cert-manager installation instructions](https://cert-manager.io/docs/installation/) to install cert-manager for webhook certificate provisioning.
+
     ## Usage
 
     To deploy and manage [Shipwright Builds](https://github.com/shipwright-io/build) in your cluster,
diff --git a/controllers/suite_test.go b/controllers/suite_test.go
@@ -126,6 +126,20 @@ func setupTektonCRDs(ctx context.Context) {
 		tektonOpCRD.Status.StoredVersions = []string{"v1alpha1"}
 		err = k8sClient.Create(ctx, tektonOpCRD, &client.CreateOptions{})
 		Expect(err).NotTo(HaveOccurred())
+
+		// Wait for the CRD to be established before proceeding
+		Eventually(func() bool {
+			crd := &crdv1.CustomResourceDefinition{}
+			if err := k8sClient.Get(ctx, types.NamespacedName{Name: "tektonconfigs.operator.tekton.dev"}, crd); err != nil {
+				return false
+			}
+			for _, condition := range crd.Status.Conditions {
+				if condition.Type == crdv1.Established && condition.Status == crdv1.ConditionTrue {
+					return true
+				}
+			}
+			return false
+		}).Should(BeTrue(), "TektonConfig CRD should be established")
 	}
 	Expect(err).NotTo(HaveOccurred())
 }
@@ -191,31 +205,39 @@ func createTektonConfig(ctx context.Context) *tektonoperatorv1alpha1.TektonConfi
 			},
 		},
 	}
-	_, err := tektonOpClient.TektonConfigs().Create(ctx, tektonConfig, metav1.CreateOptions{})
+	// Use controller-runtime client instead of REST client for better compatibility with envtest
+	err := k8sClient.Create(ctx, tektonConfig, &client.CreateOptions{})
 	if errors.IsAlreadyExists(err) {
-		// If it already exists, that's fine
-		err = nil
+		// If it already exists, fetch it
+		err = k8sClient.Get(ctx, types.NamespacedName{Name: "config"}, tektonConfig)
+		Expect(err).NotTo(HaveOccurred())
+	} else {
+		Expect(err).NotTo(HaveOccurred())
 	}
-	Expect(err).To(BeNil())
 
 	return tektonConfig
 }
 
 // deleteTektonConfig tears down the given TektonConfig instance.
 func deleteTektonConfig(ctx context.Context) {
 	By("deleting the TektonConfig instance")
-	err := tektonOpClient.TektonConfigs().Delete(ctx, "config", metav1.DeleteOptions{})
+	tektonConfig := &tektonoperatorv1alpha1.TektonConfig{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "config",
+		},
+	}
+	err := k8sClient.Delete(ctx, tektonConfig, &client.DeleteOptions{})
 	// the delete e2e's can delete this object before this AfterEach runs
 	if errors.IsNotFound(err) {
 		return
 	}
 	Expect(err).NotTo(HaveOccurred())
 
 	By("waiting for TektonConfig instance to be completely removed")
-	Eventually(func() error {
-		_, err := tektonOpClient.TektonConfigs().Get(ctx, "config", metav1.GetOptions{})
-		return err
-	}, "30s", "5s").Should(WithTransform(errors.IsNotFound, BeTrue()))
+	Eventually(func() bool {
+		err := k8sClient.Get(ctx, types.NamespacedName{Name: "config"}, tektonConfig)
+		return errors.IsNotFound(err)
+	}, "30s", "5s").Should(BeTrue(), "TektonConfig should be deleted")
 }
 
 var _ = BeforeSuite(func() {
diff --git a/hack/run-operator-catalog.sh b/hack/run-operator-catalog.sh
@@ -17,6 +17,8 @@
 # - SUBSCRIPTION_NAMESPACE: Namespace to install the operator via an OLM subscription. Defaults to
 #   shipwright-operator.
 # - NAME_PREFIX: prefix to use for all resource names. Defaults to "shipwright-"
+# - TEKTON_OPERATOR_VERSION: Tekton Operator version to install. Defaults to v0.77.0 (matches go.mod).
+# - CERT_MANAGER_VERSION: cert-manager version to install. Defaults to v1.13.0.
 
 set -eu -o pipefail
 
@@ -81,6 +83,82 @@ function wait_for_pod() {
     ${KUBECTL_BIN} wait --for=condition=Ready pod -l "${label}" -n "${namespace}" --timeout "${timeout}"
 }
 
+function install_tekton() {
+    echo "Installing Tekton Operator"
+    # Install Tekton Operator using the official installation method (https://github.com/tektoncd/operator/releases)
+    # Minimum supported version is v0.50.0 (see pkg/common/const.go)
+    # Default version matches the dependency in go.mod (v0.77.0) for stability
+    # Can be overridden via TEKTON_OPERATOR_VERSION env var
+    TEKTON_OPERATOR_VERSION=${TEKTON_OPERATOR_VERSION:-v0.77.0}
+    echo "Installing Tekton Operator version ${TEKTON_OPERATOR_VERSION}"
+    if ! ${KUBECTL_BIN} apply -f "https://storage.googleapis.com/tekton-releases/operator/previous/${TEKTON_OPERATOR_VERSION}/release.yaml"; then
+        echo "Warning: Failed to install Tekton Operator ${TEKTON_OPERATOR_VERSION}, falling back to latest"
+        ${KUBECTL_BIN} apply -f "https://storage.googleapis.com/tekton-releases/operator/latest/release.yaml"
+    fi
+    
+    echo "Waiting for Tekton Operator to be ready"
+    # Wait for the operator namespace to exist first
+    for i in {1..30}; do
+        if ${KUBECTL_BIN} get namespace tekton-operator &>/dev/null; then
+            break
+        fi
+        sleep 2
+    done
+    
+    if ! wait_for_pod "app=tekton-operator" "tekton-operator" 5m; then
+        echo "Failed to deploy Tekton Operator"
+        ${KUBECTL_BIN} get pods -n tekton-operator
+        exit 1
+    fi
+    
+    echo "Creating TektonConfig instance"
+    ${KUBECTL_BIN} apply -f - <<EOF
+apiVersion: operator.tekton.dev/v1alpha1
+kind: TektonConfig
+metadata:
+  name: config
+spec:
+  profile: lite
+  targetNamespace: tekton-pipelines
+EOF
+    
+    echo "Waiting for TektonConfig to be ready"
+    if ! ${KUBECTL_BIN} wait --for=condition=Ready tektonconfigs.operator.tekton.dev/config --timeout=5m; then
+        echo "Failed to deploy TektonConfig"
+        ${KUBECTL_BIN} get tektonconfigs -o yaml
+        ${KUBECTL_BIN} get tektonconfigs config -o yaml
+        exit 1
+    fi
+}
+
+function install_cert_manager() {
+    echo "Installing cert-manager"
+    # Install cert-manager using the official installation method (https://github.com/cert-manager/cert-manager/releases)
+    # Default version is v1.13.0 (stable release)
+    # Can be overridden via CERT_MANAGER_VERSION env var
+    CERT_MANAGER_VERSION=${CERT_MANAGER_VERSION:-v1.13.0}
+    echo "Installing cert-manager version ${CERT_MANAGER_VERSION}"
+    ${KUBECTL_BIN} apply -f "https://github.com/cert-manager/cert-manager/releases/download/${CERT_MANAGER_VERSION}/cert-manager.yaml"
+    
+    echo "Waiting for cert-manager pods to be ready"
+    if ! wait_for_pod "app.kubernetes.io/instance=cert-manager" "cert-manager" 5m; then
+        echo "Failed to deploy cert-manager"
+        ${KUBECTL_BIN} get pods -n cert-manager
+        exit 1
+    fi
+    
+    echo "Waiting for cert-manager webhook to be ready"
+    # Wait for the webhook to be ready by checking if it can validate certificates
+    for i in {1..30}; do
+        if ${KUBECTL_BIN} get validatingwebhookconfigurations cert-manager-webhook &>/dev/null; then
+            echo "cert-manager webhook is ready"
+            return 0
+        fi
+        sleep 2
+    done
+    echo "Warning: cert-manager webhook may not be fully ready, continuing anyway"
+}
+
 add_kustomizations
 
 echo "Deploying catalog source"
@@ -108,6 +186,10 @@ if ! wait_for_pod "app=shipwright-operator" "${SUBSCRIPTION_NAMESPACE}" 5m; then
     exit 1
 fi
 
+echo "Installing prerequisites"
+install_cert_manager
+install_tekton
+
 echo "Deploying Shipwright build controller"
 
 ${KUBECTL_BIN} apply -f - <<EOF
