Merge pull request #1210 from aemengo/registry-mirror-support

Add registry mirror support for pack build
Signed-off-by: David Freilich <[email protected]>

build.go

@@ -29,6 +29,7 @@ import (
 	"github.com/buildpacks/pack/internal/dist"
 	"github.com/buildpacks/pack/internal/image"
 	"github.com/buildpacks/pack/internal/layer"
+	pname "github.com/buildpacks/pack/internal/name"
 	"github.com/buildpacks/pack/internal/paths"
 	"github.com/buildpacks/pack/internal/stack"
 	"github.com/buildpacks/pack/internal/stringset"
@@ -288,6 +289,11 @@ func (c *Client) Build(ctx context.Context, opts BuildOptions) error {
 		return err
 	}
 
+	runImageName, err = pname.TranslateRegistry(runImageName, c.registryMirrors, c.logger)
+	if err != nil {
+		return err
+	}
+
 	lifecycleOpts := build.LifecycleOptions{
 		AppPath:            appPath,
 		Image:              imageRef,

build_test.go

@@ -2206,6 +2206,20 @@ func testBuild(t *testing.T, when spec.G, it spec.S) {
 				h.AssertEq(t, fakeLifecycle.Opts.GID, 2)
 			})
 		})
+
+		when("RegistryMirrors option", func() {
+			it("translates run image before passing to lifecycle", func() {
+				subject.registryMirrors = map[string]string{
+					"index.docker.io": "10.0.0.1",
+				}
+
+				h.AssertNil(t, subject.Build(context.TODO(), BuildOptions{
+					Builder: defaultBuilderName,
+					Image:   "example.com/some/repo:tag",
+				}))
+				h.AssertEq(t, fakeLifecycle.Opts.RunImage, "10.0.0.1/default/run:latest")
+			})
+		})
 	})
 }
 

client.go

@@ -64,6 +64,7 @@ type Client struct {
 	docker            dockerClient.CommonAPIClient
 	imageFactory      ImageFactory
 	experimental      bool
+	registryMirrors   map[string]string
 }
 
 // ClientOption is a type of function that mutate settings on the client.
@@ -123,6 +124,13 @@ func WithExperimental(experimental bool) ClientOption {
 	}
 }
 
+// WithRegistryMirrors sets mirrors to pull images from.
+func WithRegistryMirrors(registryMirrors map[string]string) ClientOption {
+	return func(c *Client) {
+		c.registryMirrors = registryMirrors
+	}
+}
+
 // NewClient allocates and returns a Client configured with the specified options.
 func NewClient(opts ...ClientOption) (*Client, error) {
 	var client Client
@@ -155,7 +163,7 @@ func NewClient(opts ...ClientOption) (*Client, error) {
 	}
 
 	if client.imageFetcher == nil {
-		client.imageFetcher = image.NewFetcher(client.logger, client.docker)
+		client.imageFetcher = image.NewFetcher(client.logger, client.docker, image.WithRegistryMirrors(client.registryMirrors))
 	}
 
 	if client.imageFactory == nil {

client_test.go

@@ -110,4 +110,16 @@ func testClient(t *testing.T, when spec.G, it spec.S) {
 			h.AssertEq(t, cl.experimental, true)
 		})
 	})
+
+	when("#WithRegistryMirror", func() {
+		it("uses registry mirrors provided", func() {
+			registryMirrors := map[string]string{
+				"index.docker.io": "10.0.0.1",
+			}
+
+			cl, err := NewClient(WithRegistryMirrors(registryMirrors))
+			h.AssertNil(t, err)
+			h.AssertEq(t, cl.registryMirrors, registryMirrors)
+		})
+	})
 }

cmd/cmd.go

