Merge pull request #28 from adambkaplan/bundle-build-ci

 E2E CI Test for Operator Bundle

.github/workflows/ci.yml

@@ -50,7 +50,7 @@ jobs:
             go-version: [1.15.x]
             os: [ubuntu-latest]
             kubernetes:
-              - v1.19.7
+              - v1.20.7
           max-parallel: 2
         runs-on: ${{ matrix.os }}
         steps:
@@ -60,5 +60,35 @@ jobs:
             go-version: ${{ matrix.go-version }}
         - name: Check out code
           uses: actions/checkout@v2
-        - name: Build Image
-          run: make ko-publish IMAGE_REPO=ko.local
+        - name: Install kubectl
+          uses: azure/setup-kubectl@v1
+          with:
+            version: ${{ matrix.kubernetes }}
+        - name: Deploy KinD Local Container Registry
+          run: make deploy-kind-registry
+        - name: Create KinD cluster
+          uses: helm/[email protected]
+          with:
+            version: v0.11.1
+            node_image: kindest/node:${{ matrix.kubernetes }}
+            cluster_name: kind
+            config: test/kind/config.yaml
+            wait: 120s
+        - name: Verify KinD cluster
+          run: make verify-kind
+        - name: Install KinD post-actions
+          run: make deploy-kind-registry-post
+        - name: Install OLM
+          run: make install-olm
+        # Builds the operator and makes the image readable in the KinD cluster
+        - name: Build Operator Image
+          run: |
+            make ko-publish IMAGE_REPO=localhost:5000
+        - name: Build Operator Bundle
+          run: |
+            make bundle-push IMAGE_REPO=localhost:5000
+        - name: Build Catalog Source
+          run: |
+            make catalog-push IMAGE_REPO=localhost:5000
+        - name: Run Operator with Catalog
+          run: make catalog-run IMAGE_REPO=localhost:5000

Makefile

@@ -39,20 +39,22 @@ IMAGE_REPO ?= quay.io/shipwright
 TAG ?= $(VERSION)
 IMAGE_PUSH ?= true
 
-BUNDLE_IMG_NAME ?= operator-bundle
-OPERATOR_IMG_NAME ?= operator
+IMAGE_TAG_BASE ?= $(IMAGE_REPO)/operator
 
 # Image URL to use all building/pushing image targets
-IMG ?= $(IMAGE_REPO)/$(OPERATOR_IMG_NAME):$(TAG)
+IMG ?= $(IMAGE_TAG_BASE):$(TAG)
 
 # BUNDLE_IMG defines the image:tag used for the bundle. 
 # You can use it as an arg. (E.g make bundle-build BUNDLE_IMG=<some-registry>/<project-name-bundle>:<tag>)
-BUNDLE_IMG ?= $(IMAGE_REPO)/$(BUNDLE_IMG_NAME):$(TAG)
+BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:$(TAG)
 
 # operating-system type and architecture based on golang
 OS ?= $(shell go env GOOS)
 ARCH ?= $(shell go env GOARCH)
 
+KUBECTL_BIN ?= kubectl
+SED_BIN ?= sed
+
 all: operator
 
 build: operator
@@ -76,23 +78,22 @@ run: generate fmt vet manifests
 
 # Install CRDs into a cluster
 install: manifests kustomize
-	$(KUSTOMIZE) build config/crd | kubectl apply -f -
+	$(KUSTOMIZE) build config/crd | $(KUBECTL_BIN) apply -f -
 
 # Uninstall CRDs from a cluster
 uninstall: manifests kustomize
-	$(KUSTOMIZE) build config/crd | kubectl delete -f -
+	$(KUSTOMIZE) build config/crd | $(KUBECTL_BIN) delete -f -
 
 # Deploy controller in the configured Kubernetes cluster in ~/.kube/config
 deploy: manifests kustomize
 	cd config/manager && $(KUSTOMIZE) edit set image controller="$(IMG)"
-	$(KUSTOMIZE) build config/default | kubectl apply -f -
+	$(KUSTOMIZE) build config/default | $(KUBECTL_BIN) apply -f -
 
 # UnDeploy controller from the configured Kubernetes cluster in ~/.kube/config
 undeploy:
-	$(KUSTOMIZE) build config/default | kubectl delete -f -
+	$(KUSTOMIZE) build config/default | $(KUBECTL_BIN) delete -f -
 
 # Generate manifests e.g. CRD, RBAC etc.
-SED_BIN ?= sed
 manifests: controller-gen
 	$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
 
@@ -185,6 +186,11 @@ bundle-build: bundle
 bundle-push: bundle-build
 	$(CONTAINER_ENGINE) push $(BUNDLE_IMG)
 
+# Install OLM on the current cluster
+.PHONY: install-olm
+install-olm: operator-sdk
+	$(OPERATOR_SDK) olm install
+
 .PHONY: opm
 OPM = ./bin/opm
 opm:
