Merge pull request #1252 from njhale/fix-bundle-extract

Bug 1798645: fix(bundles): execute opm from tooling container

Author: openshift-merge-robot

Dockerfile

@@ -18,10 +18,12 @@ COPY OLM_VERSION OLM_VERSION
 COPY pkg pkg
 COPY vendor vendor
 COPY cmd cmd
+COPY util util
 COPY test test
 COPY go.mod go.mod
 COPY go.sum go.sum
 RUN CGO_ENABLED=1 make build
+RUN make build-util
 
 FROM openshift/origin-base
 
@@ -32,6 +34,7 @@ LABEL io.openshift.release.operator=true
 COPY --from=builder /build/bin/olm /bin/olm
 COPY --from=builder /build/bin/catalog /bin/catalog
 COPY --from=builder /build/bin/package-server /bin/package-server
+COPY --from=builder /build/bin/cpb /bin/cpb
 
 # This image doesn't need to run as root user.
 USER 1001

Makefile

@@ -75,6 +75,14 @@ build-wait: clean bin/wait
 bin/wait:
 	GOOS=linux GOARCH=386 go build -o $@ $(PKG)/test/e2e/wait
 
+build-util-linux: arch_flags=GOOS=linux GOARCH=386
+build-util-linux: build-util
+
+build-util: bin/cpb
+
+bin/cpb:
+	CGO_ENABLED=0 $(arch_flags) go build $(MOD_FLAGS) -ldflags '-extldflags "-static"' -o $@ ./util/cpb
+
 $(CMDS): version_flags=-ldflags "-X $(PKG)/pkg/version.GitCommit=$(GIT_COMMIT) -X $(PKG)/pkg/version.OLMVersion=`cat OLM_VERSION`"
 $(CMDS):
 	$(arch_flags) go $(build_cmd) $(MOD_FLAGS) $(version_flags) -o bin/$(shell basename $@) $@
@@ -84,7 +92,7 @@ build: clean $(CMDS)
 $(TCMDS):
 	go test -c $(BUILD_TAGS) $(MOD_FLAGS) -o bin/$(shell basename $@) $@
 
-run-local: build-linux build-wait
+run-local: build-linux build-wait build-util-linux
 	rm -rf build
 	. ./scripts/build_local.sh
 	mkdir -p build/resources

cmd/catalog/main.go

@@ -31,6 +31,7 @@ const (
 	defaultWakeupInterval       = 15 * time.Minute
 	defaultCatalogNamespace     = "openshift-operator-lifecycle-manager"
 	defaultConfigMapServerImage = "quay.io/operatorframework/configmap-operator-registry:latest"
+	defaultUtilImage            = "quay.io/operator-framework/olm:latest"
 	defaultOperatorName         = ""
 )
 
