Introduce webhook to prevent more than 1 KIP resource in a single namespace

.github/workflows/next-build.yml

@@ -25,6 +25,11 @@ jobs:
     -
       name: "Set up Docker Buildx"
       uses: docker/setup-buildx-action@v2
+    - 
+      name: Set up kubebuilder
+      uses: RyanSiu1995/[email protected]
+      with:
+        version: 2.3.2
     -
       name: "Docker quay.io Login"
       uses: docker/login-action@v2

.github/workflows/pr-check.yml

@@ -22,6 +22,10 @@ jobs:
       uses: actions/setup-go@v3
       with:
         go-version: 1.18
+    - name: Set up kubebuilder
+      uses: RyanSiu1995/[email protected]
+      with:
+        version: 2.3.2
     - name: Run unit tests
       run: make test
   image-build:
@@ -30,7 +34,7 @@ jobs:
     - name: Checkout source code
       uses: actions/checkout@v3
     - name: Build image
-      run: docker build -f build/Dockerfile .
+      run: docker build -f build/Dockerfile --build-arg SKIP_TESTS=true . 
   scorecard:
     runs-on: ubuntu-22.04
     steps:

.github/workflows/release.yml

@@ -67,6 +67,10 @@ jobs:
         uses: actions/setup-go@v3
         with:
           go-version: 1.18
+      - name: Set up kubebuilder
+        uses: RyanSiu1995/[email protected]
+        with:
+          version: 2.3.2
       - name: Release operator
         run: |
           RELEASE_VERSION=${{ github.event.inputs.version }}

Makefile

@@ -169,7 +169,8 @@ bundle: generate manifests download-kustomize download-operator-sdk ## Generate
 
 	CSV_PATH=$$($(MAKE) csv-path)
 	yq -riY '.metadata.annotations.containerImage = "'$(IMG)'"' $${CSV_PATH}
-	yq -riY '.spec.install.spec.deployments[0].spec.template.spec.containers[1].image = "'$(IMG)'"' $${CSV_PATH}
+	# Update container image for container 'kuebrnetes-image-puller-operator' in the list of deployments
+	yq -riY '.spec.install.spec.deployments[0].spec.template.spec.containers[] |= (select(.name == "kubernetes-image-puller-operator") .image |= "'$(IMG)'")' $${CSV_PATH}
 
 	# Copy bundle.Dockerfile to the bundle dir
  	# Update paths (since it is created in the root of the project) and labels

PROJECT

@@ -1,4 +1,4 @@
-domain: eclipse.che
+domain: eclipse.org
 layout:
 - go.kubebuilder.io/v3
 plugins:
@@ -16,4 +16,8 @@ resources:
   kind: KubernetesImagePuller
   path: github.com/che-incubator/kubernetes-image-puller-operator/api/v1alpha1
   version: v1alpha1
+  webhooks:
+    defaulting: true
+    validation: true
+    webhookVersion: v1
 version: "3"

api/v1alpha1/kubernetesimagepuller_webhook.go

@@ -0,0 +1,46 @@
+//
+// Copyright (c) 2012-2023 Red Hat, Inc.
+// This program and the accompanying materials are made
+// available under the terms of the Eclipse Public License 2.0
+// which is available at https://www.eclipse.org/legal/epl-2.0/
+//
+// SPDX-License-Identifier: EPL-2.0
+//
+// Contributors:
+//   Red Hat, Inc. - initial API and implementation
+//
+
+package v1alpha1
+
+import (
+	"context"
+
+	ctrl "sigs.k8s.io/controller-runtime"
+
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/webhook"
+)
+
+func (r *KubernetesImagePuller) SetupWebhookWithManager(mgr ctrl.Manager) error {
+	mgr.GetWebhookServer().Register("/validate-che-eclipse-org-v1alpha1-kubernetesimagepuller", &webhook.Admission{Handler: &validationHandler{k8sClient: mgr.GetClient()}})
+	return nil
+}
+
+// +kubebuilder:webhook:path=/validate-che-eclipse-org-v1alpha1-kubernetesimagepuller,mutating=false,failurePolicy=fail,sideEffects=None,groups=che.eclipse.org,resources=kubernetesimagepullers,verbs=create,versions=v1alpha1,name=vkubernetesimagepuller.kb.io,admissionReviewVersions={v1,v1beta1}
+
+type validationHandler struct {
+	k8sClient client.Client
+}
+
+func (v *validationHandler) Handle(ctx context.Context, req webhook.AdmissionRequest) webhook.AdmissionResponse {
+	imagePullers := &KubernetesImagePullerList{}
+	err := v.k8sClient.List(ctx, imagePullers, &client.ListOptions{Namespace: req.Namespace})
+	if err != nil {
+		return webhook.Denied(err.Error())
+	}
+
+	if len(imagePullers.Items) > 0 {
+		return webhook.Denied("only one KubernetesImagePuller is allowed per namespace")
+	}
+	return webhook.Allowed("there are no KubernetesImagePuller resources in this namespace")
+}

