fix: support registry override for dev deploy (yolo) (#3064)

Signed-off-by: Micah Nagel <[email protected]>

Author: mjnagel

src/cmd/dev.go

@@ -32,6 +32,8 @@ import (
 
 var extractPath string
 
+var defaultRegistry = fmt.Sprintf("%s:%d", helpers.IPV4Localhost, types.ZarfInClusterContainerRegistryNodePort)
+
 var devCmd = &cobra.Command{
 	Use:     "dev",
 	Aliases: []string{"prepare", "prep"},
@@ -349,8 +351,7 @@ func init() {
 	// skip searching cosign artifacts in find images
 	devFindImagesCmd.Flags().BoolVar(&pkgConfig.FindImagesOpts.SkipCosign, "skip-cosign", false, lang.CmdDevFlagFindImagesSkipCosign)
 
-	defaultRegistry := fmt.Sprintf("%s:%d", helpers.IPV4Localhost, types.ZarfInClusterContainerRegistryNodePort)
-	devFindImagesCmd.Flags().StringVar(&pkgConfig.FindImagesOpts.RegistryURL, "registry-url", defaultRegistry, lang.CmdDevFlagFindImagesRegistry)
+	devFindImagesCmd.Flags().StringVar(&pkgConfig.FindImagesOpts.RegistryURL, "registry-url", defaultRegistry, lang.CmdDevFlagRegistry)
 
 	devLintCmd.Flags().StringToStringVar(&pkgConfig.CreateOpts.SetVariables, "set", v.GetStringMapString(common.VPkgCreateSet), lang.CmdPackageCreateFlagSet)
 	devLintCmd.Flags().StringVarP(&pkgConfig.CreateOpts.Flavor, "flavor", "f", v.GetString(common.VPkgCreateFlavor), lang.CmdPackageCreateFlagFlavor)
@@ -364,6 +365,12 @@ func bindDevDeployFlags(v *viper.Viper) {
 	devDeployFlags.StringToStringVar(&pkgConfig.CreateOpts.RegistryOverrides, "registry-override", v.GetStringMapString(common.VPkgCreateRegistryOverride), lang.CmdPackageCreateFlagRegistryOverride)
 	devDeployFlags.StringVarP(&pkgConfig.CreateOpts.Flavor, "flavor", "f", v.GetString(common.VPkgCreateFlavor), lang.CmdPackageCreateFlagFlavor)
 
+	devDeployFlags.StringVar(&pkgConfig.DeployOpts.RegistryURL, "registry-url", defaultRegistry, lang.CmdDevFlagRegistry)
+	err := devDeployFlags.MarkHidden("registry-url")
+	if err != nil {
+		message.Debug("Unable to mark dev-deploy flag as hidden", "error", err)
+	}
+
 	devDeployFlags.StringToStringVar(&pkgConfig.PkgOpts.SetVariables, "deploy-set", v.GetStringMapString(common.VPkgDeploySet), lang.CmdPackageDeployFlagSet)
 
 	// Always require adopt-existing-resources flag (no viper)

src/config/lang/english.go

@@ -354,7 +354,7 @@ $ zarf package pull oci://ghcr.io/defenseunicorns/packages/dos-games:1.0.0 -a sk
 	CmdDevFlagRepoChartPath        = `If git repos hold helm charts, often found with gitops tools, specify the chart path, e.g. "/" or "/chart"`
 	CmdDevFlagGitAccount           = "User or organization name for the git account that the repos are created under."
 	CmdDevFlagKubeVersion          = "Override the default helm template KubeVersion when performing a package chart template"
-	CmdDevFlagFindImagesRegistry   = "Override the ###ZARF_REGISTRY### value"
+	CmdDevFlagRegistry             = "Override the ###ZARF_REGISTRY### value"
 	CmdDevFlagFindImagesWhy        = "Prints the source manifest for the specified image"
 	CmdDevFlagFindImagesSkipCosign = "Skip searching for cosign artifacts related to discovered images"
 

src/pkg/packager/dev.go

@@ -16,6 +16,7 @@ import (
 	"github.com/zarf-dev/zarf/src/pkg/message"
 	"github.com/zarf-dev/zarf/src/pkg/packager/creator"
 	"github.com/zarf-dev/zarf/src/pkg/packager/filters"
+	"github.com/zarf-dev/zarf/src/types"
 )
 
 // DevDeploy creates + deploys a package in one shot
@@ -76,6 +77,24 @@ func (p *Packager) DevDeploy(ctx context.Context) error {
 
 	if !p.cfg.CreateOpts.NoYOLO {
 		p.cfg.Pkg.Metadata.YOLO = true
+
+		// Set default builtin values so they exist in case any helm charts rely on them
+		registryInfo := types.RegistryInfo{Address: p.cfg.DeployOpts.RegistryURL}
+		if err := registryInfo.FillInEmptyValues(); err != nil {
+			return err
+		}
+		gitServer := types.GitServerInfo{}
+		if err = gitServer.FillInEmptyValues(); err != nil {
+			return err
+		}
+		artifactServer := types.ArtifactServerInfo{}
+		artifactServer.FillInEmptyValues()
+
+		p.state = &types.ZarfState{
+			RegistryInfo:   registryInfo,
+			GitServer:      gitServer,
+			ArtifactServer: artifactServer,
+		}
 	} else {
 		p.hpaModified = false
 		// Reset registry HPA scale down whether an error occurs or not

src/test/e2e/99_yolo_test.go

@@ -53,9 +53,17 @@ func TestDevDeploy(t *testing.T) {
 		return
 	}
 
+	// Generic test of dev deploy
 	stdOut, stdErr, err := e2e.Zarf(t, "dev", "deploy", "examples/dos-games")
 	require.NoError(t, err, stdOut, stdErr)
 
-	stdOut, stdErr, err = e2e.Zarf(t, "package", "remove", "dos-games", "--confirm")
+	stdOut, stdErr, err = e2e.Zarf(t, "tools", "kubectl", "delete", "namespace", "dos-games")
+	require.NoError(t, err, stdOut, stdErr)
+
+	// Special test of hidden registry-url flag
+	stdOut, stdErr, err = e2e.Zarf(t, "dev", "deploy", "src/test/packages/99-registry-url", "--registry-url", "ghcr.io")
+	require.NoError(t, err, stdOut, stdErr)
+
+	stdOut, stdErr, err = e2e.Zarf(t, "tools", "kubectl", "delete", "namespace", "registry-url")
 	require.NoError(t, err, stdOut, stdErr)
 }

src/test/packages/99-registry-url/registry-url.yaml

@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: registry-url
+spec:
+  containers:
+    - name: podinfo
+      image: "###ZARF_REGISTRY###/stefanprodan/podinfo:6.4.0"

src/test/packages/99-registry-url/zarf.yaml

@@ -0,0 +1,16 @@
+kind: ZarfPackageConfig
+metadata:
+  name: registry-url
+  description: Deploys a simple pod with the special ZARF_REGISTRY value
+
+components:
+  - name: registry-url
+    required: true
+    manifests:
+      - name: registry-url
+        namespace: registry-url
+        noWait: true
+        files:
+          - registry-url.yaml
+    images:
+      - ghcr.io/stefanprodan/podinfo:6.4.0

src/types/runtime.go

@@ -78,6 +78,8 @@ type ZarfDeployOptions struct {
 	Timeout time.Duration
 	// [Library Only] A map of component names to chart names containing Helm Chart values to override values on deploy
 	ValuesOverridesMap map[string]map[string]map[string]interface{}
+	// [Dev Deploy Only] Manual override for ###ZARF_REGISTRY###
+	RegistryURL string
 }
 
 // ZarfMirrorOptions tracks the user-defined preferences during a package mirror.