Creating a Manifest File for an Image Export Task

You can manually create a manifest file for an OUTSCALE Machine Image (OMI) you want to export to another account.

You can upload the manifest file on a bucket containing the snapshots associated with the OMI, and create a pre-signed URL for it. The OMI can then be imported to another account using the pre-signed URL of its manifest file.

The manifest file is obsolete seven days after a completed export as it contains pre-signed URLs to the appropriate snapshots (pre-signed URL are valid for only seven days).

Before you begin:

  1. Upload to a bucket all the snapshots associated with the OMI you want to export. For more information, see Uploading an Object to a Bucket.

  2. Create a pre-signed URL for each snapshot. For more information, see Configuring a Pre-signed URL.

To create a manifest file, use a texte editor and follow this syntax:

Manifest sample
{
  "Version": 1
  "Image": {
    "Name": "OMI_NAME",
    "ProductTypes": [
    "0001"
    ],
    "Snapshots": [
     {
         "Ordering": 58659,
         "VolumeType": "standard",
         "PreSignedUrl": "http://oos.eu-west-2.outscale.com/SNAPSHOT_URL",
         "Filename": "export/ami-12a3456b/snap-d9d14b2e-c7f1ef08.qcow2.gz",
         "CompressedSize": 974,
         "DeleteOnTermination": false,
         "Device": "/dev/sda1",
         "Size": 10737418240
     }
  {
         "Ordering": 58660,
         "VolumeType": "standard",
         "PreSignedUrl": "http://oos.eu-west-2.outscale.com/SNAPSHOT_URL",
         "Filename": "export/ami-d9d14b2e/snap-12a3456b-c7f1ef08.qcow2.gz",
         "CompressedSize": 863,
         "DeleteOnTermination": false,
         "Device": "/dev/sda2",
         "Size": 10627417139
     }
  ],
   "User": "699659413885",
   "Description": "description of the image",
   "Type": "machine",
   "Public": false,
   "Architecture": "x86_64"
  },
}

This manifest contains the following attributes that you need to specify:

  • Version (optional): The version of the manifest file.

  • Image: Information about the OMI you want to export. This attribute requires the following elements:

    • Name: The name of the OMI.

      This name must be unique for the account of the user importing the OMI. Otherwise, the image import task fails.

    • ProductTypes: The product code associated with the OMI (0001 Linux/Unix | 0002 Windows | 0004 Linux/Oracle | 0005 Windows 10).

    • Snapshots: Information about the snapshots associated with the OMI. This attribute requires the following elements for each snapshot:

      • Ordering: The snapshot creation order (The value of this attribute must be an integer).

      • VolumeType: The type of the disk volume associated with the instance (standard | gp2 | io1). For more information, see About Volumes > Volume Types and IOPS.

      • PreSignedUrl: The pre-signed URL of the snapshot file, in one of the following formats: qcow2, raw, qcow2.gz, or raw.gz. For more information, see Configuring a Pre-signed URL.

      • Filename: The name of the snapshot file on the bucket.

      • CompressedSize: The real size of the snapshot file, in bytes.

      • DeleteOnTermination: If true, the snapshot is deleted when the instance is terminated. if false, it is not deleted.

      • Device: The device name associated with the snapshot. For more information, see About Volumes > Volumes Attachment and Device Names.

        The device name must be unique for each snapshot, and correspond to the ones defined by the Operating System.

      • Size: The virtual size of the snapshot, in bytes.

    • User (optional): The account ID of the user exporting the OMI. For more information, see Getting Information About Your Account and Quotas.

    • Description: Additional information about the OMI you want to export.

      This attribute is mandatory, even if you leave it blank.

    • Type: The type of OMI (always machine).

    • Public: Whether the OMI is public or private (always false).

    • Architecture: The architecture of the Operating System contained in the OMI (i386 for 32-bit, x86_64 for 64-bit)

      The architecture of an official OMI is available on Cockpit or using the describe-images command. For more information, see Getting Information About Your OMIs.

Related Pages