Zarf Package Configuration
Zarf Packages contain a comprehensive description of system software and all of it's components for declaratively deploying in a disconnected environment
| Type | object |
|---|---|
| File match |
**/zarf.yaml
**/zarf.yml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/zarf-package-configuration/latest.json |
| Source | https://www.schemastore.org/zarf.json |
Validate with Lintel
npx @lintel/lintel checkZarfPackage the top-level structure of a Zarf config file.
Properties
The kind of Zarf package.
The API version of the Zarf package.
ZarfMetadata lists information about the current ZarfPackage.
15 nested properties
Name to identify this Zarf package.
Additional information about this package.
Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with).
Link to package information when online.
An image URL to embed in this package (Reserved for future use in Zarf UI).
Disable compression of this package.
The target cluster architecture for this package.
Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.
Comma-separated list of package authors (including contact info).
Link to package documentation when online.
Link to package source code when online.
Name of the distributing entity, organization or individual.
Checksum of a checksums.txt file that contains checksums all the layers within the package.
Annotations contains arbitrary metadata about the package. Users are encouraged to follow OCI image-spec https://github.com/opencontainers/image-spec/blob/main/annotations.md
AllowNamespaceOverride controls whether a package's namespace may be overridden.
ZarfBuildData is written during the packager.Create() operation to track details of the created package.
12 nested properties
The machine name that created this package.
The username who created this package.
The architecture this package was created on.
The timestamp when this package was created.
The version of Zarf used to build this package.
Any migrations that have been run on this package.
Any registry domains that were overridden on package create when pulling images.
Whether this package was created with differential components.
Version of a previously built package used as the basis for creating this differential package.
List of components that were not included in this package due to differential packaging.
The minimum version of Zarf that does not have breaking package structure changes.
The flavor of Zarf used to build this package.
Constant template values applied on deploy for K8s resources.
Variable template values applied on deploy for K8s resources.
Definitions
Constant are constants that can be used to dynamically template K8s resources or run in actions.
The name to be used for the constant
The value to set for the constant during deploy
A description of the constant to explain its purpose on package create or deploy confirmation prompts
Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.
An optional regex pattern that a constant value must match before a package can be created.
DeprecatedZarfComponentScripts are scripts that run before or after a component is deployed.
Show the output of the script during package deployment.
Timeout in seconds for the script.
Retry the script if it fails.
Scripts to run before the component is added during package create.
Scripts to run before the component is deployed.
Scripts to run after the component successfully deploys.
InteractiveVariable is a variable that can be used to prompt a user for more information
The name to be used for the variable
Whether to mark this variable as sensitive to not print it in the log
Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.
An optional regex pattern that a variable value must match before a package deployment can continue.
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)
A description of the variable to be used when prompting the user a value
The default value to use for the variable
Whether to prompt the user for input for this variable
NamespacedObjectKindReference is a reference to a specific resource in a namespace using its kind and API version.
API Version of the resource
Kind of the resource
Namespace of the resource
Name of the resource
Shell represents the desired shell to use for a given command
(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)
(default 'sh') Indicates a preference for the shell to use on Linux systems
(default 'sh') Indicates a preference for the shell to use on macOS systems
Variable represents a variable that has a value set programmatically
The name to be used for the variable
Whether to mark this variable as sensitive to not print it in the log
Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.
An optional regex pattern that a variable value must match before a package deployment can continue.
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)
ZarfBuildData is written during the packager.Create() operation to track details of the created package.
The machine name that created this package.
The username who created this package.
The architecture this package was created on.
The timestamp when this package was created.
The version of Zarf used to build this package.
Any migrations that have been run on this package.
Any registry domains that were overridden on package create when pulling images.
Whether this package was created with differential components.
Version of a previously built package used as the basis for creating this differential package.
List of components that were not included in this package due to differential packaging.
The minimum version of Zarf that does not have breaking package structure changes.
The flavor of Zarf used to build this package.
ZarfChart defines a helm chart to be deployed.
The name of the chart within Zarf; note that this must be unique and does not need to be the same as the name in the chart repo.
The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos').
The URL of the OCI registry, chart repository, or git repo where the helm chart is stored.
The name of a chart within a Helm repository (defaults to the Zarf name of the chart).
(git repo only) The sub directory to the chart within a git repo.
The path to a local chart's folder or .tgz archive.
The namespace to deploy the chart to.
The name of the Helm release to create (defaults to the Zarf name of the chart).
Whether to not wait for chart resources to be ready before continuing.
List of local values file paths or remote URLs to include in the package; these will be merged together when deployed.
[alpha] List of variables to set in the Helm chart.
Whether or not to validate the values.yaml schema, defaults to true. Necessary in the air-gap when the JSON Schema references resources on the internet.
ZarfChartVariable represents a variable that can be set for a Helm chart overrides.
The name of the variable.
A brief description of what the variable controls.
The path within the Helm chart values where this variable applies.
ZarfComponent is the primary functional grouping of assets to deploy by Zarf.
The name of the component.
Message to include during package deploy describing the purpose of this component.
Determines the default Y/N state for installing this component on package deploy.
Do not prompt user to install this component.
ZarfComponentOnlyTarget filters a component to only show it for a given local OS and cluster.
3 nested properties
Only deploy component to specified OS.
ZarfComponentOnlyCluster represents the architecture and K8s cluster distribution to filter on.
2 nested properties
Only create and deploy to clusters of the given architecture.
A list of kubernetes distros this package works with (Reserved for future use).
Only include this component when a matching '--flavor' is specified on 'zarf package create'.
[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead.
ZarfComponentImport structure for including imported Zarf components.
3 nested properties
The name of the component to import from the referenced zarf.yaml.
The path to the directory containing the zarf.yaml to import.
[beta] The URL to a Zarf package to import via OCI.
Kubernetes manifests to be included in a generated Helm chart on package deploy.
Helm charts to install during package deploy.
Datasets to inject into a container in the target cluster.
Files or folders to place on disk during package deployment.
List of OCI images to include in the package.
List of git repos to include in the package.
DeprecatedZarfComponentScripts are scripts that run before or after a component is deployed.
6 nested properties
Show the output of the script during package deployment.
Timeout in seconds for the script.
Retry the script if it fails.
Scripts to run before the component is added during package create.
Scripts to run before the component is deployed.
Scripts to run after the component successfully deploys.
ZarfComponentActions are ActionSets that map to different zarf package operations.
3 nested properties
ZarfComponentActionSet is a set of actions to run during a zarf package operation.
5 nested properties
ZarfComponentActionDefaults sets the default configs for child actions.
Actions to run at the start of an operation.
Actions to run at the end of an operation.
Actions to run if all operations succeed.
Actions to run if all operations fail.
ZarfComponentActionSet is a set of actions to run during a zarf package operation.
5 nested properties
ZarfComponentActionDefaults sets the default configs for child actions.
Actions to run at the start of an operation.
Actions to run at the end of an operation.
Actions to run if all operations succeed.
Actions to run if all operations fail.
ZarfComponentActionSet is a set of actions to run during a zarf package operation.
5 nested properties
ZarfComponentActionDefaults sets the default configs for child actions.
Actions to run at the start of an operation.
Actions to run at the end of an operation.
Actions to run if all operations succeed.
Actions to run if all operations fail.
List of resources to health check after deployment
ZarfComponentAction represents a single action to run during a zarf package operation.
Hide the output of the command during package deployment (default false).
Timeout in seconds for the command (default to 0, no timeout for cmd actions and 300, 5 minutes for wait actions).
Retry the command if it fails up to given number of times (default 0).
The working directory to run the command in (default is CWD).
Additional environment variables to set for the command.
The command to run. Must specify either cmd or wait for the action to do anything.
Shell represents the desired shell to use for a given command
3 nested properties
(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)
(default 'sh') Indicates a preference for the shell to use on Linux systems
(default 'sh') Indicates a preference for the shell to use on macOS systems
[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0.
(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.
Description of the action to be displayed during package execution instead of the command.
ZarfComponentActionWait specifies a condition to wait for before continuing
2 nested properties
ZarfComponentActionWaitCluster specifies a condition to wait for before continuing
4 nested properties
The kind of resource to wait for.
The name of the resource or selector to wait for.
The namespace of the resource to wait for.
The condition or jsonpath state to wait for; defaults to exist, a special condition that will wait for the resource to exist.
ZarfComponentActionWaitNetwork specifies a condition to wait for before continuing
3 nested properties
The protocol to wait for.
The address to wait for.
The HTTP status code to wait for if using http or https.
ZarfComponentActionDefaults sets the default configs for child actions.
Hide the output of commands during execution (default false).
Default timeout in seconds for commands (default to 0, no timeout).
Retry commands given number of times if they fail (default 0).
Working directory for commands (default CWD).
Additional environment variables for commands.
Shell represents the desired shell to use for a given command
3 nested properties
(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)
(default 'sh') Indicates a preference for the shell to use on Linux systems
(default 'sh') Indicates a preference for the shell to use on macOS systems
ZarfComponentActionSet is a set of actions to run during a zarf package operation.
ZarfComponentActionDefaults sets the default configs for child actions.
6 nested properties
Hide the output of commands during execution (default false).
Default timeout in seconds for commands (default to 0, no timeout).
Retry commands given number of times if they fail (default 0).
Working directory for commands (default CWD).
Additional environment variables for commands.
Shell represents the desired shell to use for a given command
3 nested properties
(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)
(default 'sh') Indicates a preference for the shell to use on Linux systems
(default 'sh') Indicates a preference for the shell to use on macOS systems
Actions to run at the start of an operation.
Actions to run at the end of an operation.
Actions to run if all operations succeed.
Actions to run if all operations fail.
ZarfComponentActionWait specifies a condition to wait for before continuing
ZarfComponentActionWaitCluster specifies a condition to wait for before continuing
4 nested properties
The kind of resource to wait for.
The name of the resource or selector to wait for.
The namespace of the resource to wait for.
The condition or jsonpath state to wait for; defaults to exist, a special condition that will wait for the resource to exist.
ZarfComponentActionWaitNetwork specifies a condition to wait for before continuing
3 nested properties
The protocol to wait for.
The address to wait for.
The HTTP status code to wait for if using http or https.
ZarfComponentActionWaitCluster specifies a condition to wait for before continuing
The kind of resource to wait for.
The name of the resource or selector to wait for.
The namespace of the resource to wait for.
The condition or jsonpath state to wait for; defaults to exist, a special condition that will wait for the resource to exist.
ZarfComponentActionWaitNetwork specifies a condition to wait for before continuing
The protocol to wait for.
The address to wait for.
The HTTP status code to wait for if using http or https.
ZarfComponentActions are ActionSets that map to different zarf package operations.
ZarfComponentActionSet is a set of actions to run during a zarf package operation.
5 nested properties
ZarfComponentActionDefaults sets the default configs for child actions.
6 nested properties
Hide the output of commands during execution (default false).
Default timeout in seconds for commands (default to 0, no timeout).
Retry commands given number of times if they fail (default 0).
Working directory for commands (default CWD).
Additional environment variables for commands.
Shell represents the desired shell to use for a given command
Actions to run at the start of an operation.
Actions to run at the end of an operation.
Actions to run if all operations succeed.
Actions to run if all operations fail.
ZarfComponentActionSet is a set of actions to run during a zarf package operation.
5 nested properties
ZarfComponentActionDefaults sets the default configs for child actions.
6 nested properties
Hide the output of commands during execution (default false).
Default timeout in seconds for commands (default to 0, no timeout).
Retry commands given number of times if they fail (default 0).
Working directory for commands (default CWD).
Additional environment variables for commands.
Shell represents the desired shell to use for a given command
Actions to run at the start of an operation.
Actions to run at the end of an operation.
Actions to run if all operations succeed.
Actions to run if all operations fail.
ZarfComponentActionSet is a set of actions to run during a zarf package operation.
5 nested properties
ZarfComponentActionDefaults sets the default configs for child actions.
6 nested properties
Hide the output of commands during execution (default false).
Default timeout in seconds for commands (default to 0, no timeout).
Retry commands given number of times if they fail (default 0).
Working directory for commands (default CWD).
Additional environment variables for commands.
Shell represents the desired shell to use for a given command
Actions to run at the start of an operation.
Actions to run at the end of an operation.
Actions to run if all operations succeed.
Actions to run if all operations fail.
ZarfComponentImport structure for including imported Zarf components.
The name of the component to import from the referenced zarf.yaml.
The path to the directory containing the zarf.yaml to import.
[beta] The URL to a Zarf package to import via OCI.
ZarfComponentOnlyCluster represents the architecture and K8s cluster distribution to filter on.
Only create and deploy to clusters of the given architecture.
A list of kubernetes distros this package works with (Reserved for future use).
ZarfComponentOnlyTarget filters a component to only show it for a given local OS and cluster.
Only deploy component to specified OS.
ZarfComponentOnlyCluster represents the architecture and K8s cluster distribution to filter on.
2 nested properties
Only create and deploy to clusters of the given architecture.
A list of kubernetes distros this package works with (Reserved for future use).
Only include this component when a matching '--flavor' is specified on 'zarf package create'.
ZarfContainerTarget defines the destination info for a ZarfData target
The namespace to target for data injection.
The K8s selector to target for data injection.
The container name to target for data injection.
The path within the container to copy the data into.
ZarfDataInjection is a data-injection definition.
Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container.
ZarfContainerTarget defines the destination info for a ZarfData target
4 nested properties
The namespace to target for data injection.
The K8s selector to target for data injection.
The container name to target for data injection.
The path within the container to copy the data into.
Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.
ZarfFile defines a file to deploy.
Local folder or file path or remote URL to pull into the package.
The absolute or relative path where the file or folder should be copied to during package deploy.
(files only) Optional SHA256 checksum of the file.
(files only) Determines if the file should be made executable during package deploy.
List of symlinks to create during package deploy.
Local folder or file to be extracted from a 'source' archive.
ZarfManifest defines raw manifests Zarf will deploy as a helm chart.
A name to give this collection of manifests; this will become the name of the dynamically-created helm chart.
The namespace to deploy the manifests to.
List of local K8s YAML files or remote URLs to deploy (in order).
Allow traversing directory above the current directory if needed for kustomization.
List of local kustomization paths or remote URLs to include in the package.
Whether to not wait for manifest resources to be ready before continuing.
ZarfMetadata lists information about the current ZarfPackage.
Name to identify this Zarf package.
Additional information about this package.
Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with).
Link to package information when online.
An image URL to embed in this package (Reserved for future use in Zarf UI).
Disable compression of this package.
The target cluster architecture for this package.
Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.
Comma-separated list of package authors (including contact info).
Link to package documentation when online.
Link to package source code when online.
Name of the distributing entity, organization or individual.
Checksum of a checksums.txt file that contains checksums all the layers within the package.
Annotations contains arbitrary metadata about the package. Users are encouraged to follow OCI image-spec https://github.com/opencontainers/image-spec/blob/main/annotations.md
AllowNamespaceOverride controls whether a package's namespace may be overridden.