Add commands to list and get olmv1 operators and catalogs

Signed-off-by: Artur Zych <[email protected]>

Author: azych

go.mod

@@ -11,6 +11,7 @@ require (
 	github.com/onsi/gomega v1.36.2
 	github.com/opencontainers/image-spec v1.1.0
 	github.com/operator-framework/api v0.29.0
+	github.com/operator-framework/catalogd v1.1.0
 	github.com/operator-framework/operator-controller v1.1.0
 	github.com/operator-framework/operator-lifecycle-manager v0.23.1
 	github.com/operator-framework/operator-registry v1.50.0

go.sum

@@ -242,6 +242,8 @@ github.com/opencontainers/runtime-spec v1.2.0 h1:z97+pHb3uELt/yiAWD691HNHQIF07bE
 github.com/opencontainers/runtime-spec v1.2.0/go.mod h1:jwyrGlmzljRJv/Fgzds9SsS/C5hL+LL3ko9hs6T5lQ0=
 github.com/operator-framework/api v0.29.0 h1:TxAR8RCO+I4FjRrY4PSMgnlmbxNWeD8pzHXp7xwHNmw=
 github.com/operator-framework/api v0.29.0/go.mod h1:0whQE4mpMDd2zyHkQe+bFa3DLoRs6oGWCbu8dY/3pyc=
+github.com/operator-framework/catalogd v1.1.0 h1:mu2DYL5mpREEAAP+uPG+CMSsfsJkgrIasgLRG8nvwJg=
+github.com/operator-framework/catalogd v1.1.0/go.mod h1:8Je9CqMPwhNgRoqGX5OPsLYHsEoTDvPnELLLKRw1RHE=
 github.com/operator-framework/operator-controller v1.1.0 h1:h0b1SSuv9ZiIgI8dTuutSPVL4uIeyvTW3gOB2szkBMQ=
 github.com/operator-framework/operator-controller v1.1.0/go.mod h1:dJIt5/gfm1n3y9IeX4kpSlpu4CFq8WFVHU2n9ZDVUkA=
 github.com/operator-framework/operator-lifecycle-manager v0.23.1 h1:Xw2ml1T4W2ieoFaVwanW/eFlZ11yAOJZUpUI8RLSql8=

internal/cmd/internal/olmv1/catalog_installed_get.go

@@ -0,0 +1,38 @@
+package olmv1
+
+import (
+	"github.com/spf13/cobra"
+
+	"github.com/operator-framework/kubectl-operator/internal/cmd/internal/log"
+	v1action "github.com/operator-framework/kubectl-operator/internal/pkg/v1/action"
+	"github.com/operator-framework/kubectl-operator/pkg/action"
+)
+
+// NewCatalogInstalledGetCmd handles get commands in the form of:
+// catalog(s) [operatorName] - this will either list all the installed operators
+// if no operatorName has been provided or display the details of the specific
+// one otherwise
+func NewCatalogInstalledGetCmd(cfg *action.Configuration) *cobra.Command {
+	i := v1action.NewCatalogInstalledGet(cfg)
+	i.Logf = log.Printf
+
+	cmd := &cobra.Command{
+		Use:     "catalog",
+		Aliases: []string{"catalogs"},
+		Args:    cobra.RangeArgs(0, 1),
+		Short:   "Display one or many installed catalogs",
+		Run: func(cmd *cobra.Command, args []string) {
+			if len(args) == 1 {
+				i.CatalogName = args[0]
+			}
+			installedCatalogs, err := i.Run(cmd.Context())
+			if err != nil {
+				log.Fatalf("failed getting installed catalog(s): %v", err)
+			}
+
+			printFormattedCatalogs(installedCatalogs...)
+		},
+	}
+
+	return cmd
+}

internal/cmd/internal/olmv1/operator_installed_get.go

@@ -0,0 +1,38 @@
+package olmv1
+
+import (
+	"github.com/spf13/cobra"
+
+	"github.com/operator-framework/kubectl-operator/internal/cmd/internal/log"
+	v1action "github.com/operator-framework/kubectl-operator/internal/pkg/v1/action"
+	"github.com/operator-framework/kubectl-operator/pkg/action"
+)
+
+// NewOperatorInstalledGetCmd handles get commands in the form of:
+// operator(s) [operatorName] - this will either list all the installed operators
+// if no operatorName has been provided or display the details of the specific
+// one otherwise
+func NewOperatorInstalledGetCmd(cfg *action.Configuration) *cobra.Command {
+	i := v1action.NewOperatorInstalledGet(cfg)
+	i.Logf = log.Printf
+
+	cmd := &cobra.Command{
+		Use:     "operator",
+		Aliases: []string{"operators"},
+		Args:    cobra.RangeArgs(0, 1),
+		Short:   "Display one or many installed operators",
+		Run: func(cmd *cobra.Command, args []string) {
+			if len(args) == 1 {
+				i.OperatorName = args[0]
+			}
+			installedExtensions, err := i.Run(cmd.Context())
+			if err != nil {
+				log.Fatalf("failed getting installed operator(s): %v", err)
+			}
+
+			printFormattedOperators(installedExtensions...)
+		},
+	}
+
+	return cmd
+}

internal/cmd/internal/olmv1/printing.go

@@ -0,0 +1,78 @@
+package olmv1
+
+import (
+	"cmp"
+	"fmt"
+	"os"
+	"slices"
+	"text/tabwriter"
+	"time"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/util/duration"
+
+	catalogdv1 "github.com/operator-framework/catalogd/api/v1"
+	olmv1 "github.com/operator-framework/operator-controller/api/v1"
+)
+
+func printFormattedOperators(extensions ...olmv1.ClusterExtension) {
+	tw := tabwriter.NewWriter(os.Stdout, 3, 4, 2, ' ', 0)
+	_, _ = fmt.Fprint(tw, "NAME\tINSTALLED BUNDLE\tVERSION\tSOURCE TYPE\tINSTALLED\tPROGRESSING\tAGE\n")
+
+	// sort by name
+	slices.SortFunc(extensions, func(a, b olmv1.ClusterExtension) int {
+		return cmp.Compare(a.Name, b.Name)
+	})
+
+	for _, ext := range extensions {
+		age := time.Since(ext.CreationTimestamp.Time)
+		_, _ = fmt.Fprintf(tw, "%s\t%s\t%s\t%s\t%s\t%s\t%s\n",
+			ext.Name,
+			ext.Status.Install.Bundle.Name,
+			ext.Status.Install.Bundle.Version,
+			ext.Spec.Source.SourceType,
+			status(ext.Status.Conditions, olmv1.TypeInstalled),
+			status(ext.Status.Conditions, olmv1.TypeProgressing),
+			duration.HumanDuration(age),
+		)
+	}
+	_ = tw.Flush()
+}
+
+func printFormattedCatalogs(catalogs ...catalogdv1.ClusterCatalog) {
+	tw := tabwriter.NewWriter(os.Stdout, 3, 4, 2, ' ', 0)
+	_, _ = fmt.Fprint(tw, "NAME\tAVAILABILITY\tPRIORITY\tLASTUNPACKED\tSERVING\tAGE\n")
+
+	// sort by availability first, then by priority and name
+	slices.SortFunc(catalogs, func(a, b catalogdv1.ClusterCatalog) int {
+		return cmp.Or(
+			cmp.Compare(a.Spec.AvailabilityMode, a.Spec.AvailabilityMode),
+			cmp.Compare(a.Spec.Priority, b.Spec.Priority),
+			cmp.Compare(a.Name, b.Name),
+		)
+	})
+
+	for _, cat := range catalogs {
+		age := time.Since(cat.CreationTimestamp.Time)
+		lastUnpacked := time.Since(cat.Status.LastUnpacked.Time)
+		_, _ = fmt.Fprintf(tw, "%s\t%s\t%d\t%s\t%s\t%s\n",
+			cat.Name,
+			string(cat.Spec.AvailabilityMode),
+			cat.Spec.Priority,
+			duration.HumanDuration(lastUnpacked),
+			status(cat.Status.Conditions, catalogdv1.TypeServing),
+			duration.HumanDuration(age),
+		)
+	}
+	_ = tw.Flush()
+}
+
+func status(conditions []metav1.Condition, typ string) string {
+	for _, condition := range conditions {
+		if condition.Type == typ {
+			return string(condition.Status)
+		}
+	}
+
+	return "Unknown"
+}

internal/cmd/olmv1.go

@@ -14,9 +14,20 @@ func newOlmV1Cmd(cfg *action.Configuration) *cobra.Command {
 		Long:  "Manage operators via OLMv1 in a cluster from the command line.",
 	}
 
+	getCmd := &cobra.Command{
+		Use:   "get",
+		Short: "Display one or many OLMv1-specific resource(s)",
+		Long:  "Display one or many OLMv1-specific resource(s)",
+	}
+	getCmd.AddCommand(
+		olmv1.NewOperatorInstalledGetCmd(cfg),
+		olmv1.NewCatalogInstalledGetCmd(cfg),
+	)
+
 	cmd.AddCommand(
 		olmv1.NewOperatorInstallCmd(cfg),
 		olmv1.NewOperatorUninstallCmd(cfg),
+		getCmd,
 	)
 
 	return cmd

internal/pkg/v1/action/catalog_installed_get.go

@@ -0,0 +1,44 @@
+package action
+
+import (
+	"context"
+
+	"k8s.io/apimachinery/pkg/types"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	olmv1catalogd "github.com/operator-framework/catalogd/api/v1"
+
+	"github.com/operator-framework/kubectl-operator/pkg/action"
+)
+
+type CatalogInstalledGet struct {
+	config      *action.Configuration
+	CatalogName string
+
+	Logf func(string, ...interface{})
+}
+
+func NewCatalogInstalledGet(cfg *action.Configuration) *CatalogInstalledGet {
+	return &CatalogInstalledGet{
+		config: cfg,
+		Logf:   func(string, ...interface{}) {},
+	}
+}
+
+func (i *CatalogInstalledGet) Run(ctx context.Context) ([]olmv1catalogd.ClusterCatalog, error) {
+	// get
+	if i.CatalogName != "" {
+		var result olmv1catalogd.ClusterCatalog
+
+		opKey := types.NamespacedName{Name: i.CatalogName}
+		err := i.config.Client.Get(ctx, opKey, &result)
+
+		return []olmv1catalogd.ClusterCatalog{result}, err
+	}
+
+	// list
+	var result olmv1catalogd.ClusterCatalogList
+	err := i.config.Client.List(ctx, &result, &client.ListOptions{})
+
+	return result.Items, err
+}

internal/pkg/v1/action/operator_installed_get.go

@@ -0,0 +1,43 @@
+package action
+
+import (
+	"context"
+
+	"k8s.io/apimachinery/pkg/types"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	olmv1 "github.com/operator-framework/operator-controller/api/v1"
+
+	"github.com/operator-framework/kubectl-operator/pkg/action"
+)
+
+type OperatorInstalledGet struct {
+	config       *action.Configuration
+	OperatorName string
+
+	Logf func(string, ...interface{})
+}
+
+func NewOperatorInstalledGet(cfg *action.Configuration) *OperatorInstalledGet {
+	return &OperatorInstalledGet{
+		config: cfg,
+		Logf:   func(string, ...interface{}) {},
+	}
+}
+
+func (i *OperatorInstalledGet) Run(ctx context.Context) ([]olmv1.ClusterExtension, error) {
+	// get
+	if i.OperatorName != "" {
+		var result olmv1.ClusterExtension
+		opKey := types.NamespacedName{Name: i.OperatorName}
+		err := i.config.Client.Get(ctx, opKey, &result)
+
+		return []olmv1.ClusterExtension{result}, err
+	}
+
+	// list
+	var result olmv1.ClusterExtensionList
+	err := i.config.Client.List(ctx, &result, &client.ListOptions{})
+
+	return result.Items, err
+}

pkg/action/config.go

@@ -11,6 +11,7 @@ import (
 
 	v1 "github.com/operator-framework/api/pkg/operators/v1"
 	"github.com/operator-framework/api/pkg/operators/v1alpha1"
+	catalogdv1 "github.com/operator-framework/catalogd/api/v1"
 	olmv1 "github.com/operator-framework/operator-controller/api/v1"
 	operatorsv1 "github.com/operator-framework/operator-lifecycle-manager/pkg/package-server/apis/operators/v1"
 )
@@ -23,6 +24,7 @@ func NewScheme() (*runtime.Scheme, error) {
 		v1.AddToScheme,
 		apiextensionsv1.AddToScheme,
 		olmv1.AddToScheme,
+		catalogdv1.AddToScheme,
 	} {
 		if err := f(sch); err != nil {
 			return nil, err