two-flag approach (with cleanup of old dockerfile)

Signed-off-by: Jordan Keister <[email protected]>

Author: grokspawn

Diff for: alpha/action/generate_dockerfile.go

@@ -9,24 +9,25 @@ import (
 )
 
 type GenerateDockerfile struct {
-	BaseImage   string
-	IndexDir    string
-	ExtraLabels map[string]string
-	Writer      io.Writer
-	Lite        bool
+	BaseImage    string
+	BuilderImage string
+	IndexDir     string
+	ExtraLabels  map[string]string
+	Writer       io.Writer
 }
 
 func (i GenerateDockerfile) Run() error {
 	if err := i.validate(); err != nil {
 		return err
 	}
 
-	var dockerfileTemplate string
-	if i.Lite {
-		dockerfileTemplate = binlessDockerfileTmpl
+	var entrypoint string
+	if i.BaseImage == containertools.DefaultScratchSourceImage {
+		entrypoint = ""
 	} else {
-		dockerfileTemplate = dockerfileTmpl
+		entrypoint = entrypointStanza
 	}
+	dockerfileTemplate := fmt.Sprintf(dockerfileStanza, entrypoint)
 
 	t, err := template.New("dockerfile").Parse(dockerfileTemplate)
 	if err != nil {
@@ -47,15 +48,23 @@ func (i GenerateDockerfile) validate() error {
 	return nil
 }
 
-const binlessDockerfileTmpl = `# The builder image is expected to contain
+const entrypointStanza = `# The base image is expected to contain
 # /bin/opm (with serve subcommand)
-FROM {{.BaseImage}} as builder
+# Configure the entrypoint and command
+ENTRYPOINT ["/bin/opm"]
+CMD ["serve", "/configs", "--cache-dir=/tmp/cache"]
+`
+
+const dockerfileStanza = `# The builder image is expected to contain
+# /bin/opm (with serve subcommand)
+FROM {{.BuilderImage}} as builder
 
 # Copy FBC root into image at /configs and pre-populate serve cache
 ADD {{.IndexDir}} /configs
 RUN ["/bin/opm", "serve", "/configs", "--cache-dir=/tmp/cache", "--cache-only"]
 
-FROM scratch
+FROM {{.BaseImage}}
+%s
 
 COPY --from=builder /configs /configs
 COPY --from=builder /tmp/cache /tmp/cache
@@ -71,27 +80,3 @@ LABEL "{{ $key }}"="{{ $value }}"
 {{- end }}
 {{- end }}
 `
-
-const dockerfileTmpl = `# The base image is expected to contain
-# /bin/opm (with a serve subcommand) and /bin/grpc_health_probe
-FROM {{.BaseImage}}
-
-# Configure the entrypoint and command
-ENTRYPOINT ["/bin/opm"]
-CMD ["serve", "/configs", "--cache-dir=/tmp/cache"]
-
-# Copy declarative config root into image at /configs and pre-populate serve cache
-ADD {{.IndexDir}} /configs
-RUN ["/bin/opm", "serve", "/configs", "--cache-dir=/tmp/cache", "--cache-only"]
-
-# Set DC-specific label for the location of the DC root directory
-# in the image
-LABEL ` + containertools.ConfigsLocationLabel + `=/configs
-{{- if .ExtraLabels }}
-
-# Set other custom labels
-{{- range $key, $value := .ExtraLabels }}
-LABEL "{{ $key }}"="{{ $value }}"
-{{- end }}
-{{- end }}
-`

Diff for: alpha/action/generate_dockerfile_test.go

@@ -41,49 +41,65 @@ func TestGenerateDockerfile(t *testing.T) {
 		{
 			name: "Success/WithoutExtraLabels",
 			gen: GenerateDockerfile{
-				BaseImage: "foo",
-				IndexDir:  "bar",
+				BuilderImage: "foo",
+				BaseImage:    "foo",
+				IndexDir:     "bar",
 			},
-			expectedDockerfile: `# The base image is expected to contain
-# /bin/opm (with a serve subcommand) and /bin/grpc_health_probe
-FROM foo
+			expectedDockerfile: `# The builder image is expected to contain
+# /bin/opm (with serve subcommand)
+FROM foo as builder
 
+# Copy FBC root into image at /configs and pre-populate serve cache
+ADD bar /configs
+RUN ["/bin/opm", "serve", "/configs", "--cache-dir=/tmp/cache", "--cache-only"]
+
+FROM foo
+# The base image is expected to contain
+# /bin/opm (with serve subcommand)
 # Configure the entrypoint and command
 ENTRYPOINT ["/bin/opm"]
 CMD ["serve", "/configs", "--cache-dir=/tmp/cache"]
 
-# Copy declarative config root into image at /configs and pre-populate serve cache
-ADD bar /configs
-RUN ["/bin/opm", "serve", "/configs", "--cache-dir=/tmp/cache", "--cache-only"]
 
-# Set DC-specific label for the location of the DC root directory
+COPY --from=builder /configs /configs
+COPY --from=builder /tmp/cache /tmp/cache
+
+# Set FBC-specific label for the location of the FBC root directory
 # in the image
 LABEL operators.operatorframework.io.index.configs.v1=/configs
 `,
 		},
 		{
 			name: "Success/WithExtraLabels",
 			gen: GenerateDockerfile{
-				BaseImage: "foo",
-				IndexDir:  "bar",
+				BuilderImage: "foo",
+				BaseImage:    "foo",
+				IndexDir:     "bar",
 				ExtraLabels: map[string]string{
 					"key1": "value1",
 					"key2": "value2",
 				},
 			},
-			expectedDockerfile: `# The base image is expected to contain
-# /bin/opm (with a serve subcommand) and /bin/grpc_health_probe
-FROM foo
+			expectedDockerfile: `# The builder image is expected to contain
+# /bin/opm (with serve subcommand)
+FROM foo as builder
+
+# Copy FBC root into image at /configs and pre-populate serve cache
+ADD bar /configs
+RUN ["/bin/opm", "serve", "/configs", "--cache-dir=/tmp/cache", "--cache-only"]
 
+FROM foo
+# The base image is expected to contain
+# /bin/opm (with serve subcommand)
 # Configure the entrypoint and command
 ENTRYPOINT ["/bin/opm"]
 CMD ["serve", "/configs", "--cache-dir=/tmp/cache"]
 
-# Copy declarative config root into image at /configs and pre-populate serve cache
-ADD bar /configs
-RUN ["/bin/opm", "serve", "/configs", "--cache-dir=/tmp/cache", "--cache-only"]
 
-# Set DC-specific label for the location of the DC root directory
+COPY --from=builder /configs /configs
+COPY --from=builder /tmp/cache /tmp/cache
+
+# Set FBC-specific label for the location of the FBC root directory
 # in the image
 LABEL operators.operatorframework.io.index.configs.v1=/configs
 
@@ -94,35 +110,35 @@ LABEL "key2"="value2"
 		},
 
 		{
-			name: "Lite/Fail/EmptyBaseImage",
+			name: "Scratch/Fail/EmptyBaseImage",
 			gen: GenerateDockerfile{
-				IndexDir: "bar",
+				BuilderImage: "foo",
+				IndexDir:     "bar",
 				ExtraLabels: map[string]string{
 					"key1": "value1",
 					"key2": "value2",
 				},
-				Lite: true,
 			},
 			expectedErr: "base image is unset",
 		},
 		{
-			name: "Lite/Fail/EmptyFromDir",
+			name: "Scratch/Fail/EmptyFromDir",
 			gen: GenerateDockerfile{
-				BaseImage: "foo",
+				BuilderImage: "foo",
+				BaseImage:    "scratch",
 				ExtraLabels: map[string]string{
 					"key1": "value1",
 					"key2": "value2",
 				},
-				Lite: true,
 			},
 			expectedErr: "index directory is unset",
 		},
 		{
-			name: "Lite/Success/WithoutExtraLabels",
+			name: "Scratch/Success/WithoutExtraLabels",
 			gen: GenerateDockerfile{
-				BaseImage: "foo",
-				IndexDir:  "bar",
-				Lite:      true,
+				BuilderImage: "foo",
+				BaseImage:    "scratch",
+				IndexDir:     "bar",
 			},
 			expectedDockerfile: `# The builder image is expected to contain
 # /bin/opm (with serve subcommand)
@@ -134,6 +150,7 @@ RUN ["/bin/opm", "serve", "/configs", "--cache-dir=/tmp/cache", "--cache-only"]
 
 FROM scratch
 
+
 COPY --from=builder /configs /configs
 COPY --from=builder /tmp/cache /tmp/cache
 
@@ -145,13 +162,13 @@ LABEL operators.operatorframework.io.index.configs.v1=/configs
 		{
 			name: "Lite/Success/WithExtraLabels",
 			gen: GenerateDockerfile{
-				BaseImage: "foo",
-				IndexDir:  "bar",
+				BuilderImage: "foo",
+				BaseImage:    "scratch",
+				IndexDir:     "bar",
 				ExtraLabels: map[string]string{
 					"key1": "value1",
 					"key2": "value2",
 				},
-				Lite: true,
 			},
 			expectedDockerfile: `# The builder image is expected to contain
 # /bin/opm (with serve subcommand)
@@ -163,6 +180,7 @@ RUN ["/bin/opm", "serve", "/configs", "--cache-dir=/tmp/cache", "--cache-only"]
 
 FROM scratch
 
+
 COPY --from=builder /configs /configs
 COPY --from=builder /tmp/cache /tmp/cache
 

Diff for: cmd/opm/generate/cmd.go

@@ -27,9 +27,9 @@ func NewCmd() *cobra.Command {
 
 func newDockerfileCmd() *cobra.Command {
 	var (
-		baseImage      string
+		binaryImage    string
+		builderImage   string
 		extraLabelStrs []string
-		lite           bool
 	)
 	cmd := &cobra.Command{
 		Use:   "dockerfile <dcRootDir>",
@@ -43,10 +43,26 @@ Dockerfile with the same name already exists, this command will fail.
 
 When specifying extra labels, note that if duplicate keys exist, only the last
 value of each duplicate key will be added to the generated Dockerfile.
+
+If --builder-image is set, this will generate a multi-stage Dockerfile which
+ will NOT include a serving binary.
+ If --builder-image is set, then --binary-image must not be set to anything other than "scratch".
+Note: '--builder-image' and '--binary-image' are mutually exclusive.
 `,
-		RunE: func(_ *cobra.Command, args []string) error {
+		RunE: func(inCmd *cobra.Command, args []string) error {
 			fromDir := filepath.Clean(args[0])
 
+			switch {
+			// user specified both flags ... reject unless they set binary-image to scratch
+			case inCmd.Flags().Changed("binary-image") && inCmd.Flags().Changed("builder-image"):
+				if binaryImage != "scratch" {
+					return fmt.Errorf("invalid flag combination: if specifying --builder-image then --binary-image can only be \"scratch\" or default")
+				}
+			// user specifed only the builder image, set binary image to scratch
+			case inCmd.Flags().Changed("builder-image"):
+				binaryImage = "scratch"
+			}
+
 			extraLabels, err := parseLabels(extraLabelStrs)
 			if err != nil {
 				return err
@@ -72,20 +88,20 @@ value of each duplicate key will be added to the generated Dockerfile.
 			defer f.Close()
 
 			gen := action.GenerateDockerfile{
-				BaseImage:   baseImage,
-				IndexDir:    indexName,
-				ExtraLabels: extraLabels,
-				Writer:      f,
-				Lite:        lite,
+				BaseImage:    binaryImage,
+				BuilderImage: builderImage,
+				IndexDir:     indexName,
+				ExtraLabels:  extraLabels,
+				Writer:       f,
 			}
 			if err := gen.Run(); err != nil {
 				log.Fatal(err)
 			}
 			return nil
 		},
 	}
-	cmd.Flags().StringVarP(&baseImage, "binary-image", "i", containertools.DefaultBinarySourceImage, "Image in which to build catalog.")
-	cmd.Flags().BoolVarP(&lite, "lite", "t", false, "Generate a smaller, binary-less Dockerfile.")
+	cmd.Flags().StringVarP(&binaryImage, "binary-image", "i", containertools.DefaultBinarySourceImage, "Image in which to build catalog.")
+	cmd.Flags().StringVarP(&builderImage, "builder-image", "b", containertools.DefaultBinarySourceImage, "Image to use as a build stage.")
 	cmd.Flags().StringSliceVarP(&extraLabelStrs, "extra-labels", "l", []string{}, "Extra labels to include in the generated Dockerfile. Labels should be of the form 'key=value'.")
 	return cmd
 }

Diff for: ohio.Dockerfile

@@ -8,10 +8,11 @@ import (
 )
 
 const (
-	DefaultBinarySourceImage = "quay.io/operator-framework/opm:latest"
-	DefaultDbLocation        = "/database/index.db"
-	DbLocationLabel          = "operators.operatorframework.io.index.database.v1"
-	ConfigsLocationLabel     = "operators.operatorframework.io.index.configs.v1"
+	DefaultScratchSourceImage = "scratch"
+	DefaultBinarySourceImage  = "quay.io/operator-framework/opm:latest"
+	DefaultDbLocation         = "/database/index.db"
+	DbLocationLabel           = "operators.operatorframework.io.index.database.v1"
+	ConfigsLocationLabel      = "operators.operatorframework.io.index.configs.v1"
 )
 
 // DockerfileGenerator defines functions to generate index dockerfiles