run --olm: support metadata/annotations.yaml (#2840)

Author: estroz

CHANGELOG.md

@@ -15,6 +15,7 @@
 - Add support to release SDK arm64 binaries and images. ([#2742](https://github.com/operator-framework/operator-sdk/pull/2715))
 - Add annotation `helm.operator-sdk/upgrade-force: "True"` to allow force resources replacement (`helm upgrade --force`) for Helm based-operators. ([#2773](https://github.com/operator-framework/operator-sdk/pull/2773))
 - The [`--make-manifests`](website/content/en/docs/cli/operator-sdk_generate_csv.md#options) flag directs `operator-sdk generate csv` to create a `manifests/` directory for the latest operator bundle, including CRDs. This flag is set by default. ([#2776](https://github.com/operator-framework/operator-sdk/pull/2776))
+- `operator-sdk run --olm` supports the new operator metadata format in `metadata/annotations.yaml`. ([#2840](https://github.com/operator-framework/operator-sdk/issues/2839))
 
 ### Changed
 

go.mod

@@ -55,6 +55,7 @@ require (
 	k8s.io/kubectl v0.17.4
 	sigs.k8s.io/controller-runtime v0.5.2
 	sigs.k8s.io/controller-tools v0.2.8
+	sigs.k8s.io/yaml v1.1.0
 )
 
 replace (

hack/tests/integration.sh

@@ -4,7 +4,7 @@ set -eu
 
 source hack/lib/image_lib.sh
 
-export OSDK_INTEGRATION_IMAGE="quay.io/example/memcached-operator:v0.0.1"
+export OSDK_INTEGRATION_IMAGE="quay.io/example/memcached-operator:v0.0.2"
 
 # Build the operator image.
 pushd test/test-framework

internal/olm/operator/internal/configmap.go

@@ -30,12 +30,6 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 )
 
-const (
-	// The directory containing all manifests for an operator, with the
-	// package manifest being top-level.
-	containerManifestsDir = "/registry/manifests"
-)
-
 // IsManifestDataStale checks if manifest data stored in the registry is stale
 // by comparing it to manifest data currently managed by m.
 func (m *RegistryResources) IsManifestDataStale(ctx context.Context, namespace string) (bool, error) {

internal/olm/operator/internal/registry.go

@@ -25,6 +25,12 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 )
 
+const (
+	// The directory containing all manifests for an operator, with the
+	// package manifest being top-level.
+	containerManifestsDir = "/registry/manifests"
+)
+
 // SDKLabels are used to identify certain operator-sdk resources.
 var SDKLabels = map[string]string{
 	"owner": "operator-sdk",

internal/olm/operator/manager.go

@@ -19,24 +19,28 @@ import (
 	"errors"
 	"fmt"
 	"io/ioutil"
+	"os"
+	"path/filepath"
 
 	"github.com/operator-framework/operator-sdk/internal/olm"
 	olmresourceclient "github.com/operator-framework/operator-sdk/internal/olm/client"
 	opinternal "github.com/operator-framework/operator-sdk/internal/olm/operator/internal"
 	"github.com/operator-framework/operator-sdk/internal/util/k8sutil"
 
-	manifests "github.com/operator-framework/api/pkg/manifests"
+	"github.com/operator-framework/api/pkg/manifests"
 	valerrors "github.com/operator-framework/api/pkg/validation/errors"
 	olmapiv1 "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1"
 	olmapiv1alpha1 "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
-	registry "github.com/operator-framework/operator-registry/pkg/registry"
+	"github.com/operator-framework/operator-registry/pkg/lib/bundle"
+	"github.com/operator-framework/operator-registry/pkg/registry"
 	log "github.com/sirupsen/logrus"
 	apiextinstall "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/install"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/kubernetes/scheme"
+	"sigs.k8s.io/yaml"
 )
 
 const defaultNamespace = "default"
@@ -71,14 +75,17 @@ func (c *OLMCmd) newManager() (*operatorManager, error) {
 		version:       c.OperatorVersion,
 		forceRegistry: c.ForceRegistry,
 	}
-	rc, ns, err := k8sutil.GetKubeconfigAndNamespace(c.KubeconfigPath)
-	if err != nil {
-		return nil, fmt.Errorf("failed to get namespace from kubeconfig %s: %w", c.KubeconfigPath, err)
-	}
+
+	// Namespace in which OLM is deployed.
 	if m.olmNamespace = c.OLMNamespace; m.olmNamespace == "" {
 		m.olmNamespace = olm.DefaultOLMNamespace
 	}
 
+	// Cluster and operator namespace info.
+	rc, ns, err := k8sutil.GetKubeconfigAndNamespace(c.KubeconfigPath)
+	if err != nil {
+		return nil, fmt.Errorf("failed to get namespace from kubeconfig %s: %w", c.KubeconfigPath, err)
+	}
 	if ns == "" {
 		ns = defaultNamespace
 	}
@@ -91,6 +98,8 @@ func (c *OLMCmd) newManager() (*operatorManager, error) {
 			return nil, fmt.Errorf("failed to create SDK OLM client: %w", err)
 		}
 	}
+
+	// Parse k8s objects.
 	for _, path := range c.IncludePaths {
 		if path != "" {
 			objs, err := readObjectsFromFile(path)
@@ -108,7 +117,10 @@ func (c *OLMCmd) newManager() (*operatorManager, error) {
 	if hasSub || hasCatSrc && !(hasSub && hasCatSrc) {
 		return nil, errors.New("both a CatalogSource and Subscription must be supplied if one is supplied")
 	}
-	pkg, bundles, results := manifests.GetManifestsDir(c.ManifestsDir)
+
+	// Operator bundles and metadata.
+	var results []valerrors.ManifestResult
+	m.pkg, m.bundles, results = manifests.GetManifestsDir(c.ManifestsDir)
 	if len(results) != 0 {
 		badResults := []valerrors.ManifestResult{}
 		for _, result := range results {
@@ -120,7 +132,17 @@ func (c *OLMCmd) newManager() (*operatorManager, error) {
 			return nil, fmt.Errorf("bundle dir had errors: %s", badResults)
 		}
 	}
-	m.pkg, m.bundles = pkg, bundles
+	// Prefer annotations over a package manifest, which is now deprecated.
+	if annotations, err := findAnnotations(c.ManifestsDir); err == nil {
+		m.pkg = translateAnnotationsToPackage(annotations, fmt.Sprintf("%s.v%s", annotations.GetName(), m.version))
+	} else if !os.IsNotExist(err) {
+		return nil, fmt.Errorf("error finding annotations: %v", err)
+	}
+	if m.pkg.PackageName == "" {
+		return nil, errors.New("no package metadata found")
+	}
+
+	// Handle installModes.
 	if c.InstallMode == "" {
 		// Default to OwnNamespace.
 		m.installMode = olmapiv1alpha1.InstallModeTypeOwnNamespace
@@ -134,15 +156,51 @@ func (c *OLMCmd) newManager() (*operatorManager, error) {
 	if err := m.installModeCompatible(m.installMode); err != nil {
 		return nil, err
 	}
+
 	return m, nil
 }
 
+// findAnnotations returns annotations metadata from '<dir>/metadata/annotations.yaml'.
+func findAnnotations(dir string) (annotations registry.AnnotationsFile, err error) {
+	annotationsPath := filepath.Join(dir, bundle.MetadataDir, bundle.AnnotationsFile)
+	b, err := ioutil.ReadFile(annotationsPath)
+	if err != nil {
+		return annotations, err
+	}
+	if err = yaml.Unmarshal(b, &annotations); err != nil {
+		return annotations, err
+	}
+	return annotations, nil
+}
+
+// translateAnnotationsToPackage creates a package manifest from an annotations
+// file. We use this workaround because registry-server will not populate the
+// database directory from an annotations.yaml file. This is what an index image
+// build does:
+// https://github.com/operator-framework/operator-registry/blob/v1.9.0/pkg/registry/populator.go#L285
+func translateAnnotationsToPackage(annotations registry.AnnotationsFile, csvName string) registry.PackageManifest {
+	pkg := registry.PackageManifest{
+		PackageName:        annotations.GetName(),
+		DefaultChannelName: annotations.GetDefaultChannelName(),
+	}
+
+	for _, channel := range annotations.GetChannels() {
+		pkg.Channels = append(pkg.Channels, registry.PackageChannel{
+			Name:           channel,
+			CurrentCSVName: csvName,
+		})
+	}
+
+	return pkg
+}
+
 func (m *operatorManager) run(ctx context.Context) (err error) {
 	// Ensure OLM is installed.
 	olmVer, err := m.client.GetInstalledVersion(ctx, m.olmNamespace)
 	if err != nil {
 		return fmt.Errorf("error getting installed OLM version: %w", err)
 	}
+
 	pkgName := m.pkg.PackageName
 	bundle, err := getBundleForVersion(m.bundles, m.version)
 	if err != nil {
@@ -152,6 +210,7 @@ func (m *operatorManager) run(ctx context.Context) (err error) {
 	if err != nil {
 		return fmt.Errorf("error getting CSV from bundle: %w", err)
 	}
+
 	// Only check CSV here, since other deployed operators/versions may be
 	// running with shared CRDs.
 	obj, err := runtime.DefaultUnstructuredConverter.ToUnstructured(csv)
@@ -169,6 +228,7 @@ func (m *operatorManager) run(ctx context.Context) (err error) {
 	if err = m.registryUp(ctx, m.olmNamespace); err != nil {
 		return fmt.Errorf("error creating registry resources: %w", err)
 	}
+
 	log.Info("Creating resources")
 	if !m.hasCatalogSource() {
 		registryGRPCAddr := opinternal.GetRegistryServiceAddr(pkgName, m.olmNamespace)
@@ -205,6 +265,7 @@ func (m *operatorManager) run(ctx context.Context) (err error) {
 	if err = m.client.DoCreate(ctx, objects...); err != nil {
 		return fmt.Errorf("error creating operator resources: %w", err)
 	}
+
 	// BUG(estroz): if m.namespace is not contained in m.installModeNamespaces,
 	// DoCSVWait will fail.
 	nn := types.NamespacedName{
@@ -234,6 +295,7 @@ func (m *operatorManager) cleanup(ctx context.Context) (err error) {
 	if err != nil {
 		return fmt.Errorf("error getting installed OLM version: %w", err)
 	}
+
 	pkgName := m.pkg.PackageName
 	bundle, err := getBundleForVersion(m.bundles, m.version)
 	if err != nil {
@@ -247,6 +309,7 @@ func (m *operatorManager) cleanup(ctx context.Context) (err error) {
 	if err = m.registryDown(ctx, m.olmNamespace); err != nil {
 		return fmt.Errorf("error removing registry resources: %w", err)
 	}
+
 	log.Info("Deleting resources")
 	if !m.hasCatalogSource() {
 		m.olmObjects = append(m.olmObjects, newCatalogSource(pkgName, m.namespace))
@@ -287,6 +350,7 @@ func (m operatorManager) registryUp(ctx context.Context, namespace string) error
 		Pkg:     m.pkg,
 		Bundles: m.bundles,
 	}
+
 	registryStale, err := rr.IsManifestDataStale(ctx, namespace)
 	if err != nil {
 		if !apierrors.IsNotFound(err) {
@@ -310,6 +374,7 @@ func (m operatorManager) registryUp(ctx context.Context, namespace string) error
 	if err = rr.CreateRegistryManifests(ctx, namespace); err != nil {
 		return fmt.Errorf("error registering bundle: %w", err)
 	}
+
 	return nil
 }
 
@@ -319,12 +384,14 @@ func (m *operatorManager) registryDown(ctx context.Context, namespace string) er
 		Pkg:     m.pkg,
 		Bundles: m.bundles,
 	}
+
 	if m.forceRegistry {
 		log.Printf("Deleting registry")
 		if err := rr.DeleteRegistryManifests(ctx, namespace); err != nil {
 			return fmt.Errorf("error deleting registered bundle: %w", err)
 		}
 	}
+
 	return nil
 }
 

internal/olm/operator/operator.go

@@ -36,10 +36,10 @@ const (
 // OLMCmd configures deployment and teardown of an operator via an OLM
 // installation existing on a cluster.
 type OLMCmd struct { // nolint:golint
-	// ManifestsDir is a directory containing a package manifest and N bundles
-	// of the operator's CSV and CRD's. OperatorVersion can be set to the
-	// version of the desired operator version's subdir and Run()/Cleanup() will
-	// deploy the operator version in that subdir.
+	// ManifestsDir is a directory containing 1..N bundle directories and either
+	// a package manifest or metadata/annotations.yaml. OperatorVersion can be
+	// set to the version of the desired operator bundle and Run()/Cleanup() will
+	// deploy that operator version.
 	ManifestsDir string
 	// OperatorVersion is the version of the operator to deploy. It must be
 	// a semantic version, ex. 0.0.1.
@@ -93,11 +93,10 @@ func (c *OLMCmd) AddToFlagSet(fs *pflag.FlagSet) {
 	fs.StringVar(&c.OLMNamespace, "olm-namespace", olm.DefaultOLMNamespace,
 		prefix+"The namespace where OLM is installed")
 	fs.StringVar(&c.OperatorNamespace, "operator-namespace", "",
-		prefix+"The namespace where operator resources are created in --olm mode. It "+
-			"must already exist in the cluster or be defined in"+
-			" a manifest passed to IncludePaths.")
+		prefix+"The namespace where operator resources are created. It must already exist "+
+			"in the cluster or be defined in a manifest passed to --include")
 	fs.StringVar(&c.ManifestsDir, "manifests", "",
-		prefix+"Directory containing package manifest and operator bundles.")
+		prefix+"Directory containing operator bundle directories and metadata")
 	fs.StringVar(&c.OperatorVersion, "operator-version", "",
 		prefix+"Version of operator to deploy")
 	fs.StringVar(&c.InstallMode, "install-mode", "",