@@ -202,12 +208,45 @@ endif
 endif
 
 BUNDLE_IMGS ?= $(BUNDLE_IMG) 
-CATALOG_IMG ?= $(IMAGE_TAG_BASE)-catalog:v$(VERSION) ifneq ($(origin CATALOG_BASE_IMG), undefined) FROM_INDEX_OPT := --from-index $(CATALOG_BASE_IMG) endif 
+CATALOG_IMG ?= $(IMAGE_TAG_BASE)-catalog:$(VERSION)
 
+#
+# ifneq ($(origin CATALOG_BASE_IMG), undefined) 
+# FROM_INDEX_OPT := --from-index $(CATALOG_BASE_IMG)
+# endif
+# $(OPM) index add --container-tool $(CONTAINER_ENGINE) --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) $(FROM_INDEX_OPT)
+
+# The main multi-arch operatorhub image has a bug that causes opm index add to fail.
+# This doesn't seem to be an issue for the single-arch x86 image.
+# See https://github.com/operator-framework/operator-registry/issues/870
+CATALOG_INDEX_IMG ?= quay.io/operatorhubio/catalog_sa
+
+# Build a catalog image with the operator bundle included
 .PHONY: catalog-build
 catalog-build: opm
-	$(OPM) index add --container-tool $(CONTAINER_ENGINE) --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) $(FROM_INDEX_OPT)
-
+	$(OPM) index add --container-tool $(CONTAINER_ENGINE) --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) --from-index=$(CATALOG_INDEX_IMG)
+
+# Build and push a catalog image with the operator bundle to a container registry
 .PHONY: catalog-push
-catalog-push: ## Push the catalog image.
+catalog-push: catalog-build
 	$(CONTAINER_ENGINE) push $(CATALOG_IMG)
+
+
+CATALOG_NAMESPACE ?= shipwright-operator
+
+# Run the operator from a catalog image, using an OLM subscription
+.PHONY: catalog-run
+catalog-run:
+	CATALOG_IMG=$(CATALOG_IMG) CSV_VERSION=$(VERSION) KUBECTL_BIN=$(KUBECTL_BIN) NAMESPACE=$(CATALOG_NAMESPACE) SED_BIN=$(SED_BIN) hack/run-operator-catalog.sh
+
+.PHONY: verify-kind
+verify-kind:
+	KUBECTL_BIN=$(KUBECTL_BIN) test/kind/verify-kind.sh
+
+.PHONY: deploy-kind-registry
+deploy-kind-registry:
+	CONTAINER_ENGINE=$(CONTAINER_ENGINE) KUBECTL_BIN=$(KUBECTL_BIN) test/kind/deploy-registry.sh
+
+.PHONY: deploy-kind-registry-post
+deploy-kind-registry-post:
+	CONTAINER_ENGINE=$(CONTAINER_ENGINE) KUBECTL_BIN=$(KUBECTL_BIN) test/kind/deploy-registry-post.sh

config/catalog/catalog_source.yaml

@@ -0,0 +1,20 @@
+apiVersion: v1
+kind: Namespace
+metadata:
+  labels:
+    app: shipwright-operator
+  name: system
+---
+apiVersion: operators.coreos.com/v1alpha1
+kind: CatalogSource
+metadata:
+  name: operator
+  namespace: system
+spec:
+  sourceType: grpc
+  image: catalog-source:latest
+  displayName: Shipwright Operator Catalog
+  publisher: The Shipwright Contributors
+  updateStrategy:
+    registryPoll:
+      interval: 10m

config/catalog/kustomization.yaml

@@ -0,0 +1,7 @@
+namespace: shipwright-operator
+namePrefix: shipwright-
+
+resources:
+- catalog_source.yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization

config/subscription/kustomization.yaml

@@ -0,0 +1,8 @@
+namespace: shipwright-operator
+namePrefix: shipwright-
+
+resources:
+- subscription.yaml
+- operator_group.yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization

config/subscription/operator_group.yaml

@@ -0,0 +1,6 @@
+apiVersion: operators.coreos.com/v1alpha2
+kind: OperatorGroup
+metadata:
+  name: operator
+  namespace: system
+spec: {}

config/subscription/subscription.yaml

@@ -0,0 +1,12 @@
+apiVersion: operators.coreos.com/v1alpha1
+kind: Subscription
+metadata:
+  name: operator
+  namespace: system
+spec:
+  channel: alpha
+  name: shipwright-operator
+  source: shipwright-operator
+  sourceNamespace: shipwright-operator
+  installPlanApproval: Automatic
+  startingCSV: shipwright-operator.v0.0.0

controllers/default_test.go

