debian-forge/schemas/osbuild2.json
Dusty Mabe ce8408a9c6 mounts: support mounting partitions
This allows us to map in a whole disk as a loopback device with parition
scanning rather than slicing up the disk and creating several loopback
devices. Something like this:

```
      - type: org.osbuild.copy
        inputs:
          tree:
            type: org.osbuild.tree
            origin: org.osbuild.pipeline
            references:
              - name:tree
        options:
          paths:
            - from: input://tree/
              to: mount://root/
        devices:
          efi:
            type: org.osbuild.loopback
            options:
              filename: disk.img
              start:
                mpp-format-int: '{image.layout[''EFI-SYSTEM''].start}'
              size:
                mpp-format-int: '{image.layout[''EFI-SYSTEM''].size}'
          boot:
            type: org.osbuild.loopback
            options:
              filename: disk.img
              start:
                mpp-format-int: '{image.layout[''boot''].start}'
              size:
                mpp-format-int: '{image.layout[''boot''].size}'
          root:
            type: org.osbuild.loopback
            options:
              filename: disk.img
              start:
                mpp-format-int: '{image.layout[''root''].start}'
              size:
                mpp-format-int: '{image.layout[''root''].size}'
        mounts:
          - name: root
            type: org.osbuild.xfs
            source: root
            target: /
          - name: boot
            type: org.osbuild.ext4
            source: boot
            target: /boot
          - name: efi
            type: org.osbuild.fat
            source: efi
            target: /boot/efi
```

now becomes a little more simple:

```
      - type: org.osbuild.copy
        inputs:
          tree:
            type: org.osbuild.tree
            origin: org.osbuild.pipeline
            references:
              - name:tree
        options:
          paths:
            - from: input://tree/
              to: mount://root/
        devices:
          disk:
            type: org.osbuild.loopback
            options:
              filename: disk.img
              partscan: true
        mounts:
          - name: root
            type: org.osbuild.xfs
            source: disk
            partition:
              mpp-format-int: '{image.layout[''root''].partnum}'
            target: /
          - name: boot
            type: org.osbuild.ext4
            source: disk
            partition:
              mpp-format-int: '{image.layout[''boot''].partnum}'
            target: /boot
          - name: efi
            type: org.osbuild.fat
            source: disk
            partition:
              mpp-format-int: '{image.layout[''EFI-SYSTEM''].partnum}'
            target: /boot/efi
```

Fixes https://github.com/osbuild/osbuild/issues/1495
2023-12-22 10:18:29 -05:00

187 lines
4.8 KiB
JSON

{
"$schema": "http://json-schema.org/draft-04/schema#",
"$id": "https://osbuild.org/schemas/osbuild2.json",
"title": "OSBuild Manifest",
"description": "OSBuild manifest describing a pipeline and all parameters",
"type": "object",
"additionalProperties": false,
"required": ["version"],
"properties": {
"pipelines": { "$ref": "#/definitions/pipelines" },
"sources": { "$ref": "#/definitions/sources" },
"version": {
"enum": ["2"]
}
},
"definitions": {
"devices": {
"title": "Collection of devices for a stage",
"additionalProperties": {
"$ref": "#/definitions/device"
}
},
"device": {
"title": "Device for a stage",
"additionalProperties": false,
"required": ["type"],
"properties": {
"type": { "type": "string" },
"parent": { "type": "string" },
"options": {
"type": "object",
"additionalProperties": true
}
}
},
"inputs": {
"title": "Collection of inputs for a stage",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9_\\-\\.]{0,254}": {
"$ref": "#/definitions/input"
}
}
},
"input": {
"title": "Single input for a stage",
"additionalProperties": false,
"required": ["type", "origin", "references"],
"properties": {
"type": { "type": "string" },
"origin": { "enum": ["org.osbuild.source", "org.osbuild.pipeline"] },
"references": { "$ref": "#/definitions/reference" },
"options": {
"type": "object",
"additionalProperties": true
}
}
},
"mounts": {
"title": "Collection of mount points for a stage",
"type": "array",
"items": { "$ref": "#/definitions/mount"}
},
"mount": {
"title": "Mount point for a stage",
"additionalProperties": false,
"required": ["name", "type"],
"properties": {
"name": { "type": "string" },
"type": { "type": "string" },
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"partition": {
"type": "number"
},
"options": {
"type": "object",
"additionalProperties": true
}
}
},
"pipelines": {
"title": "Collection of pipelines to execute",
"description": "Array of pipelines to execute one after another",
"type": "array",
"items": { "$ref": "#/definitions/pipeline" }
},
"pipeline": {
"title": "Pipeline Description",
"description": "Full description of a pipeline to execute",
"type": "object",
"additionalProperties": false,
"properties": {
"name": { "type:": "string" },
"build": { "type": "string" },
"runner": { "type": "string" },
"source-epoch": { "type": "integer" },
"stages": { "$ref": "#/definitions/stages" }
}
},
"reference": {
"oneOf":[
{
"type": "array",
"items": { "type": "string" }
}, {
"type": "object",
"additionalProperties": true
}, {
"type": "array",
"items": {
"type": "object",
"required": ["id"],
"additionalProperties": false,
"properties": {
"id": { "type": "string" },
"options": {
"type": "object",
"additionalProperties": true
}
}
}
}
]
},
"source": {
"title": "External Source",
"description": "External source to be passed to the pipeline",
"type": "object",
"additionalProperties": false,
"properties": {
"items": { "$ref": "#/definitions/reference" },
"options": {
"type": "object",
"additionalProperties": true
}
},
"required": ["items"]
},
"sources": {
"title": "Collection of External Sources",
"description": "Collection of external sources to be passed to the pipeline",
"type": "object",
"additionalProperties": { "$ref": "#/definitions/source" }
},
"stage": {
"title": "Pipeline Stage",
"description": "Single stage of a pipeline executing one step",
"type": "object",
"additionalProperties": false,
"properties": {
"type": { "type": "string" },
"devices": { "$ref": "#/definitions/devices" },
"inputs": {"$ref": "#/definitions/inputs" },
"mounts": {"$ref": "#/definitions/mounts" },
"options": {
"type": "object",
"additionalProperties": true
}
},
"required": [ "type" ]
},
"stages": {
"type": "array",
"items": { "$ref": "#/definitions/stage" }
}
}
}