[v1.0.x] *: fix run packagemanifests (#3895)

Author: joelanford

changelog/fragments/fix-run-packagemanifests-e2e.yaml

@@ -0,0 +1,17 @@
+entries:
+  - description:
+      Fixed a bug with `run packagemanifests` that caused the underlying
+      registry pod to fail to start. Changed the registry pod image from
+      `quay.io/openshift/origin-operator-registry:latest` to
+      `quay.io/operator-framework/upstream-registry-builder:latest`
+
+    # kind is one of:
+    # - addition
+    # - change
+    # - deprecation
+    # - removal
+    # - bugfix
+    kind: bugfix
+
+    # Is this a breaking change?
+    breaking: false

changelog/fragments/run-pkgmnfs-writable-dir.yaml

@@ -0,0 +1,5 @@
+entries:
+  - description: >
+      Fix an issue in `run packagemanifests` where the registry server
+      writes files in locations that require root.
+    kind: bugfix

hack/tests/integration.sh

@@ -42,7 +42,7 @@ popd
 # Install OLM on the cluster if not installed.
 olm_latest_exists=0
 if ! operator-sdk olm status > /dev/null 2>&1; then
-  operator-sdk olm install
+  operator-sdk olm install --version=0.15.1
   olm_latest_exists=1
 fi
 
@@ -58,5 +58,5 @@ header_text "Integration tests succeeded"
 
 # Uninstall OLM if it was installed for test purposes.
 if eval "(( $olm_latest_exists ))"; then
-  operator-sdk olm uninstall
+  operator-sdk olm uninstall --version=0.15.1
 fi

internal/olm/client/client.go

@@ -211,7 +211,15 @@ func (c Client) DoCSVWait(ctx context.Context, key types.NamespacedName) error {
 			curPhase = newPhase
 			log.Printf("  Found ClusterServiceVersion %q phase: %s", key, curPhase)
 		}
-		return curPhase == olmapiv1alpha1.CSVPhaseSucceeded, nil
+
+		switch curPhase {
+		case olmapiv1alpha1.CSVPhaseFailed:
+			return false, fmt.Errorf("csv failed: reason: %q, message: %q", csv.Status.Reason, csv.Status.Message)
+		case olmapiv1alpha1.CSVPhaseSucceeded:
+			return true, nil
+		default:
+			return false, nil
+		}
 	}
 
 	return wait.PollImmediateUntil(time.Second, csvPhaseSucceeded, ctx.Done())

internal/olm/operator/internal/deployment.go

@@ -17,25 +17,26 @@ package olm
 import (
 	"fmt"
 
-	"github.com/operator-framework/operator-sdk/internal/util/k8sutil"
-
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	"github.com/operator-framework/operator-sdk/internal/util/k8sutil"
 )
 
 const (
 	// The image operator-registry's initializer and registry-server binaries
 	// are run from.
 	// QUESTION(estroz): version registry image?
-	registryBaseImage = "quay.io/openshift/origin-operator-registry:latest"
+	registryBaseImage = "quay.io/operator-framework/upstream-registry-builder:latest"
 	// The port registry-server will listen on within a container.
 	registryGRPCPort = 50051
-	// Path of the bundle database generated by initializer.
-	regisryDBName = "bundle.db"
-	// Path of the log file generated by registry-server.
-	// TODO(estroz): have this log file in an obvious place, ex. /var/log.
-	registryLogFile = "termination.log"
+	// Path of the bundle database generated by initializer. Use /tmp since it is
+	// typically world-writable.
+	registryDBName = "/tmp/bundle.db"
+	// Path of the log file generated by registry-server. Use /tmp since it is
+	// typically world-writable.
+	registryLogFile = "/tmp/termination.log"
 )
 
 func getRegistryServerName(pkgName string) string {
@@ -99,13 +100,12 @@ func withContainerVolumeMounts(volName string, paths ...string) func(*appsv1.Dep
 }
 
 // getDBContainerCmd returns a command string that, when run, does two things:
-// 1. Runs a database initializer on the manifests in the current working
+// 1. Runs a database initializer on the manifests in the /registry
 //    directory.
 // 2. Runs an operator-registry server serving the bundle database.
-// The database must be in the current working directory.
 func getDBContainerCmd(dbPath, logPath string) string {
-	initCmd := fmt.Sprintf("/usr/bin/initializer -o %s", dbPath)
-	srvCmd := fmt.Sprintf("/usr/bin/registry-server -d %s -t %s", dbPath, logPath)
+	initCmd := fmt.Sprintf("/bin/initializer -o %s -m %s", dbPath, containerManifestsDir)
+	srvCmd := fmt.Sprintf("/bin/registry-server -d %s -t %s", dbPath, logPath)
 	return fmt.Sprintf("%s && %s", initCmd, srvCmd)
 }
 
@@ -114,13 +114,14 @@ func getDBContainerCmd(dbPath, logPath string) string {
 // pod template spec.
 func withRegistryGRPCContainer(pkgName string) func(*appsv1.Deployment) {
 	container := corev1.Container{
-		Name:    getRegistryServerName(pkgName),
-		Image:   registryBaseImage,
-		Command: []string{"/bin/bash"},
+		Name:       getRegistryServerName(pkgName),
+		Image:      registryBaseImage,
+		WorkingDir: "/tmp",
+		Command:    []string{"/bin/sh"},
 		Args: []string{
 			"-c",
 			// TODO(estroz): grab logs and print if error
-			getDBContainerCmd(regisryDBName, registryLogFile),
+			getDBContainerCmd(registryDBName, registryLogFile),
 		},
 		Ports: []corev1.ContainerPort{
 			{Name: "registry-grpc", ContainerPort: registryGRPCPort},

test/e2e-helm/e2e_helm_olm_test.go

@@ -16,7 +16,6 @@ package e2e_helm_test
 
 import (
 	"os/exec"
-	"path"
 	"path/filepath"
 	"strings"
 
@@ -44,16 +43,18 @@ var _ = Describe("Integrating Helm Projects with OLM", func() {
 			By("building the operator bundle image")
 			// Use the existing image tag but with a "-bundle" suffix.
 			imageSplit := strings.SplitN(tc.ImageName, ":", 2)
-			bundleImage := path.Join("quay.io", imageSplit[0]+"-bundle")
+			bundleImage := imageSplit[0] + "-bundle"
 			if len(imageSplit) == 2 {
 				bundleImage += ":" + imageSplit[1]
 			}
 			err = tc.Make("bundle-build", "BUNDLE_IMG="+bundleImage)
 			Expect(err).NotTo(HaveOccurred())
 
-			By("loading the project image into Kind cluster")
-			err = tc.LoadImageToKindClusterWithName(bundleImage)
-			Expect(err).Should(Succeed())
+			if isRunningOnKind() {
+				By("loading the bundle image into Kind cluster")
+				err = tc.LoadImageToKindClusterWithName(bundleImage)
+				Expect(err).Should(Succeed())
+			}
 
 			By("adding the 'packagemanifests' rule to the Makefile")
 			err = tc.AddPackagemanifestsTarget()

test/e2e/e2e_suite_test.go

@@ -182,7 +182,7 @@ var _ = Describe("operator-sdk", func() {
 			By("building the operator bundle image")
 			// Use the existing image tag but with a "-bundle" suffix.
 			imageSplit := strings.SplitN(tc.ImageName, ":", 2)
-			bundleImage := path.Join("quay.io", imageSplit[0]+"-bundle")
+			bundleImage := imageSplit[0] + "-bundle"
 			if len(imageSplit) == 2 {
 				bundleImage += ":" + imageSplit[1]
 			}