@@ -154,7 +154,10 @@ var _ = g.Describe("Reconcile default ShipwrightBuild installation", func() {
 
 		err = k8sClient.Delete(ctx, build, &client.DeleteOptions{})
 		// the delete e2e's can delete this object before this AfterEach runs
-		o.Expect(err).To(o.BeNil(), o.MatchError(metav1.StatusReasonNotFound))
+		if errors.IsNotFound(err) {
+			return
+		}
+		o.Expect(err).NotTo(o.HaveOccurred())
 
 		g.By("waiting for ShipwrightBuild instance to be completely removed")
 		test.EventuallyRemoved(ctx, k8sClient, build)

docs/development/local-development.md

@@ -34,8 +34,8 @@ Refer to the [ko documentation](https://github.com/google/ko#local-publishing-op
 
 To test the operator on a Kubernetes cluster, you first must have the following:
 
-* Access to a Kubernetes cluster v1.19 or higher, with cluster admin permissions.
-* Install Tekton v0.21 on the cluster.
+* Access to a Kubernetes cluster v1.20 or higher, with cluster admin permissions.
+* Install [Tekton operator](https://github.com/tektoncd/operator) v0.49 or higher on the cluster.
 
 ```bash
 $ export KUBECONFIG=/path/to/kubeconfig
@@ -61,6 +61,8 @@ Finally, use the `make deploy` command with appropriate `IMAGE_REPO` and `TAG` a
 $ make deploy IMAGE_REPO="<IMAGE_REGISTRY>/<USERNAME>" TAG="<TAG>"
 ```
 
+_Note:_
+
 Scripts in `hack` folder may require `sed` (GNU), therefore in platforms other than Linux you may have it with a different name. For instance, on macOS it's usually named `gsed`, in this case provide the `SED_BIN` make variable with the alternative name.
 
 ```bash

docs/development/olm-development.md

@@ -0,0 +1,61 @@
+# OLM Development
+
+The Shipwright operator is meant to be deployed on a cluster using the
+[Operator Lifecycle Manager](https://olm.operatorframework.io/) (OLM).
+OLM provides mechanisms to support over the air upgrades and automatically deploy related operators
+that are packaged in operator [catalogs](https://olm.operatorframework.io/).
+Additional steps need to be taken to ensure the operator can be deployed with OLM.
+
+## Prerequisites
+
+* Ensure you have access to a Kubernetes cluster via `kubectl` with cluster admin permissions.
+* Install Go version 1.15 or higher.
+* Install OLM on your cluster. This can be done using the `make install-olm` command.
+* Ability to push to a container registry that is accessible inside your Kubernetes cluster.
+
+## Step 1: Push the operator image to a registry
+
+Run `make ko-publish IMAGE_REPO=<your-registry>`, pushing to a container registry that is accessible inside your Kubernetes cluster.
+Using `ko.local` or `kind.local` is not recommended, as this will not push the resulting image to a container registry.
+
+If you are using [KinD](https://kind.sigs.k8s.io/), follow the instructions on how to configure a
+[local registry](https://kind.sigs.k8s.io/docs/user/local-registry/).
+This will let you use `localhost:<port>` as your container registry.
+
+## Step 2: Build and push the operator bundle
+
+Next, run `make bundle-push IMAGE_REPO=<your-registry>`.
+This will push the [operator bundle](https://olm.operatorframework.io/docs/tasks/creating-operator-bundle/)
+to the container registry.
+An operator bundle is an OCI aritfact that tells OLM how to deploy your operator.
+Be sure to use the same container registry for the `IMAGE_REPO` argument.
+
+## Step 3: Build and push an operator catalog
+
+Next, run `make catalog-push IMAGE_REPO=<your-registry>`.
+This will build and push an [operator catalog](https://olm.operatorframework.io/docs/tasks/creating-a-catalog/),
+which packages your test operator bundle with the other operators available on [operatorhub.io](https://operatorhub.io).
+As in step 2, be sure to use the same container registry for the `IMAGE_REPO` argument.
+
+## Step 4: Deploy the operator using the catalog image
+
+Finally, deploy the operator using `make catalog-run IMAGE_REPO=<your-registry>`, using the same
+value for `IMAGE_REPO` as in the previous steps.
+This will run a script that does the following:
+
+1. Creates a custom [CatalogSource](https://olm.operatorframework.io/docs/tasks/make-catalog-available-on-cluster/)
+   and [OperatorGroup](https://olm.operatorframework.io/docs/advanced-tasks/operator-scoping-with-operatorgroups/),
+   which allows the operators in step 3's catalog to be installed anywhere on the clsuter.
+2. Creates a [Subscription](https://olm.operatorframework.io/docs/tasks/install-operator-with-olm/),
+   which instructs OLM to install the operator and any dependent operators.
+3. Checks that the operator has successfully been installed and rolled out.
+
+Once the script completes, the Shipwright and Tekton operators will be installed on the cluster.
+
+_Note:_
+
+Scripts in `hack` folder may require `sed` (GNU), therefore in platforms other than Linux you may have it with a different name. For instance, on macOS it's usually named `gsed`, in this case provide the `SED_BIN` make variable with the alternative name.
+
+```bash
+$ make catalog-run SED_BIN=gsed ...
+```