bundle.yaml Reference

Field Reference

All top-level fields are required unless marked Optional.

Complete Field List

Every property in bundle.yaml at every nesting level, including nested objects and array item fields. Array items appear as field[]. Pattern-keyed map entries appear as field.<keyId>.

Annotated Example

The complete app-bundle.example.yaml — same template used in the submission editor. Inline comments explain every field.

# Full field reference and documentation: see /docs/bundlespec in the App Hub.
#
# Schema version — identifies the bundle.yaml format version.
schemaVersion: "2.0.0"

# Publisher contact metadata shown in cards/details and used for support.
publisher:
  # Public name of the app publisher.
  name: "Acme Vision Ltd."
  # Main website for this publisher.
  website: "https://acmevision.example"
  # Support contact email.
  contactEmail: "support@acmevision.example"
  # URL where users can request support.
  supportUrl: "https://acmevision.example/support"

# Hardware and optional OS compatibility declarations.
compatibility:
  hardware:
    # Supported Torizon machine IDs.
    machineIds:
      - "verdin-imx8mm"
  torizonOS:
    # Optional min/max supported Torizon OS versions.
    minVersion: "7.2.0"
    maxVersion: "7.99.0"
    # Optional OSTree ref constraint.
    ostreeRef: "torizon/torizon-core-docker"

# App identity/discovery metadata and deployment targets.
bundle:
  # App identity and discovery metadata.
  meta:
    # Stable unique app identifier (reverse-DNS style recommended).
    id: "io.torizon.apphub.smart-camera"
    # Human-readable app name shown in UI.
    name: "Smart Camera Bundle"
    # Bundle release version (SemVer recommended).
    version: "1.2.0"

    # Short markdown summary shown in compact views.
    summary: |
      ## Smart Camera
      Edge camera pipeline with AI inference.

    # Long markdown description reference.
    description:
      # Keep literal value "file" for artifact references.
      type: file
      # Markdown filename included with this submission.
      path: "description.md"

    # SPDX identifier or license expression.
    license: "Proprietary"

    # Optional discovery tags.
    tags:
      - "vision"

    # Optional reference links shown in app details.
    links:
      homepage: "https://acmevision.example/products/smart-camera"
      documentation: "https://acmevision.example/docs/smart-camera"
      source: "https://git.example/acme/smart-camera"
      changelog: "https://acmevision.example/docs/smart-camera/changelog"

  # Deployment targets. Keep only sections your app uses.
  targets:
    # Optional OS customization target.
    os:
      tcbuild:
        # Keep literal value "file" for artifact references.
        type: file
        # YAML filename included with this submission.
        path: "tcbuild.yaml"
        # Optional checksum and file size metadata.
        sha256: "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
        sizeBytes: 1846
      # Git repositories cloned as tcbuild context.
      gitRepos:
        - url: "https://git.example/acme/device-configs.git"
          ref: "main"
          depth: 1
          submodules: false
      notes: "OS update built using tcbuild and bundled repos."

    # Optional application deployment target.
    application:
      compose:
        # Keep literal value "file" for artifact references.
        type: file
        # YAML filename included with this submission.
        path: "docker-compose.yml"
        # Optional checksum and file size metadata.
        sha256: "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789"
        sizeBytes: 932
        # Optional per-machine compose overrides.
        overrides:
          - path: "docker-compose.imx8.override.yml"
            machineIds:
              - "verdin-imx8mp"
              - "colibri-imx8x"
          - path: "docker-compose.am62.override.yml"
            machineIds:
              - "verdin-am62"
      # Optional app configuration override contract (App Hub specific).
      configOverrides:
        # Keep literal value "file" for artifact references.
        type: file
        # Config filename declared in docker-compose.yml `configs`.
        path: "config.txt"
        # Map of configurable keys (object key is the stable ID).
        keys:
          enableTelemetry:
            type: boolean
            name: "Enable telemetry"
            description: "Enables anonymous runtime telemetry reporting."
            default: true
          logLevel:
            type: list
            name: "Log level"
            description: "Selects the runtime log verbosity."
            default: "info"
            valuesList:
              - "debug"
              - "info"
              - "warn"
              - "error"
      # Optional credentials to pull private container images.
      registryCredentials:
        - registry: "ghcr.io"
          token: "${GITHUB_TOKEN}"
          note: "Token resolved by App Hub pipeline at publish time."
      notes: "Single-compose application deployment."

    # Optional extra subsystem payload artifacts.
    subsystems:
      - name: "Aux MCU Firmware"
        subsystemId: "mcu0"
        payload:
          # Keep literal value "file" for artifact references.
          type: file
          # Artifact filename included with this submission.
          path: "mcu_firmware.bin"
          # Optional checksum and file size metadata.
          sha256: "1111111111111111111111111111111111111111111111111111111111111111"
          sizeBytes: 262144
        kind: "mcu-firmware"
        notes: "Installed onto the device's MCU secondary."