feat(1406): introducing the option to match registry ports; (#1607)

* feat(#1406): introducing the option to match registry ports;

* feat(#1406): CR issues addressed;

Author: yakom

cmd/cluster/clusterCreate.go

@@ -60,7 +60,7 @@ Every cluster will consist of one or more containers:
  * we use two different instances of Viper here to handle
  * - cfgViper: "static" configuration
  * - ppViper: "pre-processed" configuration, where CLI input has to be pre-processed
- *             to be treated as part of the SImpleConfig
+ *             to be treated as part of the SimpleConfig
  */
 var (
 	cfgViper = viper.New()
@@ -329,6 +329,9 @@ func NewCmdClusterCreate() *cobra.Command {
 	cmd.Flags().StringArray("registry-use", nil, "Connect to one or more k3d-managed registries running locally")
 	_ = cfgViper.BindPFlag("registries.use", cmd.Flags().Lookup("registry-use"))
 
+	cmd.Flags().Bool("enforce-registry-port-match", false, "Make the internal registry port match the external one")
+	_ = cfgViper.BindPFlag("registries.create.enforcePortMatch", cmd.Flags().Lookup("enforce-registry-port-match"))
+
 	cmd.Flags().String("registry-config", "", "Specify path to an extra registries.yaml file")
 	_ = cfgViper.BindPFlag("registries.config", cmd.Flags().Lookup("registry-config"))
 	if err := cmd.MarkFlagFilename("registry-config", "yaml", "yml"); err != nil {
@@ -373,7 +376,7 @@ func applyCLIOverrides(cfg conf.SimpleConfig) (conf.SimpleConfig, error) {
 		if cfg.ExposeAPI.HostPort != "" {
 			l.Log().Debugf("Overriding pre-defined kubeAPI Exposure Spec %+v with CLI argument %s", cfg.ExposeAPI, ppViper.GetString("cli.api-port"))
 		}
-		exposeAPI, err = cliutil.ParsePortExposureSpec(ppViper.GetString("cli.api-port"), k3d.DefaultAPIPort)
+		exposeAPI, err = cliutil.ParsePortExposureSpec(ppViper.GetString("cli.api-port"), k3d.DefaultAPIPort, false)
 		if err != nil {
 			return cfg, fmt.Errorf("failed to parse API Port spec: %w", err)
 		}
@@ -575,7 +578,7 @@ func applyCLIOverrides(cfg conf.SimpleConfig) (conf.SimpleConfig, error) {
 		}
 		cfg.Registries.Create.Name = fvSplit[0]
 		if len(fvSplit) > 1 {
-			exposeAPI, err = cliutil.ParsePortExposureSpec(fvSplit[1], "1234") // internal port is unused after all
+			exposeAPI, err = cliutil.ParsePortExposureSpec(fvSplit[1], k3d.DefaultRegistryPort, cfg.Registries.Create.EnforcePortMatch)
 			if err != nil {
 				return cfg, fmt.Errorf("failed to registry port spec: %w", err)
 			}

cmd/registry/registryCreate.go

@@ -42,13 +42,14 @@ type regCreatePreProcessedFlags struct {
 }
 
 type regCreateFlags struct {
-	Image          string
-	Network        string
-	ProxyRemoteURL string
-	ProxyUsername  string
-	ProxyPassword  string
-	NoHelp         bool
-	DeleteEnabled  bool
+	Image            string
+	Network          string
+	ProxyRemoteURL   string
+	ProxyUsername    string
+	ProxyPassword    string
+	NoHelp           bool
+	DeleteEnabled    bool
+	EnforcePortMatch bool
 }
 
 var helptext string = `# You can now use the registry like this (example):
@@ -116,6 +117,7 @@ func NewCmdRegistryCreate() *cobra.Command {
 
 	cmd.Flags().BoolVar(&flags.NoHelp, "no-help", false, "Disable the help text (How-To use the registry)")
 	cmd.Flags().BoolVar(&flags.DeleteEnabled, "delete-enabled", false, "Enable image deletion")
+	cmd.Flags().BoolVar(&flags.EnforcePortMatch, "enforce-port-match", false, "Make the internal registry port match the external one")
 
 	// done
 	return cmd
@@ -134,7 +136,7 @@ func parseCreateRegistryCmd(cmd *cobra.Command, args []string, flags *regCreateF
 	}
 
 	// --port
-	exposePort, err := cliutil.ParsePortExposureSpec(ppFlags.Port, k3d.DefaultRegistryPort)
+	exposePort, err := cliutil.ParsePortExposureSpec(ppFlags.Port, k3d.DefaultRegistryPort, flags.EnforcePortMatch)
 	if err != nil {
 		l.Log().Errorln("Failed to parse registry port")
 		l.Log().Fatalln(err)
@@ -174,6 +176,7 @@ func parseCreateRegistryCmd(cmd *cobra.Command, args []string, flags *regCreateF
 	}
 
 	options.DeleteEnabled = flags.DeleteEnabled
+	options.EnforcePortMatch = flags.EnforcePortMatch
 
 	return &k3d.Registry{Host: registryName, Image: flags.Image, ExposureOpts: *exposePort, Network: flags.Network, Options: options, Volumes: volumes}, clusters
 }

cmd/util/ports.go

@@ -37,7 +37,7 @@ import (
 var apiPortRegexp = regexp.MustCompile(`^(?P<hostref>(?P<hostip>\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})|(?P<hostname>\S+):)?(?P<port>(\d{1,5}|random))$`)
 
 // ParsePortExposureSpec parses/validates a string to create an exposePort struct from it
-func ParsePortExposureSpec(exposedPortSpec, internalPort string) (*k3d.ExposureOpts, error) {
+func ParsePortExposureSpec(exposedPortSpec, internalPort string, enforcePortMatch bool) (*k3d.ExposureOpts, error) {
 	match := apiPortRegexp.FindStringSubmatch(exposedPortSpec)
 
 	if len(match) == 0 {
@@ -83,7 +83,7 @@ func ParsePortExposureSpec(exposedPortSpec, internalPort string) (*k3d.ExposureO
 	}
 
 	// port: get a free one if there's none defined or set to random
-	if submatches["port"] == "" || submatches["port"] == "random" {
+	if submatches["port"] == "random" {
 		l.Log().Debugf("Port Exposure Mapping didn't specify hostPort, choosing one randomly...")
 		freePort, err := GetFreePort()
 		if err != nil || freePort == 0 {
@@ -96,6 +96,10 @@ func ParsePortExposureSpec(exposedPortSpec, internalPort string) (*k3d.ExposureO
 		}
 	}
 
+	if enforcePortMatch {
+		internalPort = submatches["port"]
+	}
+
 	realPortString += fmt.Sprintf("%s:%s/tcp", submatches["port"], internalPort)
 
 	portMapping, err := nat.ParsePortSpec(realPortString)

cmd/util/ports_test.go

@@ -0,0 +1,29 @@
+package util
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func Test_ParsePortExposureSpec_PortMatchEnforcement(t *testing.T) {
+
+	r, err := ParsePortExposureSpec("9999", "1111", false)
+	require.Nil(t, err)
+	require.Equal(t, string(r.Port), "1111/tcp")
+	require.Equal(t, string(r.Binding.HostPort), "9999")
+
+	r, err = ParsePortExposureSpec("9999", "1111", true)
+	require.Nil(t, err)
+	require.Equal(t, string(r.Port), "9999/tcp")
+	require.Equal(t, string(r.Binding.HostPort), "9999")
+
+	r, err = ParsePortExposureSpec("random", "1", false)
+	require.Nil(t, err)
+	require.NotEqual(t, strings.Split(string(r.Port), "/")[0], string(r.Binding.HostPort))
+
+	r, err = ParsePortExposureSpec("random", "", true)
+	require.Nil(t, err)
+	require.Equal(t, strings.Split(string(r.Port), "/")[0], string(r.Binding.HostPort))
+}

pkg/client/registry.go

@@ -76,6 +76,10 @@ func RegistryCreate(ctx context.Context, runtime runtimes.Runtime, reg *k3d.Regi
 		Env:      []string{},
 	}
 
+	if reg.Options.EnforcePortMatch {
+		registryNode.Env = append(registryNode.Env, fmt.Sprintf("REGISTRY_HTTP_ADDR=:%s", reg.ExposureOpts.Binding.HostPort))
+	}
+
 	if reg.Options.Proxy.RemoteURL != "" {
 		registryNode.Env = append(registryNode.Env, fmt.Sprintf("REGISTRY_PROXY_REMOTEURL=%s", reg.Options.Proxy.RemoteURL))
 

pkg/config/transform.go

@@ -320,7 +320,7 @@ func TransformSimpleToClusterConfig(ctx context.Context, runtime runtimes.Runtim
 			epSpecHost = simpleConfig.Registries.Create.Host
 		}
 
-		regPort, err := cliutil.ParsePortExposureSpec(fmt.Sprintf("%s:%s", epSpecHost, epSpecPort), k3d.DefaultRegistryPort)
+		regPort, err := cliutil.ParsePortExposureSpec(fmt.Sprintf("%s:%s", epSpecHost, epSpecPort), k3d.DefaultRegistryPort, simpleConfig.Registries.Create.EnforcePortMatch)
 		if err != nil {
 			return nil, fmt.Errorf("failed to get port for registry: %w", err)
 		}
@@ -342,7 +342,8 @@ func TransformSimpleToClusterConfig(ctx context.Context, runtime runtimes.Runtim
 			ExposureOpts: *regPort,
 			Volumes:      simpleConfig.Registries.Create.Volumes,
 			Options: k3d.RegistryOptions{
-				Proxy: simpleConfig.Registries.Create.Proxy,
+				Proxy:            simpleConfig.Registries.Create.Proxy,
+				EnforcePortMatch: simpleConfig.Registries.Create.EnforcePortMatch,
 			},
 		}
 	}

pkg/config/v1alpha5/schema.json

@@ -368,6 +368,10 @@
               "examples": [
                 "/tmp/registry:/var/lib/registry"
               ]
+            },
+            "enforcePortMatch": {
+              "type": "boolean",
+              "default": false
             }
           },
           "additionalProperties": false

pkg/config/v1alpha5/types.go

@@ -97,6 +97,7 @@ type SimpleConfigRegistryCreateConfig struct {
 	Image    string            `mapstructure:"image" json:"image,omitempty"`
 	Proxy    k3d.RegistryProxy `mapstructure:"proxy" json:"proxy,omitempty"`
 	Volumes  []string          `mapstructure:"volumes" json:"volumes,omitempty"`
+	EnforcePortMatch bool      `mapstructure:"enforcePortMatch" json:"enforcePortMatch,omitempty"`
 }
 
 // SimpleConfigOptionsKubeconfig describes the set of options referring to the kubeconfig during cluster creation.

pkg/types/registry.go

@@ -33,9 +33,10 @@ const (
 )
 
 type RegistryOptions struct {
-	ConfigFile    string        `json:"configFile,omitempty"`
-	Proxy         RegistryProxy `json:"proxy,omitempty"`
-	DeleteEnabled bool          `json:"deleteEnabled,omitempty"`
+	ConfigFile       string        `json:"configFile,omitempty"`
+	Proxy            RegistryProxy `json:"proxy,omitempty"`
+	DeleteEnabled    bool          `json:"deleteEnabled,omitempty"`
+	EnforcePortMatch bool          `json:"enforcePortMatch,omitempty"`
 }
 
 type RegistryProxy struct {