api/v1alpha1/webhook_suite_test.go

@@ -0,0 +1,182 @@
+//
+// Copyright (c) 2012-2023 Red Hat, Inc.
+// This program and the accompanying materials are made
+// available under the terms of the Eclipse Public License 2.0
+// which is available at https://www.eclipse.org/legal/epl-2.0/
+//
+// SPDX-License-Identifier: EPL-2.0
+//
+// Contributors:
+//   Red Hat, Inc. - initial API and implementation
+//
+
+package v1alpha1
+
+import (
+	"context"
+	"crypto/tls"
+	"fmt"
+	"net"
+	"path/filepath"
+	"testing"
+	"time"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+
+	admissionv1beta1 "k8s.io/api/admission/v1beta1"
+	v1 "k8s.io/api/core/v1"
+
+	//+kubebuilder:scaffold:imports
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/client-go/rest"
+	ctrl "sigs.k8s.io/controller-runtime"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/envtest"
+	"sigs.k8s.io/controller-runtime/pkg/envtest/printer"
+	logf "sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/log/zap"
+)
+
+// These tests use Ginkgo (BDD-style Go testing framework). Refer to
+// http://onsi.github.io/ginkgo/ to learn more about Ginkgo.
+
+var cfg *rest.Config
+var k8sClient client.Client
+var testEnv *envtest.Environment
+var ctx context.Context
+var cancel context.CancelFunc
+
+func TestAPIs(t *testing.T) {
+	RegisterFailHandler(Fail)
+
+	RunSpecsWithDefaultAndCustomReporters(t,
+		"Webhook Suite",
+		[]Reporter{printer.NewlineReporter{}})
+}
+
+var _ = BeforeSuite(func() {
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
+
+	ctx, cancel = context.WithCancel(context.TODO())
+
+	By("bootstrapping test environment")
+	testEnv = &envtest.Environment{
+		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "config", "crd", "bases")},
+		ErrorIfCRDPathMissing: false,
+		WebhookInstallOptions: envtest.WebhookInstallOptions{
+			Paths: []string{filepath.Join("..", "..", "config", "webhook")},
+		},
+	}
+
+	cfg, err := testEnv.Start()
+	Expect(err).NotTo(HaveOccurred())
+	Expect(cfg).NotTo(BeNil())
+
+	scheme := runtime.NewScheme()
+	err = AddToScheme(scheme)
+	Expect(err).NotTo(HaveOccurred())
+
+	err = admissionv1beta1.AddToScheme(scheme)
+	Expect(err).NotTo(HaveOccurred())
+
+	err = v1.AddToScheme(scheme)
+	Expect(err).NotTo(HaveOccurred())
+
+	//+kubebuilder:scaffold:scheme
+
+	k8sClient, err = client.New(cfg, client.Options{Scheme: scheme})
+	Expect(err).NotTo(HaveOccurred())
+	Expect(k8sClient).NotTo(BeNil())
+
+	// start webhook server using Manager
+	webhookInstallOptions := &testEnv.WebhookInstallOptions
+	mgr, err := ctrl.NewManager(cfg, ctrl.Options{
+		Scheme:             scheme,
+		Host:               webhookInstallOptions.LocalServingHost,
+		Port:               webhookInstallOptions.LocalServingPort,
+		CertDir:            webhookInstallOptions.LocalServingCertDir,
+		LeaderElection:     false,
+		MetricsBindAddress: "0",
+	})
+	Expect(err).NotTo(HaveOccurred())
+
+	err = (&KubernetesImagePuller{}).SetupWebhookWithManager(mgr)
+	Expect(err).NotTo(HaveOccurred())
+
+	//+kubebuilder:scaffold:webhook
+
+	go func() {
+		err = mgr.Start(ctx)
+		if err != nil {
+			Expect(err).NotTo(HaveOccurred())
+		}
+	}()
+
+	// wait for the webhook server to get ready
+	dialer := &net.Dialer{Timeout: time.Second}
+	addrPort := fmt.Sprintf("%s:%d", webhookInstallOptions.LocalServingHost, webhookInstallOptions.LocalServingPort)
+	Eventually(func() error {
+		conn, err := tls.DialWithDialer(dialer, "tcp", addrPort, &tls.Config{InsecureSkipVerify: true})
+		if err != nil {
+			return err
+		}
+		conn.Close()
+		return nil
+	}).Should(Succeed())
+
+}, 60)
+
+var _ = Describe("Create KubernetesImagePuller resource", func() {
+
+	var kip *KubernetesImagePuller
+
+	BeforeEach(func() {
+		kip = &KubernetesImagePuller{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "test-kip",
+				Namespace: "default",
+			},
+		}
+	})
+
+	It("Should create a KubernetesImagePuller resource", func() {
+		Expect(k8sClient.Create(ctx, kip)).Should(Succeed())
+		Expect(k8sClient.Delete(ctx, kip)).Should(Succeed())
+	})
+
+	It("Should not be able to create a second KubernetesImagePuller resource in the same namespace", func() {
+		secondKip := kip.DeepCopy()
+		secondKip.ObjectMeta.Name = secondKip.ObjectMeta.Name + "-different"
+
+		Expect(k8sClient.Create(ctx, kip)).Should(Succeed())
+		err := k8sClient.Create(ctx, secondKip)
+		Expect(err.Error()).To(Equal("admission webhook \"vkubernetesimagepuller.kb.io\" denied the request: only one KubernetesImagePuller is allowed per namespace"))
+		Expect(k8sClient.Delete(ctx, kip)).Should(Succeed())
+	})
+
+	It("Should be able to create a second KubernetesImagePuller resource in a different namespace", func() {
+		secondKip := kip.DeepCopy()
+		secondKip.ObjectMeta.Name = secondKip.ObjectMeta.Name + "-different"
+		secondKip.ObjectMeta.Namespace = secondKip.ObjectMeta.Namespace + "-different"
+		newNamespace := &v1.Namespace{
+			ObjectMeta: metav1.ObjectMeta{
+				Name: secondKip.ObjectMeta.Namespace,
+			},
+		}
+		Expect(k8sClient.Create(ctx, newNamespace)).Should(Succeed())
+		Expect(k8sClient.Create(ctx, kip)).Should(Succeed())
+		Expect(k8sClient.Create(ctx, secondKip)).Should(Succeed())
+		Expect(k8sClient.Delete(ctx, kip)).Should(Succeed())
+		Expect(k8sClient.Delete(ctx, secondKip)).Should(Succeed())
+		Expect(k8sClient.Delete(ctx, newNamespace)).Should(Succeed())
+	})
+})
+
+var _ = AfterSuite(func() {
+	cancel()
+	By("tearing down the test environment")
+	err := testEnv.Stop()
+	Expect(err).NotTo(HaveOccurred())
+})

build/Dockerfile

@@ -13,6 +13,7 @@
 # https://access.redhat.com/containers/?tab=tags#/registry.access.redhat.com/ubi8/go-toolset
 FROM registry.access.redhat.com/ubi8/go-toolset:1.20.10-3 as builder
 ENV GOPATH=/go/
+ARG SKIP_TESTS="false"
 USER root
 
 WORKDIR /workspace
@@ -32,7 +33,7 @@ COPY pkg/ pkg/
 COPY hack/ hack/
 
 # Test
-RUN make test
+RUN if [[ ${SKIP_TESTS} == "false" ]]; then make test; fi
 # Build
 RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GO111MODULE=on go build -a -o manager main.go
 

config/certmanager/certificate.yaml

@@ -0,0 +1,25 @@
+# The following manifests contain a self-signed issuer CR and a certificate CR.
+# More document can be found at https://docs.cert-manager.io
+# WARNING: Targets CertManager v1.0. Check https://cert-manager.io/docs/installation/upgrading/ for breaking changes.
+apiVersion: cert-manager.io/v1
+kind: Issuer
+metadata:
+  name: selfsigned-issuer
+  namespace: system
+spec:
+  selfSigned: {}
+---
+apiVersion: cert-manager.io/v1
+kind: Certificate
+metadata:
+  name: serving-cert  # this name should match the one appeared in kustomizeconfig.yaml
+  namespace: system
+spec:
+  # $(SERVICE_NAME) and $(SERVICE_NAMESPACE) will be substituted by kustomize
+  dnsNames:
+  - $(SERVICE_NAME).$(SERVICE_NAMESPACE).svc
+  - $(SERVICE_NAME).$(SERVICE_NAMESPACE).svc.cluster.local
+  issuerRef:
+    kind: Issuer
+    name: selfsigned-issuer
+  secretName: webhook-server-cert # this secret will not be prefixed, since it's not managed by kustomize

config/certmanager/kustomization.yaml

@@ -0,0 +1,5 @@
+resources:
+- certificate.yaml
+
+configurations:
+- kustomizeconfig.yaml

config/certmanager/kustomizeconfig.yaml

@@ -0,0 +1,16 @@
+# This configuration is for teaching kustomize how to update name ref and var substitution 
+nameReference:
+- kind: Issuer
+  group: cert-manager.io
+  fieldSpecs:
+  - kind: Certificate
+    group: cert-manager.io
+    path: spec/issuerRef/name
+
+varReference:
+- kind: Certificate
+  group: cert-manager.io
+  path: spec/commonName
+- kind: Certificate
+  group: cert-manager.io
+  path: spec/dnsNames