zarf.schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "$ref": "#/definitions/ZarfPackage",
  "definitions": {
    "ZarfBuildData": {
      "required": [
        "terminal",
        "user",
        "architecture",
        "timestamp",
        "version"
      ],
      "properties": {
        "terminal": {
          "type": "string"
        },
        "user": {
          "type": "string"
        },
        "architecture": {
          "type": "string"
        },
        "timestamp": {
          "type": "string"
        },
        "version": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfChart": {
      "required": [
        "name",
        "url",
        "version",
        "namespace"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the chart to deploy"
        },
        "releaseName": {
          "type": "string",
          "description": "The name of the release to create"
        },
        "url": {
          "type": "string",
          "description": "The URL of the chart repository or git url if the chart is using a git repo instead of helm repo"
        },
        "version": {
          "type": "string",
          "description": "The version of the chart to deploy"
        },
        "namespace": {
          "type": "string",
          "description": "The namespace to deploy the chart to"
        },
        "valuesFiles": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "List of values files to include in the package"
        },
        "gitPath": {
          "type": "string",
          "description": "If using a git repo"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfComponent": {
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "pattern": "^[a-z0-9\\-]+$",
          "type": "string",
          "description": "The name of the component"
        },
        "description": {
          "type": "string",
          "description": "Message to include during package deploy describing the purpose of this component"
        },
        "default": {
          "type": "boolean",
          "description": "Determines the default Y/N state for installing this component on package deploy"
        },
        "required": {
          "type": "boolean",
          "description": "Do not prompt user to install this component"
        },
        "only": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "$ref": "#/definitions/ZarfComponentOnlyTarget",
          "description": "Filter when this component is included in package creation or deployment"
        },
        "group": {
          "type": "string",
          "description": "Create a user selector field based on all components in the same group"
        },
        "cosignKeyPath": {
          "type": "string",
          "description": "Specify a path to a public key to validate signed online resources"
        },
        "import": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "$ref": "#/definitions/ZarfComponentImport",
          "description": "Import a component from another Zarf package"
        },
        "scripts": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "$ref": "#/definitions/ZarfComponentScripts",
          "description": "Custom commands to run before or after package deployment"
        },
        "files": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/ZarfFile"
          },
          "type": "array",
          "description": "Files to place on disk during package deployment"
        },
        "charts": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/ZarfChart"
          },
          "type": "array",
          "description": "Helm charts to install during package deploy"
        },
        "manifests": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/ZarfManifest"
          },
          "type": "array"
        },
        "images": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "List of OCI images to include in the package"
        },
        "repos": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "List of git repos to include in the package"
        },
        "dataInjections": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/ZarfDataInjection"
          },
          "type": "array",
          "description": "Datasets to inject into a pod in the target cluster"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfComponentImport": {
      "required": [
        "path"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "path": {
          "pattern": "^(?!.*###ZARF_PKG_VAR_).*$",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfComponentOnlyCluster": {
      "properties": {
        "architecture": {
          "enum": [
            "amd64",
            "arm64"
          ],
          "type": "string",
          "description": "Only create and deploy to clusters of the given architecture"
        },
        "distros": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Future use"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfComponentOnlyTarget": {
      "properties": {
        "localOS": {
          "enum": [
            "linux",
            "darwin",
            "windows"
          ],
          "type": "string",
          "description": "Only deploy component to specified OS"
        },
        "cluster": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "$ref": "#/definitions/ZarfComponentOnlyCluster",
          "description": "Only deploy component to specified clusters"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfComponentScripts": {
      "properties": {
        "showOutput": {
          "type": "boolean",
          "description": "Show the output of the script during package deployment"
        },
        "timeoutSeconds": {
          "type": "integer",
          "description": "Timeout in seconds for the script"
        },
        "retry": {
          "type": "boolean",
          "description": "Retry the script if it fails"
        },
        "prepare": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Scripts to run before the component is added during package create"
        },
        "before": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Scripts to run before the component is deployed"
        },
        "after": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Scripts to run after the component successfully deploys"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfContainerTarget": {
      "required": [
        "namespace",
        "selector",
        "container",
        "path"
      ],
      "properties": {
        "namespace": {
          "type": "string",
          "description": "The namespace to target for data injection"
        },
        "selector": {
          "type": "string",
          "description": "The K8s selector to target for data injection"
        },
        "container": {
          "type": "string",
          "description": "The container to target for data injection"
        },
        "path": {
          "type": "string",
          "description": "The path to copy the data to in the container"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfDataInjection": {
      "required": [
        "source",
        "target"
      ],
      "properties": {
        "source": {
          "type": "string",
          "description": "A path to a local folder or file to inject into the given target pod + container"
        },
        "target": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "$ref": "#/definitions/ZarfContainerTarget",
          "description": "The target pod + container to inject the data into"
        },
        "compress": {
          "type": "boolean",
          "description": "Compress the data before transmitting using gzip.  Note: this requires support for tar/gzip locally and in the target image."
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfFile": {
      "required": [
        "source",
        "target"
      ],
      "properties": {
        "source": {
          "type": "string",
          "description": "Local file path or remote URL to add to the package"
        },
        "shasum": {
          "type": "string",
          "description": "SHA256 checksum of the file if the source is a URL"
        },
        "target": {
          "type": "string",
          "description": "The absolute or relative path wher the file should be copied to during package deploy"
        },
        "executable": {
          "type": "boolean",
          "description": "Determines if the file should be made executable during package deploy"
        },
        "symlinks": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "List of symlinks to create during package deploy"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfManifest": {
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "A name to give this collection of manifests"
        },
        "namespace": {
          "type": "string",
          "description": "The namespace to deploy the manifests to"
        },
        "files": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "List of individual K8s YAML files to deploy (in order)"
        },
        "kustomizeAllowAnyDirectory": {
          "type": "boolean",
          "description": "Allow traversing directory above the current directory if needed for kustomization"
        },
        "kustomizations": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "List of kustomization paths to include in the package"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfMetadata": {
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "pattern": "^[a-z0-9\\-]+$",
          "type": "string",
          "description": "Name to identify this Zarf package"
        },
        "description": {
          "type": "string",
          "description": "Additional information about this package"
        },
        "version": {
          "type": "string",
          "description": "Generic string to track the package version by a package author"
        },
        "url": {
          "type": "string",
          "description": "Link to package information when online"
        },
        "image": {
          "type": "string",
          "description": "An image URL to embed in this package for future Zarf UI listing"
        },
        "uncompressed": {
          "type": "boolean",
          "description": "Disable compression of this package"
        },
        "architecture": {
          "type": "string",
          "description": "The target cluster architecture of this package"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfPackage": {
      "required": [
        "kind",
        "components"
      ],
      "properties": {
        "kind": {
          "enum": [
            "ZarfInitConfig",
            "ZarfPackageConfig"
          ],
          "type": "string",
          "description": "The kind of Zarf package",
          "default": "ZarfPackageConfig"
        },
        "metadata": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "$ref": "#/definitions/ZarfMetadata",
          "description": "Package metadata"
        },
        "build": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "$ref": "#/definitions/ZarfBuildData",
          "description": "Zarf-generated package build data"
        },
        "components": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/ZarfComponent"
          },
          "type": "array",
          "description": "List of components to deploy in this package"
        },
        "seed": {
          "type": "string",
          "description": "Special image only used for ZarfInitConfig packages when used with the Zarf Injector"
        },
        "variables": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/ZarfPackageVariable"
          },
          "type": "array",
          "description": "Variable template values applied on deploy for K8s resources"
        },
        "constants": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/ZarfPackageConstant"
          },
          "type": "array",
          "description": "Constant template values applied on deploy for K8s resources"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfPackageConstant": {
      "required": [
        "name",
        "value"
      ],
      "properties": {
        "name": {
          "pattern": "^[A-Z_]+$",
          "type": "string",
          "description": "The name to be used for the constant"
        },
        "value": {
          "type": "string",
          "description": "The value to set for the constant during deploy"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfPackageVariable": {
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "pattern": "^[A-Z_]+$",
          "type": "string",
          "description": "The name to be used for the variable"
        },
        "default": {
          "type": "string",
          "description": "The default value to use for the variable"
        },
        "prompt": {
          "type": "boolean",
          "description": "Whether to prompt the user for input for this variable"
        }
      },
      "additionalProperties": false,
      "type": "object"
    }
  }
}