Add the ability to specify Zarf variables as filepaths

docs/3-create-a-zarf-package/4-zarf-schema.md

@@ -2209,7 +2209,7 @@ Must be one of:
  
 <blockquote>
 
-**Description:** Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable)
+**Description:** Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)
 
 |          |                    |
 | -------- | ------------------ |
@@ -2840,7 +2840,7 @@ Must be one of:
 &nbsp;
 <blockquote>
 
-**Description:** Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable)
+**Description:** Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)
 
 |          |                    |
 | -------- | ------------------ |

src/pkg/packager/variables.go

@@ -109,7 +109,7 @@ func (p *Packager) setVariableMapInConfig() error {
 	return nil
 }
 
-func (p *Packager) setVariableInConfig(name, value string, sensitive bool, autoIndent bool, varType string) {
+func (p *Packager) setVariableInConfig(name, value string, sensitive bool, autoIndent bool, varType types.VariableType) {
 	p.cfg.SetVariableMap[name] = &types.ZarfSetVariable{
 		Name:       name,
 		Value:      value,

src/pkg/utils/io.go

@@ -21,6 +21,7 @@ import (
 
 	"github.com/defenseunicorns/zarf/src/pkg/message"
 	"github.com/defenseunicorns/zarf/src/pkg/utils/helpers"
+	"github.com/defenseunicorns/zarf/src/types"
 	"github.com/otiai10/copy"
 )
 
@@ -54,7 +55,7 @@ func GetCryptoHashFromFile(path string, hashName crypto.Hash) (string, error) {
 type TextTemplate struct {
 	Sensitive  bool
 	AutoIndent bool
-	Type       string
+	Type       types.VariableType
 	Value      string
 }
 
@@ -193,9 +194,9 @@ func ReplaceTextTemplate(path string, mappings map[string]*TextTemplate, depreca
 				value = template.Value
 
 				// Check if the value is a file type and load the value contents from the file
-				if template.Type == "file" {
+				if template.Type == types.FileVariableType {
 					if isText, err := IsTextFile(value); err != nil || !isText {
-						message.Warn("Refusing to load a non-text file for templating")
+						message.Warnf("Refusing to load a non-text file for templating %s", templateKey)
 						line = matches[regexTemplateLine.SubexpIndex("postTemplate")]
 						continue
 					}

src/types/component.go

@@ -169,10 +169,10 @@ type ZarfComponentAction struct {
 
 // ZarfComponentActionSetVariable represents a variable that is to be set via an action
 type ZarfComponentActionSetVariable struct {
-	Name       string `json:"name" jsonschema:"description=The name to be used for the variable,pattern=^[A-Z0-9_]+$"`
-	Sensitive  bool   `json:"sensitive,omitempty" jsonschema:"description=Whether to mark this variable as sensitive to not print it in the Zarf log"`
-	AutoIndent bool   `json:"autoIndent,omitempty" jsonschema:"description=Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_."`
-	Type       string `json:"type,omitempty" jsonschema:"description=Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable),enum=raw,enum=file"`
+	Name       string       `json:"name" jsonschema:"description=The name to be used for the variable,pattern=^[A-Z0-9_]+$"`
+	Sensitive  bool         `json:"sensitive,omitempty" jsonschema:"description=Whether to mark this variable as sensitive to not print it in the Zarf log"`
+	AutoIndent bool         `json:"autoIndent,omitempty" jsonschema:"description=Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_."`
+	Type       VariableType `json:"type,omitempty" jsonschema:"description=Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB),enum=raw,enum=file"`
 }
 
 // ZarfComponentActionWait specifies a condition to wait for before continuing

src/types/package.go

@@ -47,13 +47,13 @@ type ZarfBuildData struct {
 
 // ZarfPackageVariable are variables that can be used to dynamically template K8s resources.
 type ZarfPackageVariable struct {
-	Name        string `json:"name" jsonschema:"description=The name to be used for the variable,pattern=^[A-Z0-9_]+$"`
-	Description string `json:"description,omitempty" jsonschema:"description=A description of the variable to be used when prompting the user a value"`
-	Default     string `json:"default,omitempty" jsonschema:"description=The default value to use for the variable"`
-	Prompt      bool   `json:"prompt,omitempty" jsonschema:"description=Whether to prompt the user for input for this variable"`
-	Sensitive   bool   `json:"sensitive,omitempty" jsonschema:"description=Whether to mark this variable as sensitive to not print it in the Zarf log"`
-	AutoIndent  bool   `json:"autoIndent,omitempty" jsonschema:"description=Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_."`
-	Type        string `json:"type,omitempty" jsonschema:"description=Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable),enum=raw,enum=file"`
+	Name        string       `json:"name" jsonschema:"description=The name to be used for the variable,pattern=^[A-Z0-9_]+$"`
+	Description string       `json:"description,omitempty" jsonschema:"description=A description of the variable to be used when prompting the user a value"`
+	Default     string       `json:"default,omitempty" jsonschema:"description=The default value to use for the variable"`
+	Prompt      bool         `json:"prompt,omitempty" jsonschema:"description=Whether to prompt the user for input for this variable"`
+	Sensitive   bool         `json:"sensitive,omitempty" jsonschema:"description=Whether to mark this variable as sensitive to not print it in the Zarf log"`
+	AutoIndent  bool         `json:"autoIndent,omitempty" jsonschema:"description=Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_."`
+	Type        VariableType `json:"type,omitempty" jsonschema:"description=Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB),enum=raw,enum=file"`
 }
 
 // ZarfPackageConstant are constants that can be used to dynamically template K8s resources.

src/types/runtime.go

@@ -13,8 +13,13 @@ const (
 	ManifestsFolder      = "manifests"
 	DataInjectionsFolder = "data"
 	ValuesFolder         = "values"
+
+	RawVariableType  VariableType = "raw"
+	FileVariableType VariableType = "file"
 )
 
+type VariableType string
+
 // ZarfCommonOptions tracks the user-defined preferences used across commands.
 type ZarfCommonOptions struct {
 	Confirm        bool   `json:"confirm" jsonschema:"description=Verify that Zarf should perform an action"`
@@ -86,11 +91,11 @@ type ZarfPartialPackageData struct {
 
 // ZarfSetVariable tracks internal variables that have been set during this run of Zarf
 type ZarfSetVariable struct {
-	Name       string `json:"name" jsonschema:"description=The name to be used for the variable,pattern=^[A-Z0-9_]+$"`
-	Sensitive  bool   `json:"sensitive,omitempty" jsonschema:"description=Whether to mark this variable as sensitive to not print it in the Zarf log"`
-	AutoIndent bool   `json:"autoIndent,omitempty" jsonschema:"description=Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_."`
-	Value      string `json:"value" jsonschema:"description=The value the variable is currently set with"`
-	Type       string `json:"type,omitempty" jsonschema:"description=Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable),enum=raw,enum=file"`
+	Name       string       `json:"name" jsonschema:"description=The name to be used for the variable,pattern=^[A-Z0-9_]+$"`
+	Sensitive  bool         `json:"sensitive,omitempty" jsonschema:"description=Whether to mark this variable as sensitive to not print it in the Zarf log"`
+	AutoIndent bool         `json:"autoIndent,omitempty" jsonschema:"description=Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_."`
+	Value      string       `json:"value" jsonschema:"description=The value the variable is currently set with"`
+	Type       VariableType `json:"type,omitempty" jsonschema:"description=Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB),enum=raw,enum=file"`
 }
 
 // ConnectString contains information about a connection made with Zarf connect.

src/ui/lib/api-types.ts

@@ -463,14 +463,14 @@ export interface ZarfComponentActionSetVariable {
     sensitive?: boolean;
     /**
      * Changes the handling of a variable to load contents differently (i.e. from a file rather
-     * than as a raw variable)
+     * than as a raw variable - templated files should be kept below 1 MiB)
      */
     type?: Type;
 }
 
 /**
  * Changes the handling of a variable to load contents differently (i.e. from a file rather
- * than as a raw variable)
+ * than as a raw variable - templated files should be kept below 1 MiB)
  */
 export enum Type {
     File = "file",
@@ -978,7 +978,7 @@ export interface ZarfPackageVariable {
     sensitive?: boolean;
     /**
      * Changes the handling of a variable to load contents differently (i.e. from a file rather
-     * than as a raw variable)
+     * than as a raw variable - templated files should be kept below 1 MiB)
      */
     type?: Type;
 }

zarf.schema.json

@@ -482,7 +482,7 @@
             "file"
           ],
           "type": "string",
-          "description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable)"
+          "description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)"
         }
       },
       "additionalProperties": false,
@@ -1019,7 +1019,7 @@
             "file"
           ],
           "type": "string",
-          "description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable)"
+          "description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)"
         }
       },
       "additionalProperties": false,