OCI Image Migrate Utilities

Oracle Linux 9

1. Enable the ol9_addons yum repository for Oracle Linux 9:

   Copy

   sudo dnf config-manager --enable ol9_addons

2. Update your system by using the dnf update command, then install the required packages:

   Copy

   sudo dnf update -y
   sudo dnf install -y python36-oci-sdk python36-oci-cli oci-utils-migrate

3. If you intend to migrate a physical installation, install the qemu-img package:

   Copy

   sudo dnf install -y qemu-img

Oracle Linux 8

1. Enable the ol8_addons yum repository for Oracle Linux 8:

   Copy

   sudo dnf config-manager --enable ol8_addons

2. Update your system by using the dnf update command, then install the required packages:

   Copy

   sudo dnf update -y
   sudo dnf install -y python36-oci-sdk python36-oci-cli oci-utils-migrate

3. If you intend to migrate a physical installation, install the qemu-img package:

   Copy

   sudo dnf install -y qemu-img

Oracle Linux 7 (extended support)

1. Enable the ol7_addons and the ol7_kvm_utils repositories for Oracle Linux 7:

   Copy

   sudo yum-config-manager --enable ol7_addons ol7_kvm_utils

2. Update your system by using the yum update command, then install the required packages:

   Copy

   sudo yum update -y
   sudo yum install -y python36-oci-sdk python36-oci-cli oci-utils-migrate

3. If you intend to migrate a physical installation, install the qemu-img package:

   Copy

   sudo yum install -y qemu-img

Create the Raw Disk Image

1. Before shutting down the physical machine to create the image, temporarily include all device drivers in the initial ramdisk (initramfs):

   Copy

   sudo dracut --force --no-hostonly

2. After powering down the physical machine, use a recovery system to create a disk image to an external location:

   sudo dd if=device_or_volume of=path_to_image bs=4M status=progress conv=sync,noerror

3. Select a disk format VMDK (compatible with Oracle VM Virtualbox) or QCOW2 (compatible with Oracle Linux KVM), and then convert the disk image.

Option 1: Convert to Virtual Machine Disk Format (VMDK)

1. Convert your raw disk image to Virtual Machine Disk (VMDK) format. This file format is used for virtual hard disks that are compatible with Oracle VM Virtualbox.

   qemu-img convert -f raw -p -O vmdk raw_disk_image exported_file.vmdk

2. Optionally test your virtual hard disk before packaging and importing it into Oracle Cloud Infrastructure.

   For more information, refer to the Disk Image Files section in the Oracle VM VirtualBox documentation. For more information about the qemu-img command, refer to the qemu-img(1) man page.

3. Proceed to Migrating a Virtual Disk Image to Oracle Cloud Infrastructure.

Option 2: Convert to QEMU Copy-on-Write Format (QCOW2)

1. Convert your raw disk image to QEMU copy-on-write (QCOW2). This storage format is used for virtual hard disks that are compatible with Oracle Linux KVM.

   qemu-img convert -f raw -p -c -O qcow2 raw_disk_image exported_file.qcow2

2. Optionally test your virtual hard disk before packaging and importing it into Oracle Cloud Infrastructure.

   For more information, refer to the Working with Storage for KVM Guests chapter in the Oracle Linux KVM User's Guide.

3. Proceed to Migrating a Virtual Disk Image to Oracle Cloud Infrastructure.

Prerequisites 🔗

Before migrating, ensure you have already:

• Configured Identity and Access Management.
• Created a bucket for Object Storage in your Oracle Cloud Infrastructure tenancy.
• Configured the Oracle Cloud Infrastructure SDK with your credentials for API access. See Setup and Prerequisites.
• Completed Converting a Physical Installation to a Virtual Disk Image (if migrating a physical host).

If you are new to Oracle Cloud Infrastructure, refer to the Getting Started section in the Oracle Cloud Infrastructure documentation.

Use the Utilities to Migrate the Image

1. Complete the prerequisites.
2. Verify and preprocess your virtual hard disk in either VMDK or QCOW2 format:

   sudo oci-image-migrate -y -i unprocessed_virtual_hard_disk

3. Upload your preprocessed virtual hard disk to an Oracle Cloud Infrastructure bucket as a custom image:

   oci-image-migrate-upload -y -i processed_virtual_hard_disk -b bucket_name -o image_name

4. Import the image file from object storage on your Oracle Cloud Infrastructure bucket to your custom images repository:

   oci-image-migrate-import -y -i image_name -b bucket_name -c compartment_name

5. If you migrated from a physical host, regenerate initramfs on each new instance by using your imported custom image:

   sudo dracut --force

Description

Prepares an on-premise image for importing into Oracle Cloud Infrastructure. You must run this command as root.

The oci-image-migrate utility supports the migration of image files in qcow2 and vmdk format.

The utility does the following to prepare the image for migration:

