The OS Installer configuration manual

Type: object

The OS Installer configuration manual describes all required and optional entries of the installation.json configuration file. The related installation_schema.json schema file can be used to validate a custom configuration JSON, for example using the jsonschema Python module.
Example:

{
    "logging": {
        "logFile": "installer.log"
    },
    "backup": [
        {
            "description": "Configuration data",
            "backupDev": "/dev/mmcblk0p6",
            "backupFolders": [
                "folder/subfolder/"
            ],
            "backupRequiredFreeBytes": 104857600,
            "backupName": "configuration_data",
            "restoreDev": "/dev/disk/by-partlabel/data"
        },
        {
            "description": "Log files",
            "backupDev": "/dev/mmcblk0p5",
            "backupFolders": [
                "logs/"
            ],
            "backupRequiredFreeBytes": 524288000,
            "backupName": "device_logs"
        }
    ],
    "erase": [
        {
            "description": "Board eMMC disk",
            "targetDev": "/dev/mmcblk0"
        }
    ],
    "flash": [
        {
            "description": "Embedded OS",
            "srcImage": "embedded-os_0.1.wic.gz",
            "targetDev": "/dev/mmcblk0"
        }
    ],
    "check-partitions": {
        "scan": true,
        "targetPartitions": [
            "/dev/mmcblk0p1",
            "/dev/mmcblk0p6"
        ]
    },
    "gpt-fix-backup": [
        {
            "targetDev": "/dev/mmcblk0"
        }
    ],
    "grow-partitions": [
        {
            "targetDev": "/dev/mmcblk0",
            "partNum": 6
        }
    ],
    "extract": [
        {
            "description": "Application data",
            "archiveName": "application_data",
            "extractDev": "/dev/disk/by-partlabel/app"
        }
    ],
    "finish": [
        {
            "action": "showMessage",
            "message": "Installation is complete. Remove USB / SD storage and press OK when done to reboot."
        },
        {
            "action": "reboot"
        }
    ]
}

root logging
Type: object

The logging entry enables logging to file. On-screen logging is enabled regardless of this entry.
Example:

{
    "logFile": "installer.log"
}

root logging logFile
Type: string

The name of the log file to create.
Example:

"installer.log"

Additional Properties of any type are allowed.

root logging additionalProperties
Type: object

root backup
Type: array

The backup entry is an array that can be used to setup backup of folders to archive files before flashing and restore of archive files after flashing

Each item of this array must be:

root backup backup items

root backup backup items anyOf item 0
Type: object

Example:

{
    "description": "Configuration data",
    "backupDev": "/dev/mmcblk0p6",
    "backupFolders": [
        "folder/subfolder/"
    ],
    "backupRequiredFreeBytes": 104857600,
    "backupName": "configuration_data",
    "restoreDev": "/dev/disk/by-partlabel/data"
}

root backup backup items anyOf item 0 description
Type: string

The description of the stuff that will be backup
Example:

"Configuration data"

root backup backup items anyOf item 0 backupDev
Type: string

The block device partition where the files to backup reside.
Example:

"/dev/mmcblk0p6"

root backup backup items anyOf item 0 backupFolders
Type: array

An array of folders to include in the backup archive. The path should be relative to the root of the block device partition that contains the files to backup.

Each item of this array must be:

root backup backup items anyOf item 0 backupFolders backupFolders items

root backup backup items anyOf item 0 backupFolders backupFolders items anyOf item 0
Type: object

Example:

"folder/subfolder/"

Example:

[
    "folder/subfolder/"
]

root backup backup items anyOf item 0 backupRequiredFreeBytes
Type: integer Default: 0

Required free space in bytes in the FFLASH partition to host the backup archive file.
Example:

104857600

root backup backup items anyOf item 0 backupName
Type: string

The backup archive file name.
Example:

"configuration_data"

root backup backup items anyOf item 0 restoreDev
Type: string

The block device partition where the backup archives will be restored. The files will be restored to the same relative path of the backup phase. If this entry is not specified, the backup will not be restored.
Example:

"/dev/disk/by-partlabel/data"

Additional Properties of any type are allowed.

root backup backup items anyOf item 0 additionalProperties
Type: object

Example:

[
    {
        "description": "Configuration data",
        "backupDev": "/dev/mmcblk0p6",
        "backupFolders": [
            "folder/subfolder/"
        ],
        "backupRequiredFreeBytes": 104857600,
        "backupName": "configuration_data",
        "restoreDev": "/dev/disk/by-partlabel/data"
    },
    {
        "description": "Log files",
        "backupDev": "/dev/mmcblk0p5",
        "backupFolders": [
            "logs/"
        ],
        "backupRequiredFreeBytes": 524288000,
        "backupName": "device_logs"
    }
]

root erase
Type: array

The erase entry specifies which block device will be erased before flashing.

Each item of this array must be:

root erase erase items

root erase erase items anyOf item 0
Type: object

Example:

{
    "description": "Board eMMC disk",
    "targetDev": "/dev/mmcblk0"
}

root erase erase items anyOf item 0 description
Type: string

Example:

"Board eMMC disk"

root erase erase items anyOf item 0 targetDev
Type: string

The block device that will be erased before flashing.
Example:

"/dev/mmcblk0"

Additional Properties of any type are allowed.

root erase erase items anyOf item 0 additionalProperties
Type: object

Example:

[
    {
        "description": "Board eMMC disk",
        "targetDev": "/dev/mmcblk0"
    }
]

root flash
Type: array

The flash entry is an array of images and target devices to be flashed.

Each item of this array must be:

root flash flash items

root flash flash items anyOf item 0
Type: object

Example:

