fix(add): allow containertool to be specified for registry add

registry add by default will use containderd, but we continue to support
podman and docker

Author: ecordell

cmd/opm/index/add.go

@@ -7,6 +7,7 @@ import (
 	"github.com/spf13/cobra"
 	"k8s.io/kubectl/pkg/util/templates"
 
+	"github.com/operator-framework/operator-registry/pkg/containertools"
 	"github.com/operator-framework/operator-registry/pkg/lib/indexer"
 	"github.com/operator-framework/operator-registry/pkg/registry"
 )
@@ -52,6 +53,7 @@ func addIndexAddCmd(parent *cobra.Command) {
 	if err := indexCmd.MarkFlagRequired("bundles"); err != nil {
 		logrus.Panic("Failed to set required `bundles` flag for `index add`")
 	}
+	indexCmd.Flags().Bool("skip-tls", false, "skip TLS certificate verification for container image registries while pulling bundles")
 	indexCmd.Flags().StringP("binary-image", "i", "", "container image for on-image `opm` command")
 	indexCmd.Flags().StringP("container-tool", "c", "podman", "tool to interact with container images (save, build, etc.). One of: [docker, podman]")
 	indexCmd.Flags().StringP("tag", "t", "", "custom tag for container image being built")
@@ -99,6 +101,10 @@ func runIndexAddCmdFunc(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	if containerTool == "none" {
+		return fmt.Errorf("none is not a valid container-tool for index add")
+	}
+
 	tag, err := cmd.Flags().GetString("tag")
 	if err != nil {
 		return err
@@ -109,6 +115,11 @@ func runIndexAddCmdFunc(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	skipTLS, err := cmd.Flags().GetBool("skip-tls")
+	if err != nil {
+		return err
+	}
+
 	mode, err := cmd.Flags().GetString("mode")
 	if err != nil {
 		return err
@@ -123,7 +134,7 @@ func runIndexAddCmdFunc(cmd *cobra.Command, args []string) error {
 
 	logger.Info("building the index")
 
-	indexAdder := indexer.NewIndexAdder(containerTool, logger)
+	indexAdder := indexer.NewIndexAdder(containertools.NewContainerTool(containerTool, containertools.PodmanTool), logger)
 
 	request := indexer.AddToIndexRequest{
 		Generate:          generate,
@@ -134,6 +145,7 @@ func runIndexAddCmdFunc(cmd *cobra.Command, args []string) error {
 		Bundles:           bundles,
 		Permissive:        permissive,
 		Mode:              modeEnum,
+		SkipTLS:           skipTLS,
 	}
 
 	err = indexAdder.AddToIndex(request)

cmd/opm/index/delete.go

@@ -1,9 +1,11 @@
 package index
 
 import (
+	"fmt"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 
+	"github.com/operator-framework/operator-registry/pkg/containertools"
 	"github.com/operator-framework/operator-registry/pkg/lib/indexer"
 )
 
@@ -35,7 +37,7 @@ func newIndexDeleteCmd() *cobra.Command {
 		logrus.Panic("Failed to set required `operators` flag for `index delete`")
 	}
 	indexCmd.Flags().StringP("binary-image", "i", "", "container image for on-image `opm` command")
-	indexCmd.Flags().StringP("container-tool", "c", "podman", "tool to interact with container images (save, build, etc.). One of: [docker, podman]")
+	indexCmd.Flags().StringP("container-tool", "c", "podman", "tool to interact with container images (save, build, etc.). One of: [none, docker, podman]")
 	indexCmd.Flags().StringP("tag", "t", "", "custom tag for container image being built")
 	indexCmd.Flags().Bool("permissive", false, "allow registry load errors")
 
@@ -78,6 +80,10 @@ func runIndexDeleteCmdFunc(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	if containerTool == "none" {
+		return fmt.Errorf("none is not a valid container-tool for index add")
+	}
+
 	tag, err := cmd.Flags().GetString("tag")
 	if err != nil {
 		return err
@@ -92,7 +98,7 @@ func runIndexDeleteCmdFunc(cmd *cobra.Command, args []string) error {
 
 	logger.Info("building the index")
 
-	indexDeleter := indexer.NewIndexDeleter(containerTool, logger)
+	indexDeleter := indexer.NewIndexDeleter(containertools.NewContainerTool(containerTool, containertools.PodmanTool), logger)
 
 	request := indexer.DeleteFromIndexRequest{
 		Generate:          generate,

cmd/opm/index/export.go

@@ -1,10 +1,12 @@
 package index
 
 import (
+	"fmt"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	"k8s.io/kubectl/pkg/util/templates"
 
+	"github.com/operator-framework/operator-registry/pkg/containertools"
 	"github.com/operator-framework/operator-registry/pkg/lib/indexer"
 )
 
@@ -44,7 +46,7 @@ func newIndexExportCmd() *cobra.Command {
 		logrus.Panic("Failed to set required `package` flag for `index export`")
 	}
 	indexCmd.Flags().StringP("download-folder", "f", "downloaded", "directory where downloaded operator bundle(s) will be stored")
-	indexCmd.Flags().StringP("container-tool", "c", "podman", "tool to interact with container images (save, build, etc.). One of: [docker, podman]")
+	indexCmd.Flags().StringP("container-tool", "c", "podman", "tool to interact with container images (save, build, etc.). One of: [none, docker, podman]")
 	if err := indexCmd.Flags().MarkHidden("debug"); err != nil {
 		logrus.Panic(err.Error())
 	}
@@ -74,11 +76,15 @@ func runIndexExportCmdFunc(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	if containerTool == "none" {
+		return fmt.Errorf("none is not a valid container-tool for index add")
+	}
+
 	logger := logrus.WithFields(logrus.Fields{"index": index, "package": packageName})
 
 	logger.Info("export from the index")
 
-	indexExporter := indexer.NewIndexExporter(containerTool, logger)
+	indexExporter := indexer.NewIndexExporter(containertools.NewContainerTool(containerTool, containertools.PodmanTool), logger)
 
 	request := indexer.ExportFromIndexRequest{
 		Index:         index,

cmd/opm/registry/add.go

@@ -4,6 +4,7 @@ import (
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 
+	"github.com/operator-framework/operator-registry/pkg/containertools"
 	"github.com/operator-framework/operator-registry/pkg/lib/registry"
 	reg "github.com/operator-framework/operator-registry/pkg/registry"
 )
@@ -30,11 +31,7 @@ func newRegistryAddCmd() *cobra.Command {
 	rootCmd.Flags().Bool("permissive", false, "allow registry load errors")
 	rootCmd.Flags().Bool("skip-tls", false, "skip TLS certificate verification for container image registries while pulling bundles")
 	rootCmd.Flags().StringP("mode", "", "replaces", "graph update mode that defines how channel graphs are updated. One of: [replaces, semver, semver-skippatch]")
-
-	rootCmd.Flags().StringP("container-tool", "c", "", "")
-	if err := rootCmd.Flags().MarkDeprecated("container-tool", "ignored in favor of standalone image manipulation"); err != nil {
-		logrus.Panic(err.Error())
-	}
+	rootCmd.Flags().StringP("container-tool", "c", "none", "tool to interact with container images (save, build, etc.). One of: [none, docker, podman]")
 
 	return rootCmd
 }
@@ -56,12 +53,14 @@ func addFunc(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
-
+	containerTool, err := cmd.Flags().GetString("container-tool")
+	if err != nil {
+		return err
+	}
 	mode, err := cmd.Flags().GetString("mode")
 	if err != nil {
 		return err
 	}
-
 	modeEnum, err := reg.GetModeFromString(mode)
 	if err != nil {
 		return err
@@ -73,6 +72,7 @@ func addFunc(cmd *cobra.Command, args []string) error {
 		InputDatabase: fromFilename,
 		Bundles:       bundleImages,
 		Mode:          modeEnum,
+		ContainerTool: containertools.NewContainerTool(containerTool, containertools.NoneTool),
 	}
 
 	logger := logrus.WithFields(logrus.Fields{"bundles": bundleImages})

pkg/containertools/command.go

@@ -8,13 +8,6 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-const (
-	// Podman cli tool
-	Podman = "podman"
-	// Docker cli tool
-	Docker = "docker"
-)
-
 // CommandRunner defines methods to shell out to common container tools
 type CommandRunner interface {
 	GetToolName() string
@@ -28,42 +21,32 @@ type CommandRunner interface {
 // execute commands with that tooling.
 type ContainerCommandRunner struct {
 	logger        *logrus.Entry
-	containerTool string
+	containerTool ContainerTool
 }
 
 // NewCommandRunner takes the containerTool as an input string and returns a
 // CommandRunner to run commands with that cli tool
-func NewCommandRunner(containerTool string, logger *logrus.Entry) CommandRunner {
+func NewCommandRunner(containerTool ContainerTool, logger *logrus.Entry) CommandRunner {
 	r := ContainerCommandRunner{
 		logger: logger,
+		containerTool: containerTool,
 	}
-
-	switch containerTool {
-	case Podman:
-		r.containerTool = Podman
-	case Docker:
-		r.containerTool = Docker
-	default:
-		r.containerTool = Podman
-	}
-
 	return &r
 }
 
 // GetToolName returns the container tool this command runner is using
 func (r *ContainerCommandRunner) GetToolName() string {
-	return r.containerTool
+	return r.containerTool.String()
 }
 
 // Pull takes a container image path hosted on a container registry and runs the
 // pull command to download it onto the local environment
 func (r *ContainerCommandRunner) Pull(image string) error {
 	args := []string{"pull", image}
 
-	command := exec.Command(r.containerTool, args...)
+	command := exec.Command(r.containerTool.String(), args...)
 
-	r.logger.Infof("running %s pull", r.containerTool)
-	r.logger.Debugf("%s", command.Args)
+	r.logger.Infof("running %s", command.String())
 
 	out, err := command.CombinedOutput()
 	if err != nil {
@@ -84,7 +67,7 @@ func (r *ContainerCommandRunner) Build(dockerfile, tag string) error {
 
 	args = append(args, ".")
 
-	command := exec.Command(r.containerTool, args...)
+	command := exec.Command(r.containerTool.String(), args...)
 
 	r.logger.Infof("running %s build", r.containerTool)
 	r.logger.Infof("%s", command.Args)
@@ -103,7 +86,7 @@ func (r *ContainerCommandRunner) Build(dockerfile, tag string) error {
 func (r *ContainerCommandRunner) Save(image, tarFile string) error {
 	args := []string{"save", image, "-o", tarFile}
 
-	command := exec.Command(r.containerTool, args...)
+	command := exec.Command(r.containerTool.String(), args...)
 
 	r.logger.Infof("running %s save", r.containerTool)
 	r.logger.Debugf("%s", command.Args)
@@ -122,7 +105,7 @@ func (r *ContainerCommandRunner) Save(image, tarFile string) error {
 func (r *ContainerCommandRunner) Inspect(image string) ([]byte, error) {
 	args := []string{"inspect", image}
 
-	command := exec.Command(r.containerTool, args...)
+	command := exec.Command(r.containerTool.String(), args...)
 
 	r.logger.Infof("running %s inspect", r.containerTool)
 	r.logger.Debugf("%s", command.Args)

pkg/containertools/containertool.go

@@ -0,0 +1,46 @@
+package containertools
+
+type ContainerTool int
+
+const (
+	NoneTool ContainerTool = iota
+	PodmanTool
+	DockerTool
+)
+
+func (t ContainerTool) String() (s string) {
+	switch t {
+	case NoneTool:
+		s = "none"
+	case PodmanTool:
+		s = "podman"
+	case DockerTool:
+		s = "docker"
+	}
+	return
+}
+
+func NewContainerTool(s string, defaultTool ContainerTool) (t ContainerTool) {
+	switch s {
+	case "podman":
+		t = PodmanTool
+	case "docker":
+		t = DockerTool
+	case "none":
+		t = NoneTool
+	default:
+		t = defaultTool
+	}
+	return
+}
+
+// NewCommandContainerTool returns a tool that can be used in `exec` statements.
+func NewCommandContainerTool(s string) (t ContainerTool) {
+	switch s {
+	case "docker":
+		t = DockerTool
+	default:
+		t = PodmanTool
+	}
+	return
+}

pkg/containertools/dockerfilegenerator.go

@@ -24,7 +24,7 @@ type IndexDockerfileGenerator struct {
 }
 
 // NewDockerfileGenerator is a constructor that returns a DockerfileGenerator
-func NewDockerfileGenerator(containerTool string, logger *logrus.Entry) DockerfileGenerator {
+func NewDockerfileGenerator(logger *logrus.Entry) DockerfileGenerator {
 	return &IndexDockerfileGenerator{
 		Logger: logger,
 	}

pkg/containertools/imagereader.go

@@ -33,7 +33,7 @@ type ImageLayerReader struct {
 	Logger *logrus.Entry
 }
 
-func NewImageReader(containerTool string, logger *logrus.Entry) ImageReader {
+func NewImageReader(containerTool ContainerTool, logger *logrus.Entry) ImageReader {
 	cmd := NewCommandRunner(containerTool, logger)
 
 	return &ImageLayerReader{

pkg/containertools/labelreader.go

@@ -17,7 +17,7 @@ type ImageLabelReader struct {
 	Cmd    CommandRunner
 }
 
-func NewLabelReader(containerTool string, logger *logrus.Entry) LabelReader {
+func NewLabelReader(containerTool ContainerTool, logger *logrus.Entry) LabelReader {
 	cmd := NewCommandRunner(containerTool, logger)
 
 	return ImageLabelReader{