Skip to main content

MigrationTemplatePreview

kindstringrequired

Possible values: [template, compose_project]

namestringrequired

The template's file name, or the project's name.

titlestring

A template's <Name>. Absent for a project.

classMigrationTemplateClass

What a dockerMan template stands for in the Phase A capture: autostart (on Unraid's autostart list), running, stopped, template_only (a template with no container), or unknown for every template when the capture has no usable container list.

Possible values: [autostart, running, stopped, template_only, unknown]

countedboolean

Whether a template is in the report's clean and warning counts. Absent for a project.

statusMigrationTemplateStatusrequired

How a conversion reads. clean means no warning of class untranslated_flag, untranslated_field, flagged_path, missing_network or conflict. warnings has at least one. failed is a template the converter could not read. previewed is a Compose Manager project's compose.yaml, which is never converted. missing is a project whose compose.yaml is not in the source.

Possible values: [clean, warnings, failed, previewed, missing]

sourcestringrequired

The template XML, or the project's compose.yaml, as the flash holds it.

composestring

The generated Compose file, or the project's own compose.yaml. Not applied anywhere. Absent when the converter failed.

warnings object[]required

Every warning of a converted template. Empty for a project.

  • Array [
  • classstringrequired

    untranslated_flag is an ExtraParams flag or word that has no Compose equivalent here. untranslated_field is a template field or entry that could not be carried over. flagged_path is a host path outside the pool and the cache. missing_network is a custom network the template names. conflict is two entries for one target with different values. writable_layer is the warning every conversion carries about state inside the source container. note is informational.

    Possible values: [untranslated_flag, untranslated_field, flagged_path, missing_network, conflict, writable_layer, note]

    messagestringrequired

    Plain-language explanation.

    detailstring

    The flag, path, network name or entry concerned.

    commandstring

    Only on missing_network: the docker network create command. In a conversion it holds <PLACEHOLDER> values for what the template does not say; in an install plan it is the exact docker network create <name> for the network that was chosen.

  • ]
  • privileges object[]required

    The privilege summary of the Compose content.

  • Array [
  • kindstringrequired

    Possible values: [privileged, host_network, host_pid, host_cgroup, device_cgroup_rules, added_capabilities, confinement_disabled, group_add, docker_socket, host_path, gpu_reservation, container_runtime]

    servicestringrequired

    The Compose service that asks for it.

    detailstring

    The path, process namespace, rules, capabilities, security options, groups, device reservations or runtime concerned, comma-separated when there are several (the entries of gpu_reservation are separated by a semicolon, each one listing its own driver, count or device ids and capabilities with commas); absent for privileged, host_network and host_cgroup.

    descriptionstringrequired

    Plain-language explanation of what it grants.

  • ]
  • errorstring

    Why the template or project could not be read. Present only when status is failed.

    MigrationTemplatePreview
    {
    "kind": "template",
    "name": "string",
    "title": "string",
    "class": "autostart",
    "counted": true,
    "status": "clean",
    "source": "string",
    "compose": "string",
    "warnings": [
    {
    "class": "untranslated_flag",
    "message": "string",
    "detail": "string",
    "command": "string"
    }
    ],
    "privileges": [
    {
    "kind": "privileged",
    "service": "string",
    "detail": "string",
    "description": "string"
    }
    ],
    "error": "string"
    }