Formatter Validator Minifier Escape / Unescape JSON ↔ String JSON ↔ YAML JSON → CSV NDJSON / JSON Lines JSON → Types JSON ↔ XML JSON Diff JSON Patch Canonicalize (RFC 8785) Schema Validator Schema Generator JSONPath Tester JWT Decoder JSON Errors Schemas More Tools
JSONTools / Schema registry / Zarf Package Configuration
Schema registry

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

**/zarf.yaml**/zarf.yml
Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your **/zarf.yaml and it validates in your browser — nothing is uploaded.

Validate a **/zarf.yaml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field Type Description
apiVersionstringThe API version of the Zarf package.
one of: "zarf.dev/v1alpha1…
kindrequiredstringThe kind of Zarf package.
default: "ZarfPackageConfig"
one of: "ZarfInitConfig", "ZarfPackageConfig…
metadataobjectZarfMetadata lists information about the current ZarfPackage.
metadata.namerequiredstringName to identify this Zarf package.
metadata.descriptionstringAdditional information about this package.
metadata.versionstringGeneric string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with).
metadata.urlstringLink to package information when online.
metadata.imagestringAn image URL to embed in this package (Reserved for future use in Zarf UI).
metadata.uncompressedbooleanDisable compression of this package.
metadata.architecturestringThe target cluster architecture for this package.
metadata.yolobooleanYaml 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.
metadata.authorsstringComma-separated list of package authors (including contact info).
metadata.documentationstringLink to package documentation when online.
metadata.sourcestringLink to package source code when online.
metadata.vendorstringName of the distributing entity, organization or individual.
metadata.aggregateChecksumstringChecksum of a checksums.txt file that contains checksums all the layers within the package.
metadata.annotationsobjectAnnotations contains arbitrary metadata about the package. Users are encouraged to follow OCI image-spec https://github.com/opencontainers/image-spec/blob/main/annotations.md
metadata.allowNamespaceOverridebooleanAllowNamespaceOverride controls whether a package's namespace may be overridden.
buildobjectZarfBuildData is written during the packager.Create() operation to track details of the created package.
build.terminalrequiredstringThe machine name that created this package.
build.userrequiredstringThe username who created this package.
build.architecturerequiredstringThe architecture this package was created on.
build.timestamprequiredstringThe timestamp when this package was created.
build.versionrequiredstringThe version of Zarf used to build this package.
build.migrationsarray<string>Any migrations that have been run on this package.
build.registryOverridesobjectAny registry domains that were overridden on package create when pulling images.
build.differentialbooleanWhether this package was created with differential components.
build.differentialPackageVersionstringVersion of a previously built package used as the basis for creating this differential package.
build.differentialMissingarray<string>List of components that were not included in this package due to differential packaging.
build.lastNonBreakingVersionstringThe minimum version of Zarf that does not have breaking package structure changes.
build.flavorstringThe flavor of Zarf used to build this package.
componentsrequiredarrayList of components to deploy in this package.
constantsarrayConstant template values applied on deploy for K8s resources.
variablesarrayVariable template values applied on deploy for K8s resources.
Audit

What we found in this schema

Standards

Specification sections for the keywords in this schema

Keyword Document Section
$idJSON Schema Core, draft 2020-12§8.2.1 — The "$id" Keyword
$refJSON Schema Core, draft 2020-12§8.2.3.1 — Direct References with "$ref"
$schemaJSON Schema Core, draft 2020-12§8.1.1 — "$schema"
additionalPropertiesJSON Schema Core, draft 2020-12§10.3.2.3 — "additionalProperties"
defaultJSON Schema Validation, draft 2020-12§9.2 — "default"
descriptionJSON Schema Validation, draft 2020-12§9.1 — "title" and "description"
enumJSON Schema Validation, draft 2020-12§6.1.2 — "enum"
examplesJSON Schema Validation, draft 2020-12§9.5 — "examples"
itemsJSON Schema Core, draft 2020-12§10.3.1.2 — "items"
patternJSON Schema Validation, draft 2020-12§6.3.3 — "pattern"
patternPropertiesJSON Schema Core, draft 2020-12§10.3.2.2 — "patternProperties"
propertiesJSON Schema Core, draft 2020-12§10.3.2.1 — "properties"
requiredJSON Schema Validation, draft 2020-12§6.5.3 — "required"
typeJSON Schema Validation, draft 2020-12§6.1.1 — "type"

Documents

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas