Blueprint format - image

[croissanne]

The goal is to have a long lived configuration object which will be reusable, exportable, importable, and which other services will depend on. As such the decisions made here are important.

Properties which I'm not sure about I've marked with ?...?.

This image template could be part of a larger 'launch' template, where you could specify deploy x instance of this image template.

Any properties which aren't marked as required don't have to be in the first version, they can be added later without breaking v1.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://console.redhat.com./api/image-builder/v1/image.json",

  "type": "object",
  "additionalProperties": false,
  "required": [
    "uuid",
    "version",
    "name",
    "distribution"
  ],
  "properties": {
    "uuid": {
      "type": "string",
      "format": "uuid"
    },
    "version": {
      "type": "integer",
      "description": "version of the blueprint schema",
      "minimum": 1
    },
    "name": {
      "type": "string"
    },
    "?description?": {
      "type": "string"
    },
    "distribution": {
      "type": "string",
      "description": "distribution this blueprint applies to"
    },

    "repositories": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "string",
        "description": "Points to a list repository IDs in the content service",
        "format": "uuid"
      }
    },

    "packages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },

    "filesystem": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "mountpoint",
          "size"
        ],
        "properties": {
          "mountpoint": {
            "type": "string"
          },
          "size": {
            "type": "integer",
            "description": "size in bytes"
          }
        }
      }
    }
  }
}

[croissanne]

After discussing and some fresh bugs we encountered, we should make packages an array of package objects. So

"packages": {
    "type": "array",
    "items": {
      "type": "object"
      "required": [
        "name",
        "description"
      ]
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        }
      }
    }
}

[TomasTomecek]

I'm curious about the requirement for the description here. It definitely makes sense to annotate why a certain package is included. Though I feel like people usually do that via comments:

packages:
- foo  # baz needs
- bar
- baz  # Jane Doe likes this one

I worry that some packages would have empty those descriptions if it was a required field.

[croissanne]

The filesystem needs to be expanded as well:

{
  "filesystem": {
    "oneOf": [
      {
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "must be lvm"
          },
          "mountpoints": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "mountpoint",
                "size"
              ],
              "properties": {
                "mountpoint": {
                  "type": "string"
                },
                "size": {
                  "type": "integer",
                  "description": "size in bytes"
                }
              }
            }
          },
          "max_size": {
            "type": "integer",
            "description": "maximum size in bytes"
          }
        }
      },
      {
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "must be btrfs"
          },
          "mountpoints": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "mountpoint"
              ],
              "properties": {
                "mountpoint": {
                  "type": "string"
                }
              }
            }
          },
          "compression": {
            "type": "int",
            "description": "level of compression"
          },
          "max_size": {
            "type": "integer",
            "description": "max size in bytes"
          }
        }
      },
      {
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "must be raw"
          },
          "mountpoints": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "mountpoint",
                "size"
              ],
              "properties": {
                "mountpoint": {
                  "type": "string"
                },
                "size": {
                  "type": "integer"
                }
              }
            }
          },
          "max_size": {
            "type": "integer",
            "description": "max size in bytes"
          }
        }
      }
    ]
  }
}