org.osbuild.containers

Inputs for container images

This reads images from the org.osbuild.containers directory in the sources store, or from oci-archive files in pipelines (typically created by org.osbuild.oci-archive).

The store is indexed by the "container image id", which is the digest of the container configuration file (rather than the outer manifest) and is what will be shown in the "podman images" output when the image is installed. This digest is stable as opposed to the manifest digest which can change during transfer and storage due to e.g. recompression.

When using pipeline sources, the first file (alphabetically) in the root of the tree is used as the oci archive file to install.

Schema 1

{
  "definitions": {
    "source-options": {
      "type": "object",
      "required": [
        "name"
      ],
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "description": "The name to use for the image"
        }
      }
    },
    "source-object-ref": {
      "type": "object",
      "additionalProperties": false,
      "minProperties": 1,
      "patternProperties": {
        ".*": {
          "$ref": "#/definitions/source-options"
        }
      }
    },
    "source-array-ref": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "options": {
            "$ref": "#/definitions/source-options"
          }
        }
      }
    },
    "source-origin": {
      "type": "string",
      "description": "When the origin of the input is a source",
      "enum": [
        "org.osbuild.source"
      ]
    },
    "pipeline-options": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "The name to use for the image"
        }
      }
    },
    "pipeline-object-ref": {
      "type": "object",
      "additionalProperties": false,
      "minProperties": 1,
      "patternProperties": {
        ".*": {
          "$ref": "#/definitions/pipeline-options"
        }
      }
    },
    "pipeline-array-ref": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "options": {
            "$ref": "#/definitions/pipeline-options"
          }
        }
      }
    },
    "pipeline-origin": {
      "type": "string",
      "description": "When the origin of the input is a pipeline",
      "enum": [
        "org.osbuild.pipeline"
      ]
    }
  },
  "additionalProperties": true,
  "oneOf": [
    {
      "additionalProperties": false,
      "required": [
        "type",
        "origin",
        "references"
      ],
      "properties": {
        "type": {
          "enum": [
            "org.osbuild.containers"
          ]
        },
        "origin": {
          "description": "The org.osbuild.source origin case",
          "$ref": "#/definitions/source-origin"
        },
        "references": {
          "description": "Container image id",
          "oneOf": [
            {
              "$ref": "#/definitions/source-array-ref"
            },
            {
              "$ref": "#/definitions/source-object-ref"
            }
          ]
        }
      }
    },
    {
      "additionalProperties": false,
      "required": [
        "type",
        "origin",
        "references"
      ],
      "properties": {
        "type": {
          "enum": [
            "org.osbuild.containers"
          ]
        },
        "origin": {
          "description": "The org.osbuild.source origin case",
          "$ref": "#/definitions/pipeline-origin"
        },
        "references": {
          "description": "References to pipelines",
          "oneOf": [
            {
              "$ref": "#/definitions/pipeline-array-ref"
            },
            {
              "$ref": "#/definitions/pipeline-object-ref"
            }
          ]
        }
      }
    }
  ]
}

Schema 2

{}