zarf.schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "$ref": "#/definitions/ZarfPackage",
  "definitions": {
    "ZarfBuildData": {
      "required": [
        "terminal",
        "user",
        "architecture",
        "timestamp",
        "string"
      ],
      "properties": {
        "terminal": {
          "type": "string"
        },
        "user": {
          "type": "string"
        },
        "architecture": {
          "type": "string"
        },
        "timestamp": {
          "type": "string"
        },
        "string": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfChart": {
      "required": [
        "name",
        "url",
        "version",
        "namespace"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "releaseName": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "version": {
          "type": "string"
        },
        "namespace": {
          "type": "string"
        },
        "valuesFiles": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "gitPath": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfComponent": {
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "default": {
          "type": "boolean"
        },
        "required": {
          "type": "boolean"
        },
        "files": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/ZarfFile"
          },
          "type": "array"
        },
        "charts": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/ZarfChart"
          },
          "type": "array"
        },
        "manifests": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/ZarfManifest"
          },
          "type": "array"
        },
        "images": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "repos": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "dataInjections": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/ZarfDataInjection"
          },
          "type": "array"
        },
        "scripts": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "$ref": "#/definitions/ZarfComponentScripts"
        },
        "import": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "$ref": "#/definitions/ZarfComponentImport"
        },
        "cosignKeyPath": {
          "type": "string"
        },
        "variables": {
          "patternProperties": {
            ".*": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "group": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfComponentImport": {
      "required": [
        "path"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "path": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfComponentScripts": {
      "properties": {
        "showOutput": {
          "type": "boolean"
        },
        "timeoutSeconds": {
          "type": "integer"
        },
        "retry": {
          "type": "boolean"
        },
        "before": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "after": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfContainerTarget": {
      "required": [
        "namespace",
        "selector",
        "path"
      ],
      "properties": {
        "namespace": {
          "type": "string"
        },
        "selector": {
          "type": "string"
        },
        "container": {
          "type": "string"
        },
        "path": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfDataInjection": {
      "required": [
        "source",
        "target"
      ],
      "properties": {
        "source": {
          "type": "string"
        },
        "target": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "$ref": "#/definitions/ZarfContainerTarget"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfFile": {
      "required": [
        "source",
        "target"
      ],
      "properties": {
        "source": {
          "type": "string"
        },
        "shasum": {
          "type": "string"
        },
        "target": {
          "type": "string"
        },
        "executable": {
          "type": "boolean"
        },
        "symlinks": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfManifest": {
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "namespace": {
          "type": "string"
        },
        "files": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "kustomizeAllowAnyDirectory": {
          "type": "boolean"
        },
        "kustomizations": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfMetadata": {
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "version": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "image": {
          "type": "string"
        },
        "uncompressed": {
          "type": "boolean"
        },
        "architecture": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ZarfPackage": {
      "properties": {
        "kind": {
          "type": "string"
        },
        "metadata": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "$ref": "#/definitions/ZarfMetadata"
        },
        "build": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "$ref": "#/definitions/ZarfBuildData"
        },
        "components": {
          "items": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "$ref": "#/definitions/ZarfComponent"
          },
          "type": "array"
        },
        "seed": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    }
  }
}