• Verifies the prerequisites for importing the image.
• Disables the network interfaces except the primary network interface, which is set up as a DHCP client.
• Installs recommended packages, such as the cloud-init package. The list of packages that are installed are displayed in /etc/oci-utils/oci-migrate-conf.yaml file.
• Attempts to access remote servers hosting software repositories for the image being processed. The Domain Name Server (DNS) names servers and proxy settings must be able to reach the software repositories.
• Sets the default cloud user to opc.

Usage

Options

-i unprocessed_virtual_hard_disk | --input-image unprocessed_virtual_hard_disk

Specify the full path for the unprocessed virtual hard disk. This option is mandatory.

-y | --yes

Answer "yes" to prompts.

-v | --verbose

Display detailed information during image processing on the terminal. This information can for troubleshooting errors or monitoring the status. This debugging information is also written to /var/tmp.

-h | --help

Display a summary of the command line options.

Example

$ sudo oci-image-migrate /omv/data/images/ol79.vmdk -v
2021-03-30 20:38:38,177 - oci-utils.migrate-tools - DEBUG(migrate_tools:223) - __ Get config data: helpers_list
2021-03-30 20:38:38,205 - oci-utils.migrate-tools - DEBUG(migrate_tools:223) - __ Get config data: lc_all
...

Description

Uploads an on-premise image file to an object storage bucket in Oracle Cloud Infrastructure. This command does not require root privileges, provided you can access the object storage bucket in Oracle Cloud Infrastructure and have write privileges to the directories where the log and results files are written (/var/tmp/).

Usage

Options

-i processed_virtual_hard_disk | --input-image processed_virtual_hard_disk

Specify the full path for processed virtual hard disk. This option is mandatory.

-b bucket_name | --bucket-name bucket_name

Specify the name of the object storage bucket in Oracle Cloud Infrastructure to store the image file. This option is mandatory.

-o output_name | --output-name output_name

Specify the name of the image file to be used in object storage. If not specified, the name of the processed virtual hard disk is used as the image name.

-y | --yes

Answer "yes" to prompts.

-v | --verbose

Display detailed information during image upload processing on the terminal. Use this information for troubleshooting errors or monitoring the status. This debugging information is also written to /var/tmp.

-h | --help

Display a summary of the command line options.

Example

$ oci-image-migrate-upload -v -i /omv/data/images/ol79.vmdk -b test_bucket_001 -o ol79_demo.qcow2

  Uploading ol79.vmdk -b test_bucket_001 -o ol79_demo.qcow2 at Thu Mar 25 20:44:16 2021
  Uploading /omv/data/images/ol79.vmdk to object storage test_bucket_001 in the Oracle Cloud Infrastructure as ol79_demo.qcow2
  Object storage test_bucket_001 present.
  Agree to proceed uploading /omv/data/images/ol79.vmdk to test_bucket_001 as ol79_demo.qcow2? (y/N) y


  Uploading /omv/data/images/ol79.vmdk, this may take a while....
  00:03:12 [          uploading ol79_demo.qcow2

Description

Imports an image from object storage to custom images repository in Oracle Cloud Infrastructure. This command does not require root privileges, provided you can access the object storage bucket in Oracle Cloud Infrastructure and have write privileges to the directories where the log and results files are written (/var/tmp/).

Usage

Options

-i image_name | --input-image image_name

Specify the name of the image to import as a custom image. This option is mandatory.

-b bucket_name| --bucket-name bucket_name

Specify the name of the object storage bucket in Oracle Cloud Infrastructure where the image file is stored. This option is mandatory.

-c compartment_name | --compartment-name compartment_name

Specify the name of the destination compartment. This option is mandatory.

-d display_name | --display-name display_name

Specify the name to be displayed for the custom image in the custom images repository in Oracle Cloud Infrastructure. If this parameter is not specified, the image name is used as the display name.

-l launch_mode | --launch-mode launch_mode

Specify the launch mode that the custom image uses when launched. Possible values are PARAVIRTUALIZED, EMULATED, and NATIVE. If a mode is not specified, the default is PARAVIRTUALIZED.

-v | --verbose

Display detailed information during image import processing on the terminal. Use this information for troubleshooting errors or monitoring the progress. This debugging information is also written to /var/tmp.

-y | --yes

Answer "yes" to prompts.

-h | --help

Display a summary of the command line options.

Example

$ oci-image-migrate-import -v -y -i ol79_demo.qcow2 -b test_bucket_001 -c OLimages -d ol79_demo

  Importing ol79_demo.qcow2 from test_bucket_001 into test_bucket_001 as ol79_demo and setting launch mode as PARAVIRTUALIZED
  Object storage namespace: IMAGETEST
  Compartment: OLimages
  Object storage test_bucket_001 present.
  Import ol79_demo.qcow2 to OLimages as ol79_demo y
  00:00:05 [               importing ol79_demo