@@ -133,7 +133,7 @@ func initConfig() (config.Config, string, error) {
 }
 
 func initClient(logger logging.Logger, cfg config.Config) (pack.Client, error) {
-	client, err := pack.NewClient(pack.WithLogger(logger), pack.WithExperimental(cfg.Experimental))
+	client, err := pack.NewClient(pack.WithLogger(logger), pack.WithExperimental(cfg.Experimental), pack.WithRegistryMirrors(cfg.RegistryMirrors))
 	if err != nil {
 		return pack.Client{}, err
 	}

internal/commands/config.go

@@ -23,6 +23,7 @@ func NewConfigCommand(logger logging.Logger, cfg config.Config, cfgPath string,
 	cmd.AddCommand(ConfigRunImagesMirrors(logger, cfg, cfgPath))
 	cmd.AddCommand(ConfigTrustedBuilder(logger, cfg, cfgPath))
 	cmd.AddCommand(ConfigLifecycleImage(logger, cfg, cfgPath))
+	cmd.AddCommand(ConfigRegistryMirrors(logger, cfg, cfgPath))
 
 	AddHelpFlag(cmd, "config")
 	return cmd

internal/commands/config_registry_mirrors.go

@@ -0,0 +1,102 @@
+package commands
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/pkg/errors"
+	"github.com/spf13/cobra"
+
+	"github.com/buildpacks/pack/internal/config"
+	"github.com/buildpacks/pack/internal/style"
+	"github.com/buildpacks/pack/logging"
+)
+
+var registryMirror string
+
+func ConfigRegistryMirrors(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "registry-mirrors",
+		Short:   "List, add and remove OCI registry mirrors",
+		Aliases: []string{"registry-mirror"},
+		Args:    cobra.MaximumNArgs(3),
+		RunE: logError(logger, func(cmd *cobra.Command, args []string) error {
+			listRegistryMirrors(args, logger, cfg)
+			return nil
+		}),
+	}
+
+	listCmd := generateListCmd(cmd.Use, logger, cfg, listRegistryMirrors)
+	listCmd.Long = "List all registry mirrors."
+	listCmd.Use = "list"
+	listCmd.Example = "pack config registry-mirrors list"
+	cmd.AddCommand(listCmd)
+
+	addCmd := generateAdd("mirror for a registry", logger, cfg, cfgPath, addRegistryMirror)
+	addCmd.Use = "add <registry> [-m <mirror...]"
+	addCmd.Long = "Set mirror for a given registry."
+	addCmd.Example = "pack config registry-mirrors add index.docker.io --mirror 10.0.0.1\npack config registry-mirrors add '*' --mirror 10.0.0.1"
+	addCmd.Flags().StringVarP(&registryMirror, "mirror", "m", "", "Registry mirror")
+	cmd.AddCommand(addCmd)
+
+	rmCmd := generateRemove("mirror for a registry", logger, cfg, cfgPath, removeRegistryMirror)
+	rmCmd.Use = "remove <registry>"
+	rmCmd.Long = "Remove mirror for a given registry."
+	rmCmd.Example = "pack config registry-mirrors remove index.docker.io"
+	cmd.AddCommand(rmCmd)
+
+	AddHelpFlag(cmd, "run-image-mirrors")
+	return cmd
+}
+
+func addRegistryMirror(args []string, logger logging.Logger, cfg config.Config, cfgPath string) error {
+	registry := args[0]
+	if registryMirror == "" {
+		logger.Infof("A registry mirror was not provided.")
+		return nil
+	}
+
+	if cfg.RegistryMirrors == nil {
+		cfg.RegistryMirrors = map[string]string{}
+	}
+
+	cfg.RegistryMirrors[registry] = registryMirror
+	if err := config.Write(cfg, cfgPath); err != nil {
+		return errors.Wrapf(err, "failed to write to %s", cfgPath)
+	}
+
+	logger.Infof("Registry %s configured with mirror %s", style.Symbol(registry), style.Symbol(registryMirror))
+	return nil
+}
+
+func removeRegistryMirror(args []string, logger logging.Logger, cfg config.Config, cfgPath string) error {
+	registry := args[0]
+	_, ok := cfg.RegistryMirrors[registry]
+	if !ok {
+		logger.Infof("No registry mirror has been set for %s", style.Symbol(registry))
+		return nil
+	}
+
+	delete(cfg.RegistryMirrors, registry)
+	if err := config.Write(cfg, cfgPath); err != nil {
+		return errors.Wrapf(err, "failed to write to %s", cfgPath)
+	}
+
+	logger.Infof("Removed mirror for %s", style.Symbol(registry))
+	return nil
+}
+
+func listRegistryMirrors(args []string, logger logging.Logger, cfg config.Config) {
+	if len(cfg.RegistryMirrors) == 0 {
+		logger.Info("No registry mirrors have been set")
+		return
+	}
+
+	buf := strings.Builder{}
+	buf.WriteString("Registry Mirrors:\n")
+	for registry, mirror := range cfg.RegistryMirrors {
+		buf.WriteString(fmt.Sprintf("  %s: %s\n", registry, style.Symbol(mirror)))
+	}
+
+	logger.Info(buf.String())
+}