{
    "description": "Embedded OS",
    "srcImage": "embedded-os_0.1.wic.gz",
    "targetDev": "/dev/mmcblk0"
}

root flash flash items anyOf item 0 description
Type: string

Example:

"Embedded OS"

root flash flash items anyOf item 0 srcImage
Type: string

The file name of the image that will be flashed.
Example:

"embedded-os_0.1.wic.gz"

root flash flash items anyOf item 0 targetDev
Type: string

The block device where the image will be flashed to.
Example:

"/dev/mmcblk0"

Additional Properties of any type are allowed.

root flash flash items anyOf item 0 additionalProperties
Type: object

Example:

[
    {
        "description": "Embedded OS",
        "srcImage": "embedded-os_0.1.wic.gz",
        "targetDev": "/dev/mmcblk0"
    }
]

root check-partitions
Type: object

The check-partitions entry allows to wait for the listed partitions to be available after the flash process is complete.
Example:

{
    "scan": true,
    "targetPartitions": [
        "/dev/mmcblk0p1",
        "/dev/mmcblk0p6"
    ]
}

root check-partitions scan
Type: boolean Default: false

Force a rescan of the partition tables.
Example:

true

root check-partitions targetPartitions
Type: array

A list of partitions that will be checked after flashing. The OS Installer will wait for their availability.

Each item of this array must be:

root check-partitions targetPartitions targetPartitions items

root check-partitions targetPartitions targetPartitions items anyOf item 0
Type: string

Examples:

"/dev/mmcblk0p1"

"/dev/mmcblk0p6"

Example:

[
    "/dev/mmcblk0p1",
    "/dev/mmcblk0p6"
]

Additional Properties of any type are allowed.

root check-partitions additionalProperties
Type: object

root gpt-fix-backup
Type: array

The gpt-fix-backup entry is an array of block devices that need fixing of the backup GPT table. Unless the exact target block device is known beforehand the backup GPT table, which resides at the end of the disk, needs to be fixed.

Each item of this array must be:

root gpt-fix-backup gpt-fix-backup items

root gpt-fix-backup gpt-fix-backup items anyOf item 0
Type: object

Example:

{
    "targetDev": "/dev/mmcblk0"
}

root gpt-fix-backup gpt-fix-backup items anyOf item 0 targetDev
Type: string Default: ""

The block device whose backup GPT table will be fixed.
Example:

"/dev/mmcblk0"

Additional Properties of any type are allowed.

root gpt-fix-backup gpt-fix-backup items anyOf item 0 additionalProperties
Type: object

Example:

[
    {
        "targetDev": "/dev/mmcblk0"
    }
]

root grow-partitions
Type: array

The grow-partitions entry is an array of partitions that will be grown to fill all the available following free disk space.

Each item of this array must be:

root grow-partitions grow-partitions items

root grow-partitions grow-partitions items anyOf item 0
Type: object

Example:

{
    "targetDev": "/dev/mmcblk0",
    "partNum": 6
}

root grow-partitions grow-partitions items anyOf item 0 targetDev
Type: string

The block device where the partition that will be grown resides.
Example:

"/dev/mmcblk0"

root grow-partitions grow-partitions items anyOf item 0 partNum
Type: integer

The number of the partition that will be grown.
Example:

6

Additional Properties of any type are allowed.

root grow-partitions grow-partitions items anyOf item 0 additionalProperties
Type: object

Example:

[
    {
        "targetDev": "/dev/mmcblk0",
        "partNum": 6
    }
]

root extract
Type: array

The extract entry is an array of archives to extract to the specified target partitions.

Each item of this array must be:

root extract extract items

root extract extract items anyOf item 0
Type: object

Example:

{
    "description": "Application data",
    "archiveName": "application_data",
    "extractDev": "/dev/disk/by-partlabel/app"
}

root extract extract items anyOf item 0 description
Type: string

The description of the contents of the archive that will be extracted.
Example:

"Application data"

root extract extract items anyOf item 0 archiveName
Type: string

The file name of the archive to extract, without the tar file extension suffix. The following archive types will be autodetected: tar.gz, tar, tar.bz2, tar.xz.
Example:

"application_data"

root extract extract items anyOf item 0 extractDev
Type: string

The block device partition where the archive will be restored. The files will be extracted in the root folder of the partition, respecting the internal directory structure of the archive.
Example:

"/dev/disk/by-partlabel/app"

Additional Properties of any type are allowed.

root extract extract items anyOf item 0 additionalProperties
Type: object

Example:

[
    {
        "description": "Application data",
        "archiveName": "application_data",
        "extractDev": "/dev/disk/by-partlabel/app"
    }
]

root finish
Type: array

The finish entry is an array of actions that will be performed at the end of the flash process.

Each item of this array must be:

root finish finish items

root finish finish items anyOf The showMessage action
Type: object

The message to show in a prompted dialog when the flash process is complete.
Example:

{
    "action": "showMessage",
    "message": "Installation is complete. Remove USB / SD storage and press OK when done to reboot."
}

root finish finish items anyOf The showMessage action action
Type: string

The type of action to perform. Valid actions are: showMessage or reboot.
Example:

"showMessage"

root finish finish items anyOf The showMessage action message
Type: string

The message that will be prompted at the end of the flash.
Example:

"Installation is complete. Remove USB / SD storage and press OK when done to reboot."

Additional Properties of any type are allowed.

root finish finish items anyOf The showMessage action additionalProperties
Type: object

Example:

[
    {
        "action": "showMessage",
        "message": "Installation is complete. Remove USB / SD storage and press OK when done to reboot."
    },
    {
        "action": "reboot"
    }
]

Additional Properties of any type are allowed.

root additionalProperties
Type: object