Update to use DataVolumes for imports

awels · awels · commit 6a71c24de8a0 · 2018-09-24T14:18:19.000-04:00
- Updated import as VM(linux/windows) to use DV.
- Updated improt as Template(linux/windows) to use DV.

Signed-off-by: Alexander Wels &lt;awels@redhat.com&gt;
diff --git a/README.md b/README.md
@@ -14,11 +14,9 @@ image is downloaded from the specified location.  A virtual machine is created
 and associated with the imported disk image.
 
 ### Required credentials
-The current design of this APB requires that an OpenShift User and corresponding
-password be specified.  This is a temporary inconvenience which should be
-removed in the near future.  Please be sure to choose an account that has
-privileges to create resources (PVC and VirtualMachine(s)) in the chosen
-project. 
+The current design of this APB requires that an admin OpenShift User and 
+corresponding password be specified for certain operations. This is a 
+temporary inconvenience which should be removed in the near future. 
 
 ### Supported disk image formats
 This APB relies on the
@@ -30,32 +28,29 @@ format.  Compressed images in the gz and xz formats are supported.
 The operating system installed in a virtual machine disk image may make certain
 assumptions about the underlying hardware platform.  In order for the virtual
 machine to run properly, choose a virtual machine type that most closely matches
-the virtual machine being imported.  *Currently only 'default' is available but
-more types will be added as needed.* 
+the virtual machine being imported. 
 
 ### Parameters
-| Parameter            | Default value | Options   | Comments  |
-|:---------------------|:--------------|:----------|:----------|
-| Openshift User       |               |           | *see above* |
-| Openshift Password   |               |           | *see above* |
-| Disk Image URL       |               |           | The location of the virtual machine disk image. |
-| Virtual Machine Type | default       | <ul><li>default</li></ul> | *see above* |
-| Virtual Machine Name |               |           | Choose a unique name for the new virtual machine. |
-| Number of CPUs       | 1             |           | The number virtual CPU cores to assign to the virtual machine. |
-| Memory               | 1024          |           | The amount of memory (in Megabytes) to assign to the virtual machine. |
+| Parameter                | Default value | Options   | Comments  |
+|:-------------------------|:--------------|:----------|:----------|
+| Openshift Admin User     |               |           | Only needed to create templates |
+| Openshift Admin Password |               |           | Only needed to create templates |
+| Disk Image URL           |               |           | The location of the virtual machine disk image. |
+| Virtual Machine Type     | linux         | <ul><li>linux</li><li>windows</li></ul> | |
+| Virtual Machine Name     |               |           | Choose a unique name for the new virtual machine. |
+| Number of CPUs           | 1             |           | The number virtual CPU cores to assign to the virtual machine. |
+| Memory                   | 1024          |           | The amount of memory (in Megabytes) to assign to the virtual machine. |
 
 ## Import from VMWare
 To use this option, select the *Import from VMWare* plan. You will need to supply
 VMware's url from where you want to import, virtual machine name to be imported
 and the VMware's administrator credentials. Once deployed, a virtual machine is
 created with a PVC containing imported image from VMware.
 
-### Required credentials
-The current design of this APB requires that an OpenShift User and corresponding
-password be specified.  This is a temporary inconvenience which should be
-removed in the near future.  Please be sure to choose an account that has
-privileges to create resources (PVC and VirtualMachine(s)) in the chosen
-project.
+###
+In order for this apb to work you need at a minimum the following versions:
+CDI: 1.2.0
+KubeVirt: 0.9
 
 ### Limitations
 At the moment we can import virtual machine having one disk and one network interface.
diff --git a/roles/import-from-url/tasks/deprovision.yml b/roles/import-from-url/tasks/deprovision.yml
@@ -21,12 +21,10 @@
   block:
     - command: "oc login --insecure-skip-tls-verify=true -u {{ admin_user }} -p {{ admin_password }}"
     - command: "oc delete template -l import-vm-apb/transaction_id={{ _apb_service_instance_id }} -n openshift --ignore-not-found=true"
+    - command: "oc delete dv -l import-vm-apb/transaction_id={{ _apb_service_instance_id }} -n {{ namespace }} --ignore-not-found=true"
     - name: Get current relist count"
       command: "oc get clusterservicebroker template-service-broker -o jsonpath='{.spec.relistRequests}'"
       register: current_relist_count
     - command: "oc patch clusterservicebroker template-service-broker -p '{\"spec\": {\"relistRequests\": {{ current_relist_count.stdout|int + 1 }} }}'"
       ignore_errors: yes
   when: image_type == "template"
-  
-- name: Delete PVC
-  command: "oc delete pvc -l import-vm-apb/transaction_id={{ _apb_service_instance_id }} --ignore-not-found=true"
diff --git a/roles/import-from-url/tasks/provision.yml b/roles/import-from-url/tasks/provision.yml
@@ -18,12 +18,14 @@
 
 # Before doing anything check if the PVC already exists, if it
 # does, then don't waste the effor to look stuff up as it will
+# We want to look for PVC and not DVs because DVs are just an abstraction on top of PVCs and
+# the real thing to check for are the PVCs
 # fail.
 - name: Check for existing PVC
-  command: "oc get pvc {{image_type}}-{{ vm_name }}-disk-01"
+  command: "oc get pvc {{image_type}}-{{ vm_name }}-dv-01"
   register: pvc_exists
   # This looks odd, the oc command queries for the pvc, and we continue if there is
-  # an error (it can't find the PVC) and no stdout output. This won't solve a race
+  # an error (it can't find the pvc) and no stdout output. This won't solve a race
   # condition, but its a useful first check regardless.
   failed_when: pvc_exists.stdout != ""
 
@@ -33,56 +35,33 @@
     method: HEAD
   register: response
 
-- name: Calculate PVC size
+- name: Calculate DV size
   set_fact:
     # Use 4% FS overhead based on this research
     # https://rwmj.wordpress.com/2009/11/08/filesystem-metadata-overhead/
     size_bytes: "{{ (response.content_length|int * 1.04)|int }}"
   when: disk_size_gb == 0
 
-- name: Calculate PVC size
+- name: Calculate DV size
   set_fact:
     size_bytes: "{{ (disk_size_gb|int * 1073741824 * 1.04)|int }}"
   when: disk_size_gb != 0
 
-- name: Build PVC
-  template:
-    src: cdi-pvc.yml
-    dest: /tmp/pvc.yml
-
-- name: Debug generated pvc
-  command: cat /tmp/pvc.yml
-  register: debug_out
-- name: Show generated pvc
-  debug:
-    msg: "{{ debug_out.stdout }}"
-
-- name: Provision PVC
-  command: "oc create -f /tmp/pvc.yml"
-
-- name: Check PVC bound status
-  command: "oc get pvc {{image_type}}-{{ vm_name }}-disk-01 -o jsonpath='{ {{pvc_status_path}} }'"
-  register: pvc_bound_status
-  until: pvc_bound_status.stdout == 'Bound'
-  retries: 60
-  delay: 3
-
-- name: Pod Import Status
-  command: "oc get pvc {{image_type}}-{{ vm_name }}-disk-01 -o jsonpath='{ {{import_status_path}} }'"
-  register: import_status
-  # The values of import_status follow standard kubernetes pod phase values. Pending/Running/Succeeded/Failed/Unknown
-  # The importer POD will update the status.
-  until: import_status.stdout == 'Succeeded' or import_status.stdout == 'Failed'
-  retries: 17280 # This equates to a day of retries. It could take a while to import the disk, so give it a long timeout.
-  delay: 5
-
-- fail:
-    msg: "Unable to import image into PVC, check importer pod log for details."
-  when: import_status.stdout != 'Succeeded'
-
-- name: Set pvc_name
-  set_fact:
-    pvc_name: "{{image_type}}-{{ vm_name }}-disk-01"
+- name: Build Template DV
+  block:
+    - name: Create DV yaml
+      template:
+        src: cdi-dv.yml
+        dest: /tmp/dv.yml
+    - name: Debug generated DV
+      command: cat /tmp/dv.yml
+      register: debug_out
+    - name: Show generated DV
+      debug:
+        msg: "{{ debug_out.stdout }}"
+    - name: Provision DV
+      command: "oc create -f /tmp/dv.yml"
+  when: image_type == "template"
 
 - name: Set disk_bus
   set_fact:
diff --git a/roles/import-from-url/templates/cdi-dv.yml b/roles/import-from-url/templates/cdi-dv.yml
@@ -0,0 +1,19 @@
+apiVersion: cdi.kubevirt.io/v1alpha1
+kind: DataVolume
+metadata:
+  name: "{{ image_type }}-{{ vm_name }}-dv-01"
+  labels:
+    import-vm-apb/transaction_id: "{{ _apb_service_instance_id }}"
+spec:
+  source:
+      http:
+         url: "{{ disk_image_url }}"
+  pvc:
+{% if storage_class is defined %}
+    storageClassName: {{ storage_class }}
+{% endif %}
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: "{{ size_bytes|int }}"
diff --git a/roles/import-from-url/templates/cdi-pvc.yml b/roles/import-from-url/templates/cdi-pvc.yml
diff --git a/templates/linux-template.j2 b/templates/linux-template.j2
@@ -4,11 +4,11 @@ metadata:
   name: {{ vm_name }}-template
   namespace: openshift
   annotations:
-    description: "OCP KubeVirt Red Hat Enterprise Linux 7.4 VM template"
+    description: "OCP KubeVirt Linux VM template"
     tags: "kubevirt,ocp,template,linux,virtualmachine"
     iconClass: icon-other-linux
   labels:
-    kubevirt.io/os: rhel7.4
+    kubevirt.io/os: linux
     miq.github.io/kubevirt-is-vm-template: "true"
     import-vm-apb/transaction_id: "{{ _apb_service_instance_id }}"
 
@@ -17,43 +17,51 @@ objects:
   kind: VirtualMachine
   metadata:
     name: ${NAME}
+    labels:
+      kubevirt.io/vm: ${NAME}
   spec:
+    dataVolumeTemplates:
+    - metadata:
+        name: vm-${NAME}-dv-01
+      spec:
+        pvc:
+{% if storage_class is defined %}
+          storageClassName: {{ storage_class }}
+{% endif %}
+          accessModes:
+          - ReadWriteOnce
+          resources:
+            requests:
+              storage: {{ disk_size_bytes }}
+        source:
+          pvc:
+            namespace: "{{ namespace }}"
+            name: "{{ image_type }}-{{ vm_name }}-dv-01"
     running: false
     template:
+      metadata:
+        labels:
+          kubevirt.io/vm: {{ vm_name }}
       spec:
+        terminationGracePeriodSeconds: 0
         domain:
           cpu:
             cores: ${{'{{'}}CPU_CORES{{'}}'}}
+          machine:
+            type: q35
           resources:
             requests:
               memory: ${MEMORY}
-          machine:
-            type: q35
           devices:
             disks:
-              - name: disk0
-                disk:
-                  bus: {{ disk_bus }}
-                volumeName: volume-1
+            - name: disk0
+              disk:
+                bus: {{ disk_bus }}
+              volumeName: "${NAME}-datavolume"
         volumes:
-          - name: volume-1
-            persistentVolumeClaim:
-              claimName: vm-${NAME}-disk-01
-- apiVersion: v1
-  kind: PersistentVolumeClaim
-  metadata:
-    name: vm-${NAME}-disk-01
-    annotations:
-      k8s.io/CloneRequest: {{ namespace }}/{{ pvc_name }}
-  spec:
-{% if storage_class is defined %}
-    storageClassName: {{ storage_class }}
-{% endif %}
-    accessModes:
-      - ReadWriteOnce
-    resources:
-      requests:
-        storage: {{ disk_size_bytes }}
+        - dataVolume:
+            name: "vm-${NAME}-dv-01"
+          name: "${NAME}-datavolume"
 parameters:
 - name: NAME
   description: Name for the new VM
diff --git a/templates/linux-vm.j2 b/templates/linux-vm.j2
@@ -3,15 +3,38 @@ kind: VirtualMachine
 metadata:
   name: {{ vm_name }}
   labels:
-    import-vm-apb/transaction_id: {{ _apb_service_instance_id }}
+    import-vm-apb/transaction_id: "{{ _apb_service_instance_id }}"
+    kubevirt.io/vm: {{ vm_name }}
 spec:
+  dataVolumeTemplates:
+  - metadata:
+      name: "{{ image_type }}-{{ vm_name }}-dv-01"
+    spec:
+      pvc:
+        accessModes:
+        - ReadWriteOnce
+        resources:
+          requests:
+            storage: {{ size_bytes|int }}
+{% if storage_class is defined %}
+          storageClassName: {{ storage_class }}
+{% endif %}
+      source:
+        http:
+          url: {{ disk_image_url }}
+    status: {}
   running: false
   template:
+    metadata:
+      labels:
+        kubevirt.io/vm: {{ vm_name }}
     spec:
       terminationGracePeriodSeconds: 0
       domain:
         cpu:
           cores: {{ nr_cores }}
+        machine:
+          type: q35
         resources:
           requests:
             memory: {{ mem }}{{ mem_unit }}
@@ -20,8 +43,10 @@ spec:
           - name: disk-1
             disk:
               bus: {{ disk_bus }}
-            volumeName: volume-1
+            volumeName: "{{ vm_name }}-datavolumevolume"
       volumes:
-      - name: volume-1
-        persistentVolumeClaim:
-          claimName: {{ pvc_name }}
+      - dataVolume:
+          name: "{{ image_type }}-{{ vm_name }}-dv-01"
+        name: "{{ vm_name }}-datavolumevolume"
+status: {}
+
diff --git a/templates/windows-template.j2 b/templates/windows-template.j2
diff --git a/templates/windows-vm.j2 b/templates/windows-vm.j2
