Manifest File Reference

A manifest file is a file that is required for importing an OUTSCALE Machine Image (OMI) from an OUTSCALE Object Storage (OOS) bucket. For more information, see Copying an OMI Across Regions.

A manifest file can be created in two ways:

  • Automatically: When you export an OMI to a bucket via Cockpit or the CreateImageExportTask API method, the manifest file and all the necessary snapshots are automatically created directly in the bucket.

  • Manually: You can also manually write the manifest file corresponding to the OMI, and then manually upload this file and all necessary snapshots to the bucket, but this requires more steps.

Once the manifest file exists in the bucket, the OMI can be imported.

To manually write a manifest file, you need to create a JSON file following this structure:

Manifest file sample
{
  "Version": 1,
  "Image": {
    "Name": "image-example",
    "Description": "",
    "Architecture": "x86_64",
    "Type": "machine",
    "ProductTypes": [
      "0001"
    ],
    "Public": false,
    "Snapshots": [
      {
        "DeleteOnTermination": false,
        "Device": "/dev/sda1",
        "Filename": "snap-11111111-aaaaaaaa.qcow2.gz",
        "Iops": null,
        "PreSignedUrl": "https://oos.eu-west-2.outscale.com/<BUCKET>/snap-11111111-aaaaaaaa.qcow2.gz?<...>",
        "Size": 10737418240,
        "VolumeType": "standard"
      },
      {
        "DeleteOnTermination": false,
        "Device": "/dev/sda2",
        "Filename": "snap-22222222-aaaaaaaa.qcow2.gz",
        "Iops": null,
        "PreSignedUrl": "https://oos.eu-west-2.outscale.com/<BUCKET>/snap-22222222-aaaaaaaa.qcow2.gz?<...>",
        "Size": 21474836480,
        "VolumeType": "standard"
      }
    ]
  }
}

This file contains the following attributes:

Attribute Required Description

Version

Yes

The version of the manifest file format (always 1).

Image

Yes

Information about the OMI you want to export.

Name

No

The name of the OMI.

This name must be unique and must contain between 3 and 128 characters. Allowed characters are a-z, A-Z, 0-9, spaces, and [_()/.-].

Description

No

A description for the OMI.

This description can contain any Unicode character, with no length limit.

Architecture

No

The architecture of the OMI (i386 or x86_64).

Type

No

The type of OMI (always machine).

ProductTypes

Yes

The product codes associated with the OMI.

Public

No

Whether the OMI is public or private.

Snapshots

Yes

Information about the snapshots associated with the OMI.

DeleteOnTermination

No

If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.

Device

Yes

The device name for the volume. For a root device, you must use /dev/sda1. For other volumes, you must use /dev/sdX, /dev/sdXX, /dev/xvdX, or /dev/xvdXX (where the first X is a letter between b and z, and the second X is a letter between a and z).

Filename

Yes

The name of the snapshot file on the bucket.

Iops

No

The number of I/O operations per second (IOPS) (only for io1 volumes). The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.

PreSignedUrl

Yes

The pre-signed URL of the snapshot file. For more information, see Creating a Pre-Signed URL.

Size

Yes

The size of the uncompressed snapshot, in bytes.

VolumeType

No

The type of the volume (standard | gp2 | io1). For more information, see About Volumes > Volume Types and IOPS.

Related Pages

Export to PDF