feat(registry): Add operator version dependency metadata

The operator-version based dependency information can be added to
a bundle via dependencies.yaml in /metadata. The dependencies info
will be parsed and is added to the DB in a new table named
`dependencies`. Each dependency entry is linked to a specific operator
bundle that it belongs to.

A new registry API `ListBundles` is added to return all available
bundles in the database. This information is to serve as input to
the new resolver.

Signed-off-by: Vu Dinh <[email protected]>

Author: dinhxuanvu

pkg/api/registry.proto

@@ -12,6 +12,7 @@ service Registry {
 	rpc GetChannelEntriesThatProvide(GetAllProvidersRequest) returns (stream ChannelEntry) {}
 	rpc GetLatestChannelEntriesThatProvide(GetLatestProvidersRequest) returns (stream ChannelEntry) {}
 	rpc GetDefaultBundleThatProvides(GetDefaultProviderRequest) returns (Bundle) {}
+  rpc ListBundles() returns (stream Bundle) {}
 }
 
 
@@ -37,6 +38,14 @@ message GroupVersionKind{
 	string plural = 4;
 }
 
+message Dependency{
+  string type = 1;
+  string name = 2;
+  string group = 3;
+  string version = 4;
+  string kind = 5;
+}
+
 message Bundle{
 	string csvName = 1;
 	string packageName = 2;
@@ -48,6 +57,7 @@ message Bundle{
 	repeated GroupVersionKind requiredApis = 8;
 	string version = 9;
 	string skipRange = 10;
+  repeated Dependency dependencies = 11;
 }
 
 message ChannelEntry{
@@ -104,4 +114,3 @@ message GetDefaultProviderRequest{
 	string kind = 3;
 	string plural = 4;
 }
-

pkg/registry/bundle.go

@@ -28,14 +28,15 @@ func init() {
 }
 
 type Bundle struct {
-	Name        string
-	Objects     []*unstructured.Unstructured
-	Package     string
-	Channels    []string
-	BundleImage string
-	csv         *ClusterServiceVersion
-	crds        []*v1beta1.CustomResourceDefinition
-	cacheStale  bool
+	Name         string
+	Objects      []*unstructured.Unstructured
+	Package      string
+	Channels     []string
+	BundleImage  string
+	csv          *ClusterServiceVersion
+	crds         []*v1beta1.CustomResourceDefinition
+	Dependencies []Dependency
+	cacheStale   bool
 }
 
 func NewBundle(name, pkgName string, channels []string, objs ...*unstructured.Unstructured) *Bundle {

pkg/registry/interface.go

@@ -51,6 +51,10 @@ type Query interface {
 	ListChannels(ctx context.Context, pkgName string) ([]string, error)
 	// Get CurrentCSV name for channel and package
 	GetCurrentCSVNameForChannel(ctx context.Context, pkgName, channel string) (string, error)
+	// List all available bundles in the database
+	ListBundles(ctx context.Context) (bundles []*api.Bundle, err error)
+	// Get the list of dependencies for a bundle
+	GetDependenciesForBundle(ctx context.Context, name, version, path string) (dependencies []*api.Dependency, err error)
 }
 
 // GraphLoader generates a graph

pkg/registry/types.go

@@ -114,6 +114,71 @@ type Annotations struct {
 	DefaultChannelName string `json:"operators.operatorframework.io.bundle.channel.default.v1" yaml:"operators.operatorframework.io.bundle.channel.default.v1"`
 }
 
+// DependenciesFile holds dependency information about a bundle
+type DependenciesFile struct {
+	// Dependencies is a list of dependencies for a given bundle
+	Dependencies []Dependency `json:"dependencies" yaml:"dependencies"`
+}
+
+// Dependencies is a list of dependencies for a given bundle
+type Dependency struct {
+	// The type of dependency. It can be `olm.package` for operator-version based
+	// dependency or `olm.gvk` for gvk based dependency. This field is required.
+	Type string `json:"type" yaml:"type"`
+
+	// The name of dependency such as 'etcd'. This field is required.
+	Name string `json:"name" yaml:"name"`
+
+	// The group of GVK based dependency.
+	Group string `json:"group,omitempty" yaml:"group"`
+
+	// The kind of GVK based dependency.
+	Kind string `json:"kind,omitempty" yaml:"kind"`
+
+	// The version of dependency in semver format
+	Version string `json:"version" yaml:"version"`
+}
+
+// GetType returns the type of dependency
+func (e *Dependency) GetType() string {
+	if e.Type != "" {
+		return e.Type
+	}
+	return ""
+}
+
+// GetName returns the package name of dependency
+func (e *Dependency) GetName() string {
+	if e.Name != "" {
+		return e.Name
+	}
+	return ""
+}
+
+// GetGroup returns the group name of dependency
+func (e *Dependency) GetGroup() string {
+	if e.Group != "" {
+		return e.Group
+	}
+	return ""
+}
+
+// GetKind returns the kind of dependency
+func (e *Dependency) GetKind() string {
+	if e.Kind != "" {
+		return e.Kind
+	}
+	return ""
+}
+
+// GetVersion returns the version of dependency
+func (e *Dependency) GetVersion() string {
+	if e.Version != "" {
+		return e.Version
+	}
+	return ""
+}
+
 // GetName returns the package name of the bundle
 func (a *AnnotationsFile) GetName() string {
 	if a.Annotations.PackageName != "" {