7.12. Importing virtual machines

Procedure

1. Ensure you are in the correct namespace. The ConfigMap can only be referenced by DataVolumes if it is in the same namespace.

   $ oc get ns

2. Create the ConfigMap:

   $ oc create configmap <configmap-name> --from-file=</path/to/file/ca.pem>

Procedure

1. Optional: If your data source requires authentication credentials, edit the endpoint-secret.yaml file, and apply the updated configuration to the cluster:

   apiVersion: v1
   kind: Secret
   metadata:
     name: <endpoint-secret>
     labels:
       app: containerized-data-importer
   type: Opaque
   data:
     accessKeyId: "" 1
     secretKey:   "" 2

   1

   Optional: your key or user name, base64 encoded

   2

   Optional: your secret or password, base64 encoded

   $ oc apply -f endpoint-secret.yaml

2. Edit the virtual machine configuration file, specifying the data source for the virtual machine image you want to import. In this example, a Fedora image is imported from an http source:

   apiVersion: kubevirt.io/v1alpha3
   kind: VirtualMachine
   metadata:
     creationTimestamp: null
     labels:
       kubevirt.io/vm: vm-fedora-datavolume
     name: vm-fedora-datavolume
   spec:
     dataVolumeTemplates:
     - metadata:
         creationTimestamp: null
         name: fedora-dv
       spec:
         pvc:
           accessModes:
           - ReadWriteOnce
           resources:
             requests:
               storage: 10Gi
           storageClassName: local
         source:
           http: 1
             url: "https://download.fedoraproject.org/pub/fedora/linux/releases/33/Cloud/x86_64/images/Fedora-Cloud-Base-33-1.2.x86_64.qcow2" 2
             secretRef: "" 3
             certConfigMap: "" 4
       status: {}
     running: true
     template:
       metadata:
         creationTimestamp: null
         labels:
           kubevirt.io/vm: vm-fedora-datavolume
       spec:
         domain:
           devices:
             disks:
             - disk:
                 bus: virtio
               name: datavolumedisk1
           machine:
             type: "" 5
           resources:
             requests:
               memory: 1.5Gi
         terminationGracePeriodSeconds: 60
         volumes:
         - dataVolume:
             name: fedora-dv
           name: datavolumedisk1
   status: {}

   1

   The source type to import the image from. This example uses an HTTP endpoint. To import a container disk from a registry, replace http with registry.

   2

   The source of the virtual machine image you want to import. This example references a virtual machine image at an HTTP endpoint. An example of a container registry endpoint is url: "docker://kubevirt/fedora-cloud-container-disk-demo:latest".

   3

   The secretRef parameter is optional.

   4

   The certConfigMap is required for communicating with servers that use self-signed certificates or certificates not signed by the system CA bundle. The referenced ConfigMap must be in the same namespace as the DataVolume.

   5

   Specify type: dataVolume or type: "". If you specify any other value for type, such as persistentVolumeClaim, a warning is displayed, and the virtual machine does not start.

3. Create the virtual machine:

   $ oc create -f vm-<name>-datavolume.yaml

   注意

   The oc create command creates the DataVolume and the virtual machine. The CDI controller creates an underlying PVC with the correct annotation, and the import process begins. When the import completes, the DataVolume status changes to Succeeded, and the virtual machine is allowed to start.

   DataVolume provisioning happens in the background, so there is no need to monitor it. You can start the virtual machine, and it will not run until the import is complete.

Verification

1. The importer Pod downloads the virtual machine image or container disk from the specified URL and stores it on the provisioned PV. View the status of the importer Pod by running the following command:

   $ oc get pods

2. Monitor the DataVolume status until it shows Succeeded by running the following command:

   $ oc describe dv <datavolume-name> 1

   1

   The name of the DataVolume as specified under dataVolumeTemplates.metadata.name in the virtual machine configuration file. In the example configuration above, this is fedora-dv.

3. To verify that provisioning is complete and that the VMI has started, try accessing its serial console by running the following command:

   $ virtctl console <vm-fedora-datavolume>

Procedure

1. Log in as root to the node on which to create the local PV. This procedure uses node01 for its examples.

2. Create a file and populate it with null characters so that it can be used as a block device. The following example creates a file loop10 with a size of 2Gb (20 100Mb blocks):

   $ dd if=/dev/zero of=<loop10> bs=100M count=20

3. Mount the loop10 file as a loop device.

   $ losetup </dev/loop10>d3 <loop10> 1 2

   1

   File path where the loop device is mounted.

   2

   The file created in the previous step to be mounted as the loop device.

4. Create a PersistentVolume configuration that references the mounted loop device.

   kind: PersistentVolume
   apiVersion: v1
   metadata:
     name: <local-block-pv10>
     annotations:
   spec:
     local:
       path: </dev/loop10> 1
     capacity:
       storage: <2Gi>
     volumeMode: Block 2
     storageClassName: local 3
     accessModes:
       - ReadWriteOnce
     persistentVolumeReclaimPolicy: Delete
     nodeAffinity:
       required:
         nodeSelectorTerms:
         - matchExpressions:
           - key: kubernetes.io/hostname
             operator: In
             values:
             - <node01> 4

   1

   The path of the loop device on the node.

   2

   Specifies it is a block PV.

   3

   Optional: Set a StorageClass for the PV. If you omit it, the cluster default is used.

   4

   The node on which the block device was mounted.

5. Create the block PV.

   # oc create -f <local-block-pv10.yaml>1

   1

   The filename of the PersistentVolume created in the previous step.

Procedure

1. If your data source requires authentication credentials, edit the endpoint-secret.yaml file, and apply the updated configuration to the cluster.

   1. Edit the endpoint-secret.yaml file with your preferred text editor:

      apiVersion: v1
      kind: Secret
      metadata:
        name: <endpoint-secret>
        labels:
          app: containerized-data-importer
      type: Opaque
      data:
        accessKeyId: "" 1
        secretKey:   "" 2

      1

      Optional: your key or user name, base64 encoded

      2

      Optional: your secret or password, base64 encoded

   2. Update the secret by running the following command:

      $ oc apply -f endpoint-secret.yaml

2. Create a DataVolume configuration that specifies the data source for the image you want to import and volumeMode: Block so that an available block PV is used.

   apiVersion: cdi.kubevirt.io/v1alpha1
   kind: DataVolume
   metadata:
     name: <import-pv-datavolume> 1
   spec:
     storageClassName: local 2
     source:
         http:
            url: <http://download.fedoraproject.org/pub/fedora/linux/releases/28/Cloud/x86_64/images/Fedora-Cloud-Base-28-1.1.x86_64.qcow2> 3
            secretRef: <endpoint-secret> 4
     pvc:
       volumeMode: Block 5
       accessModes:
         - ReadWriteOnce
       resources:
         requests:
           storage: <2Gi>

   1

   The name of the DataVolume.

   2

   Optional: Set the storage class or omit it to accept the cluster default.

   3

   The HTTP source of the image to import.

   4

   Only required if the data source requires authentication.

   5

   Required for importing to a block PV.

3. Create the DataVolume to import the virtual machine image by running the following command:

   $ oc create -f <import-pv-datavolume.yaml>1

   1

   The file name of the DataVolume that you created in the previous step.

1. PVCs must request a ReadWriteMany access mode.
2. PVCs must request a ReadWriteOnce access mode.

Procedure

1. In a web browser, identify the REST API name of the RHV VM operating system by navigating to http://<RHV_Manager_FQDN>/ovirt-engine/api/vms/<VM_ID>. The operating system name appears in the <os> section of the XML output, as shown in the following example:

   ...
   <os>
   ...
   <type>rhel_8x64</type>
   </os>

2. View a list of the available OpenShift Virtualization templates:

   $ oc get templates -n openshift --show-labels | tr ',' '\n' | grep os.template.kubevirt.io | sed -r 's#os.template.kubevirt.io/(.*)=.*#\1#g' | sort -u

   Example output

   fedora31
   fedora32
   ...
   rhel8.1
   rhel8.2
   ...

3. If an OpenShift Virtualization template that matches the RHV VM operating system does not appear in the list of available templates, create a template with the OpenShift Virtualization web console.

4. Create a ConfigMap to map the RHV VM operating system to the OpenShift Virtualization template:

   $ cat <<EOF | oc create -f -
   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: os-configmap
     namespace: default 1
   data:
     guestos2common: |
       "Red Hat Enterprise Linux Server": "rhel"
       "CentOS Linux": "centos"
       "Fedora": "fedora"
       "Ubuntu": "ubuntu"
       "openSUSE": "opensuse"
     osinfo2common: |
       "<rhv-operating-system>": "<vm-template>" 2
   EOF

   1

   Optional: You can change the value of the namespace parameter.

   2

   Specify the REST API name of the RHV operating system and its corresponding VM template as shown in the following example.

   ConfigMap example

   $ cat <<EOF | oc apply -f -
   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: os-configmap
     namespace: default
   data:
     osinfo2common: |
       "other_linux": "fedora31"
   EOF

5. Verify that the custom ConfigMap was created:

   $ oc get cm -n default os-configmap -o yaml

6. Edit the kubevirt-hyperconverged-operator.v2.4.9.yaml file:

   $ oc edit clusterserviceversion -n openshift-cnv kubevirt-hyperconverged-operator.v2.4.9

7. Update the following parameters of the vm-import-operator deployment manifest:

   ...
   spec:
     containers:
     - env:
       ...
       - name: OS_CONFIGMAP_NAME
         value: os-configmap 1
       - name: OS_CONFIGMAP_NAMESPACE
         value: default 2

   1

   Add value: os-configmap to the name: OS_CONFIGMAP_NAME parameter.

   2

   Optional: You can add this value if you changed the namespace in the ConfigMap.

8. Save the kubevirt-hyperconverged-operator.v2.4.9.yaml file.

   Updating the vm-import-operator deployment updates the vm-import-controller ConfigMap.

9. Verify that the template appears in the OpenShift Virtualization web console:

   1. Click Workloads Virtualization from the side menu.
   2. Click the Virtual Machine Templates tab and find the template in the list.

Procedure

1. In the web console, click Workloads Virtual Machines.
2. Click Create Virtual Machine and select Import with Wizard.
3. Select Red Hat Virtualization (RHV) from the Provider list.

4. Select Connect to New Instance or a saved RHV instance.

   • If you select Connect to New Instance, fill in the following fields:

     • API URL: For example, https://<RHV_Manager_FQDN>/ovirt-engine/api

     • CA certificate: Click Browse to upload the RHV Manager CA certificate or paste the CA certificate into the field.

       View the CA certificate by running the following command:

       $ openssl s_client -connect <RHV_Manager_FQDN>:443 -showcerts < /dev/null

       The CA certificate is the second certificate in the output.

     • Username: RHV Manager user name, for example, admin@internal
     • Password: RHV Manager password
   • If you select a saved RHV instance, the wizard connects to the RHV instance using the saved credentials.

5. Click Check and Save and wait for the connection to complete.

   注意

   The connection details are stored in a secret. If you add a provider with an incorrect URL, user name, or password, click Workloads Secrets and delete the provider secret.

6. Select a cluster and a virtual machine.
7. Click Next.
8. In the Review screen, review your settings.
9. Optional: You can select Start virtual machine on creation.

10. Click Edit to update the following settings:

    • General Name: The VM name is limited to 63 characters.

    • General Description: Optional description of the VM.

      • Storage Class: Select NFS or ocs-storagecluster-ceph-rbd.

        If you select ocs-storagecluster-ceph-rbd, you must set the Volume Mode of the disk to Block.

      • Advanced Volume Mode: Select Block.
    • Advanced Volume Mode: Select Block.
    • Networking Network: You can select a network from a list of available network attachment definition objects.

11. Click Import or Review and Import, if you have edited the import settings.

    A Successfully created virtual machine message and a list of resources created for the virtual machine are displayed. The virtual machine appears in Workloads Virtual Machines.

1. You can change the access mode by using the command line interface.

Procedure

1. Create the Secret CR by running the following command:

   $ cat <<EOF | oc create -f -
   apiVersion: v1
   kind: Secret
   metadata:
     name: rhv-credentials
     namespace: default 1
   type: Opaque
   stringData:
     ovirt: |
       apiUrl: <api_endpoint> 2
       username: admin@internal
       password: 3
       caCert: |
         -----BEGIN CERTIFICATE-----
         4
         -----END CERTIFICATE-----
   EOF

   1

   Optional. You can specify a different namespace in all the CRs.

   2

   Specify the API endpoint of the RHV Manager, for example, \"https://www.example.com:8443/ovirt-engine/api"

   3

   Specify the password for admin@internal.

   4

   Specify the RHV Manager CA certificate. You can obtain the CA certificate by running the following command:

   $ openssl s_client -connect :443 -showcerts < /dev/null

2. Optional: Create a ResourceMapping CR if you want to separate the resource mapping from the VirtualMachineImport CR by running the following command:

   $ cat <<EOF | kubectl create -f -
   apiVersion: v2v.kubevirt.io/v1alpha1
   kind: ResourceMapping
   metadata:
     name: resourcemapping_example
     namespace: default
   spec:
     ovirt:
       networkMappings:
         - source:
             name: <rhv_logical_network>/<vnic_profile> 1
           target:
             name: <target_network> 2
           type: pod
       storageMappings: 3
         - source:
             name: <rhv_storage_domain> 4
           target:
             name: <target_storage_class> 5
           volumeMode: <volume_mode> 6
   EOF

   1

   Specify the RHV logical network and vNIC profile.

   2

   Specify the OpenShift Virtualization network.

   3

   If storage mappings are specified in both the ResourceMapping and the VirtualMachineImport CRs, the VirtualMachineImport CR takes precedence.

   4

   Specify the RHV storage domain.

   5

   Specify nfs or ocs-storagecluster-ceph-rbd.

   6

   If you specified the ocs-storagecluster-ceph-rbd storage class, you must specify Block as the volume mode.

3. Create the VirtualMachineImport CR by running the following command:

   $ cat <<EOF | oc create -f -
   apiVersion: v2v.kubevirt.io/v1alpha1
   kind: VirtualMachineImport
   metadata:
     name: vm-import
     namespace: default
   spec:
     providerCredentialsSecret:
       name: rhv-credentials
       namespace: default
   # resourceMapping: 1
   #   name: resourcemapping-example
   #   namespace: default
     targetVmName: vm_example 2
     startVm: true
     source:
       ovirt:
         vm:
           id: <source_vm_id> 3
           name: <source_vm_name> 4
         cluster:
           name: <source_cluster_name> 5
         mappings: 6
           networkMappings:
             - source:
                 name: <source_logical_network>/<vnic_profile> 7
               target:
                 name: <target_network> 8
               type: pod
           storageMappings: 9
             - source:
                 name: <source_storage_domain> 10
               target:
                 name: <target_storage_class> 11
               accessMode: <volume_access_mode> 12
           diskMappings:
             - source:
                 id: <source_vm_disk_id> 13
               target:
                 name: <target_storage_class> 14
   EOF

   1

   If you create a ResourceMapping CR, uncomment the resourceMapping section.

   2

   Specify the target VM name.

   3

   Specify the source VM ID, for example, 80554327-0569-496b-bdeb-fcbbf52b827b. You can obtain the VM ID by entering https://www.example.com/ovirt-engine/api/vms/ in a web browser on the Manager machine to list all VMs. Locate the VM you want to import and its corresponding VM ID. You do not need to specify a VM name or cluster name.

   4

   If you specify the source VM name, you must also specify the source cluster. Do not specify the source VM ID.

   5

   If you specify the source cluster, you must also specify the source VM name. Do not specify the source VM ID.

   6

   If you create a ResourceMapping CR, comment out the mappings section.

   7

   Specify the logical network and vNIC profile of the source VM.

   8

   Specify the OpenShift Virtualization network.

   9

   If storage mappings are specified in both the ResourceMapping and the VirtualMachineImport CRs, the VirtualMachineImport CR takes precedence.

   10

   Specify the source storage domain.

   11

   Specify the target storage class.

   12

   Specify ReadWriteOnce, ReadWriteMany, or ReadOnlyMany. If no access mode is specified, {virt} determines the correct volume access mode based on the Host Migration mode setting of the RHV VM or on the virtual disk access mode:

   • If the RHV VM migration mode is Allow manual and automatic migration, the default access mode is ReadWriteMany.
   • If the RHV virtual disk access mode is ReadOnly, the default access mode is ReadOnlyMany.
   • For all other settings, the default access mode is ReadWriteOnce.

Procedure

1. Click Workloads Virtual Machines.
2. Click the Options menu of the virtual machine you are importing and select Delete Virtual Machine.

3. In the Delete Virtual Machine window, click Delete.

   The virtual machine is removed from the list of virtual machines.

1. PVCs must request a ReadWriteMany access mode.
2. PVCs must request a ReadWriteOnce access mode.

Procedure

1. In the web console, click Workloads Virtual Machines.
2. Click Create Virtual Machine and select Import with Wizard.
3. Select VMware from the Provider list.

4. Select Connect to New Instance or a saved vCenter instance.

   • If you select Connect to New Instance, enter the vCenter hostname, Username, and Password.
   • If you select a saved vCenter instance, the wizard connects to the vCenter instance using the saved credentials.

5. Click Check and Save and wait for the connection to complete.

   注意

   The connection details are stored in a secret. If you add a provider with an incorrect host name, user name, or password, click Workloads Secrets and delete the provider secret.

6. Select a virtual machine or a template.
7. Click Next.
8. In the Review screen, review your settings.

9. Click Edit to update the following settings:

   • General:

     • Description
     • Operating System
     • Flavor
     • Memory
     • CPUs
     • Workload Profile

   • Networking:

     • Name
     • Model
     • Network
     • Type: You must select the masquerade binding method.
     • MAC Address

   • Storage: Click the Options menu of the VM disk and select Edit to update the following fields:

     • Name
     • Source: For example, Import Disk.
     • Size
     • Interface

     • Storage Class: Select NFS or ocs-storagecluster-ceph-rbd (ceph-rbd).

       If you select ocs-storagecluster-ceph-rbd, you must set the Volume Mode of the disk to Block.

       Other storage classes might work, but they are not officially supported.

     • Advanced Volume Mode: Select Block.
     • Advanced Access Mode

   • Advanced Cloud-init:

     • Form: Enter the Hostname and Authenticated SSH Keys.
     • Custom script: Enter the cloud-init script in the text field.
   • Advanced Virtual Hardware: You can attach a virtual CD-ROM to the imported virtual machine.

10. Click Import or Review and Import, if you have edited the import settings.

    A Successfully created virtual machine message and a list of resources created for the virtual machine are displayed. The virtual machine appears in Workloads Virtual Machines.