uds.schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "$ref": "#/definitions/UDSBundle",
  "definitions": {
    "BundleChartOverrides": {
      "properties": {
        "values": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/BundleChartValue"
          },
          "type": "array",
          "description": "List of Helm chart values to set statically"
        },
        "variables": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/BundleChartVariable"
          },
          "type": "array",
          "description": "List of Helm chart variables to set via UDS variables"
        },
        "namespace": {
          "type": "string",
          "description": "The namespace to deploy the Helm chart to"
        },
        "valuesFiles": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "List of Helm chart value file  paths to set statically"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "BundleChartValue": {
      "required": [
        "path",
        "value"
      ],
      "properties": {
        "path": {
          "type": "string"
        },
        "value": {
          "additionalProperties": true
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "BundleChartVariable": {
      "required": [
        "path",
        "name"
      ],
      "properties": {
        "path": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "default": {
          "additionalProperties": true
        },
        "type": {
          "enum": [
            "raw",
            "file"
          ],
          "type": "string",
          "description": "The type of value to be processed"
        },
        "source": {
          "type": "string",
          "description": "Where the value is set from"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "BundleVariableExport": {
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "BundleVariableImport": {
      "required": [
        "name",
        "package"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "package": {
          "type": "string"
        },
        "description": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "Package": {
      "required": [
        "name",
        "ref"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string",
          "description": "Description of the Zarf package"
        },
        "repository": {
          "type": "string",
          "description": "The repository to import the package from"
        },
        "path": {
          "type": "string",
          "description": "The local path to import the package from"
        },
        "ref": {
          "type": "string",
          "description": "Ref (tag) of the Zarf package"
        },
        "flavor": {
          "type": "string",
          "description": "Flavor of the Zarf package"
        },
        "optionalComponents": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "List of optional components to include from the package (required components are always included)"
        },
        "publicKey": {
          "type": "string",
          "description": "The public key to use to verify the package"
        },
        "imports": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/BundleVariableImport"
          },
          "type": "array",
          "description": "List of Zarf variables to import from another Zarf package"
        },
        "exports": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/BundleVariableExport"
          },
          "type": "array",
          "description": "List of Zarf variables to export from the Zarf package"
        },
        "overrides": {
          "patternProperties": {
            ".*": {
              "patternProperties": {
                ".*": {
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "$ref": "#/definitions/BundleChartOverrides"
                }
              },
              "type": "object"
            }
          },
          "type": "object",
          "description": "Map of Helm chart overrides to set. The format is \u003ccomponent\u003e:"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "UDSBuildData": {
      "required": [
        "terminal",
        "user",
        "architecture",
        "timestamp",
        "version"
      ],
      "properties": {
        "terminal": {
          "type": "string",
          "description": "The machine name that created this package"
        },
        "user": {
          "type": "string",
          "description": "The username who created this package"
        },
        "architecture": {
          "type": "string",
          "description": "The architecture this package was created on"
        },
        "timestamp": {
          "type": "string",
          "description": "The timestamp when this package was created"
        },
        "version": {
          "type": "string",
          "description": "The version of Zarf used to build this package"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "UDSBundle": {
      "required": [
        "kind",
        "metadata",
        "packages"
      ],
      "properties": {
        "kind": {
          "enum": [
            "UDSBundle"
          ],
          "type": "string",
          "description": "The kind of UDS package"
        },
        "metadata": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "$ref": "#/definitions/UDSMetadata",
          "description": "UDSBundle metadata"
        },
        "build": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "$ref": "#/definitions/UDSBuildData",
          "description": "Generated bundle build data"
        },
        "packages": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/Package"
          },
          "type": "array",
          "description": "List of Zarf packages"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "UDSMetadata": {
      "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 set by a package author to track the package version"
        },
        "url": {
          "type": "string",
          "description": "Link to package information when online"
        },
        "uncompressed": {
          "type": "boolean",
          "description": "Disable compression of this package"
        },
        "architecture": {
          "type": "string",
          "description": "The target cluster architecture for this package",
          "examples": [
            "arm64",
            "amd64"
          ]
        },
        "authors": {
          "type": "string",
          "description": "Comma-separated list of package authors (including contact info)",
          "examples": [
            "Doug \u0026#60;hello@defenseunicorns.com\u0026#62;\u0026#44; Pepr \u0026#60;hello@defenseunicorns.com\u0026#62;"
          ]
        },
        "documentation": {
          "type": "string",
          "description": "Link to package documentation when online"
        },
        "source": {
          "type": "string",
          "description": "Link to package source code when online"
        },
        "vendor": {
          "type": "string",
          "description": "Name of the distributing entity, organization or individual."
        },
        "aggregateChecksum": {
          "type": "string",
          "description": "Checksum of a checksums.txt file that contains checksums all the layers within the package."
        }
      },
      "additionalProperties": false,
      "type": "object"
    }
  }
}