@@ -48,6 +49,9 @@ var (
 	configmapServerImage = flag.String(
 		"configmapServerImage", defaultConfigMapServerImage, "the image to use for serving the operator registry api for a configmap")
 
+	utilImage = flag.String(
+		"util-image", defaultUtilImage, "an image containing custom olm utilities")
+
 	writeStatusName = flag.String(
 		"writeStatusName", defaultOperatorName, "ClusterOperator name in which to write status, set to \"\" to disable.")
 
@@ -168,7 +172,7 @@ func main() {
 	}
 
 	// Create a new instance of the operator.
-	op, err := catalog.NewOperator(ctx, *kubeConfigPath, utilclock.RealClock{}, logger, *wakeupInterval, *configmapServerImage, *catalogNamespace)
+	op, err := catalog.NewOperator(ctx, *kubeConfigPath, utilclock.RealClock{}, logger, *wakeupInterval, *configmapServerImage, *utilImage, *catalogNamespace)
 	if err != nil {
 		log.Panicf("error configuring operator: %s", err.Error())
 	}

deploy/chart/templates/0000_50_olm_08-catalog-operator.deployment.yaml

@@ -34,6 +34,8 @@ spec:
           {{- if .Values.catalog.commandArgs }}
           - {{ .Values.catalog.commandArgs }}
           {{- end }}
+          - -util-image
+          -  {{ .Values.catalog.image.ref }}
           {{- if .Values.writeStatusNameCatalog }}
           - -writeStatusName
           - {{ .Values.writeStatusNameCatalog }}

go.mod

@@ -15,6 +15,7 @@ require (
 	github.com/openshift/api v3.9.1-0.20190924102528-32369d4db2ad+incompatible
 	github.com/openshift/client-go v0.0.0-20190923180330-3b6373338c9b
 	github.com/operator-framework/operator-registry v1.5.8
+	github.com/otiai10/copy v1.0.1
 	github.com/pkg/errors v0.8.1
 	github.com/prometheus/client_golang v1.2.1
 	github.com/sirupsen/logrus v1.4.2
@@ -23,6 +24,7 @@ require (
 	golang.org/x/sys v0.0.0-20191210023423-ac6580df4449 // indirect
 	golang.org/x/time v0.0.0-20191024005414-555d28b269f0
 	google.golang.org/grpc v1.24.0
+	gopkg.in/yaml.v2 v2.2.4
 	helm.sh/helm/v3 v3.0.1
 	k8s.io/api v0.17.1
 	k8s.io/apiextensions-apiserver v0.17.1

local.Dockerfile

@@ -3,6 +3,7 @@ WORKDIR /
 COPY olm /bin/olm
 COPY catalog /bin/catalog
 COPY package-server /bin/package-server
+COPY cpb /bin/cpb
 EXPOSE 8080
 EXPOSE 5443
 CMD ["/bin/olm"]

manifests/0000_50_olm_08-catalog-operator.deployment.yaml

@@ -27,6 +27,8 @@ spec:
           - '-namespace'
           - openshift-marketplace
           - -configmapServerImage=quay.io/operator-framework/configmap-operator-registry:latest
+          - -util-image
+          -  quay.io/operator-framework/olm@sha256:0d15ffb5d10a176ef6e831d7865f98d51255ea5b0d16403618c94a004d049373
           - -writeStatusName
           - operator-lifecycle-manager-catalog
           - -tls-cert

pkg/controller/bundle/bundle_unpacker.go

@@ -54,9 +54,9 @@ func (c *ConfigMapUnpacker) job(cmRef *corev1.ObjectReference, bundlePath string
 					RestartPolicy: corev1.RestartPolicyOnFailure,
 					Containers: []corev1.Container{
 						{
-							Name:    cmRef.Name,
-							Image:   bundlePath,
-							Command: []string{"/injected/opm", "alpha", "bundle", "extract", "-n", cmRef.Namespace, "-c", cmRef.Name},
+							Name:    "extract",
+							Image:   c.opmImage,
+							Command: []string{"opm", "alpha", "bundle", "extract", "-m", "/bundle/", "-n", cmRef.Namespace, "-c", cmRef.Name},
 							Env: []corev1.EnvVar{
 								{
 									Name:  configmap.EnvContainerImage,
@@ -65,28 +65,49 @@ func (c *ConfigMapUnpacker) job(cmRef *corev1.ObjectReference, bundlePath string
 							},
 							VolumeMounts: []corev1.VolumeMount{
 								{
-									Name:      "copydir",
-									MountPath: "/injected",
+									Name:      "bundle", // Expected bundle content mount
+									MountPath: "/bundle",
 								},
 							},
 						},
 					},
 					InitContainers: []corev1.Container{
 						{
-							Name:    "copy-binary",
-							Image:   c.copyImage,
-							Command: []string{"/bin/cp", "/bin/opm", "/copy-dest"},
+							Name:    "util",
+							Image:   c.utilImage,
+							Command: []string{"/bin/cp", "-Rv", "/bin/cpb", "/util/cpb"}, // Copy tooling for the bundle container to use
+							VolumeMounts: []corev1.VolumeMount{
+								{
+									Name:      "util",
+									MountPath: "/util",
+								},
+							},
+						},
+						{
+							Name:    "pull",
+							Image:   bundlePath,
+							Command: []string{"/util/cpb", "/bundle"}, // Copy bundle content to its mount
 							VolumeMounts: []corev1.VolumeMount{
 								{
-									Name:      "copydir",
-									MountPath: "/copy-dest",
+									Name:      "bundle",
+									MountPath: "/bundle",
+								},
+								{
+									Name:      "util",
+									MountPath: "/util",
 								},
 							},
 						},
 					},
 					Volumes: []corev1.Volume{
 						{
-							Name: "copydir",
+							Name: "bundle", // Used to share bundle content
+							VolumeSource: corev1.VolumeSource{
+								EmptyDir: &corev1.EmptyDirVolumeSource{},
+							},
+						},
+						{
+							Name: "util", // Used to share utils
 							VolumeSource: corev1.VolumeSource{
 								EmptyDir: &corev1.EmptyDirVolumeSource{},
 							},
@@ -110,7 +131,8 @@ type Unpacker interface {
 }
 
 type ConfigMapUnpacker struct {
-	copyImage  string
+	opmImage   string
+	utilImage  string
 	client     kubernetes.Interface
 	csLister   listersoperatorsv1alpha1.CatalogSourceLister
 	cmLister   listerscorev1.ConfigMapLister
@@ -136,9 +158,15 @@ func NewConfigmapUnpacker(options ...ConfigMapUnpackerOption) (*ConfigMapUnpacke
 	return unpacker, nil
 }
 
-func WithCopyImage(copyImage string) ConfigMapUnpackerOption {
+func WithOPMImage(opmImage string) ConfigMapUnpackerOption {
+	return func(unpacker *ConfigMapUnpacker) {
+		unpacker.opmImage = opmImage
+	}
+}
+
+func WithUtilImage(utilImage string) ConfigMapUnpackerOption {
 	return func(unpacker *ConfigMapUnpacker) {
-		unpacker.copyImage = copyImage
+		unpacker.utilImage = utilImage
 	}
 }
 
@@ -192,8 +220,10 @@ func (c *ConfigMapUnpacker) apply(options ...ConfigMapUnpackerOption) {
 
 func (c *ConfigMapUnpacker) validate() (err error) {
 	switch {
-	case c.copyImage == "":
-		err = fmt.Errorf("no copy image given")
+	case c.opmImage == "":
+		err = fmt.Errorf("no opm image given")
+	case c.utilImage == "":
+		err = fmt.Errorf("no util image given")
 	case c.client == nil:
 		err = fmt.Errorf("client is nil")
 	case c.csLister == nil: