Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Template import methods

You can

Info

This page describes how to import templates into the

Catalogue using GUI upload, API download, manual upload of disk and OVF files, and template-repository.

...

GUI upload

The easiest way to upload templates is with an OVA upload. The OVA should have a single virtual system but can contain multiple disks in a compatible format (see Template compatibility table). Abiquo supports OVAs such as the ones exported from VMware.

If you don't have an OVA file, you can upload a single template disk (preferably the system disk) and then edit the template and add other disks. Abiquo will automatically generate the OVF descriptor for the disk file.

Abiquo will upload large files but a manual upload may be more convenient for these files. The browser performs a multi-part upload, but the HTTP protocol is still used, so there is no recovery of partially uploaded files. 

See 

Abiquo catalogue using a manual upload. To use easier methods, such as OVA upload in the UI, see Add VM templates to the catalogue

 in the User's Guide.

Manual upload

If your template files are very large, then you should use a manual upload to the VM repository filesystem. This method requires access to the NFS file system, so a system administrator should manage it. Note that Abiquo VM templates are OVF packages and they consist of disk files and OVF descriptors. You can use external tools to generate an OVF package to be imported into Abiquo as a VM template. These tools include recent versions of VMware vShpere. (Note: If using VirtualBox export from the command line, check that there is a size attribute for all the File elements in the References section). An OVF package should have a single virtual system but can contain multiple disks in a compatible format (see Template compatibility table). Abiquo recommends that you use an automatically generated OVF descriptor, but it is also possible to create one, as described here

Manually upload VM template files

In a manual upload, you copy the template files directly to the NFS repository. You can unzip an OVA file to obtain the template files, which are virtual disk file(s) and an OVF definition. See Export an OVA from ESXi vSphere 7 with OVF tool.

Info

Manual upload requires access to the NFS file system.

Abiquo reads the OVF to obtain the template details, such as operating system, disk capacity, and the name and description (from the product section of the OVF). See OVF reference and Guest operating system definition for VMware.

To upload VM templates to the Abiquo Platform, do these steps:.

  1. Copy the file(s) to the Abiquo NFS repository

...

    1. Go the /opt/vm_repository folder. Here there should be folders for each enterprise in Abiquo

    2. Open the folder for your enterprise ID.

...

    1. See How to find the enterprise that owns a template

    2. Create a separate directory for each OVF Package.

    3. Copy the disk files (e.g. .vmdk.vdi ...) and the OVF descriptor document (.ovf). We recommend that you use the same base name for the system disk and the OVF file. For example:

      Code Block
      /opt/vm_repository/{

...

    1. ID_ENTERPRISE}/{

...

    1. MY_FOLDER}/myVMTemplate.vmdk
      /opt/vm_repository/{

...

    1. ID_ENTERPRISE}/{

...

    1. MY_FOLDER}/myVMTemplate_HardDisk.vhd
      /opt/vm_repository/{

...

    1. ID_ENTERPRISE}/{

...

    1. MY_FOLDER}/myVMTemplate.ovf  
  • Refresh the Catalogue view of the repository

...

titleClick here to show/hide the screenshot

...

  1. In Abiquo, go to the Catalogue view for Private cloud, and click the round-arrow refresh button next to

...

  1. your datacenter name.

...

  1. Refresh the catalogueImage Added

When you refresh the Catalogue, the platform Abiquo will detect the vm_repository contents (the disk files in the NFS repository folders and match them with the OVF description). The platform .

Info

Abiquo will convert valid disks to compatible formats for all the installed hypervisors. If there are no hypervisors

...

,

...

the platform will convert the disks to all formats.

The templates will appear in the Catalogue view and as soon the conversion files are ready, they will be ready to deploy.

...

Manual upload example

In this example we will upload images to the default enterprise repository for Abiquo.

  1. Copy the files to the NFS repository

    1. Go to /opt/vm_repository

    2. The Abiquo

...

    1. enterprise ID is 1, so

...

    1. we will open the folder 1, which is /opt/vm_repository/1.

    2. Create a separate directory for

...

    1. the template, which in this case is ubuntu_server

      Code Block
      $ mkdir ubuntu-server
      $ cd ubuntu-server

...

    1. Copy the system disk file, an extra disk, and the OVF descriptor

      Code Block
      $ scp username@10.10.10.10:/home/username/ubuntu_vxxx.vmdk /opt/vm_repository/1/ubuntu-server/
      $ scp username@10.10.10.10:/home/username/ubuntu_vxxx_extra_disk.vmdk /opt/vm_repository/1/ubuntu-server/

...

Copy the OVF descriptor too.

...

    1. 
      scp username@10.10.10.10:/home/username/ubuntu_vxxx.ovf /opt/vm_repository/1/ubuntu-server/
  1. Log in to Abiquo and refresh the Catalogue for your datacenter.

Your VM template should now be available in the Catalogue.

Manually upload an extra disk to an existing template

You can manually upload a new disk to add to an existing template, but you must also add the disk to the OVF file for that template. When the appliance manager checks the file system, it will detect the new disk, but it will only add the disk to the Abiquo template if the disk is defined in the OVF file.

Create an OVF descriptor if necessary

Abiquo recommends that you always use an automatically generated OVF descriptor, but if you do not have oneand it is easy to export one from vCenter, for example. See Export an OVA from ESXi vSphere 7 with OVF tool

However, if you are feeling lucky, you can create one following these instructions.

  1. Copy a sample Abiquo OVF file, such as the Example OVF Descriptor in OVF referenceor copy one from a valid template. Save the OVF file with the image file name and .ovf extension.

  2. Edit the OVF file according to the guidelines in the OVF for Abiquo section of OVF reference.

    1. Remember that you need to must enter the disk size. See Determine the size of a VM disk file

See also Modify a VM template in the section on Replace a disk file, and Appliance manager template API upload and download.