Documentation

Skip to end of metadata
Go to start of metadata

To make new virtual machine templates available in Abiquo, you must add them to your appliance library. 

Add VM Templates to Datacenter Apps Library

You can download a single-disk template from a remote template repository or upload from a local filesystem. Template disks must be in a compatible format. After you add a single-disk template to Abiquo, you can edit this template to add more standard disks.

Template Conversions

When you add a template or a non-empty template disk to the appliance library, it will be converted to the format of each hypervisor in the platform. If you do not have any hypervisors in Abiquo, it will be converted to all possible hypervisor formats.

Before you add templates to your appliance library, add your physical machines with your hypervisors so as to optimize your NFS repository space. See V2V Conversion.

Click the add button in the appliance library view to add a new template. Select "Create from remote template repository" or "Create from local file"

 

Download from a Remote Template Repository

If you have the Manage repository privilege then you can download template definitions from a remote template repository to the Appliance Library.

Select the download from remote template repository option to open the following screen.

Select the repository in the left column, to update the categories and template definitions available. Select a category or All categories. The right column will contain the template definitions available to be downloaded to your datacenter for deployment. An icon, title and brief description is provided for each. Click on Show disks to see the disk information.

  • Download: Mark the check box next to each template definition you wish to download and then click the Download button at the top of the screen to start downloading. 

  • Abiquo will check that this template download will not exceed the repository limits for your enterprise or your enterprise in the datacenter.

  • A status bar will appear next to the selected packages showing the download state.

Template Category

If a template belongs to a category in the remote template repository and the category does not exist in the appliance library, this new global category will be created when it is downloaded.

Manage Remote Repositories

On the Create template from remote template repository dialog, you can also

  • Add or Remove remote template repositories: at the top of the first column there are two buttons (add and delete) for managing the template repositories available. Click on the add button and enter a URL (complete with http:// and port number) for a template repository to download template definitions from.

Default repository space

When an enterprise repository is created, a default template repository is provided with this URL http://abiquo-repository.abiquo.com/ovfindex.xml

  • Refresh: click the refresh button in the top-right corner of the dialog to refresh the screen with the current template definitions available, downloaded, etc.

Upload Templates from the Local Filesystem

Abiquo supports browser upload of files larger than 2 GB but for very large files, it may be convenient to use another method

You can create a template by uploading a custom template, with your own configuration of resources, disk, etc. The Abiquo GUI upload works with a multi-part upload over an HTTP connection from your browser to the Apps Library. 

The requirements to upload different template types are described in the following table.

Template typeRequirements
Local file

You must enter the number of CPUs, RAM and the deployed size of the single virtual machine Hard disk. These fields are required and if you do not enter correct values, you may not be able to deploy. If you do not know these values, you can: upload the file to the TemplateRepository, which automatically detects the values, and then download it to Abiquo; or, determine an accurate value for the Hard disk, then enter best-guess values for # CPU and RAM (e.g. 1 x CPU and 512 MB of RAM). These values can be modified after the image is uploaded. Later you an edit the template and add more standard disks.

ISO fileYou must enter the number of CPUs and RAM for the virtual machine. These fields are required and if you do not enter correct values, you may not be able to deploy, but if you do not have these values, enter best-guess values for # CPU and RAM (e.g. 1 x CPU and 512 MB of RAM). These values can be modified after the image is uploaded. Later you an edit the template and add more standard disks.
OVA fileYou must supply an OVF description file for the template. See OVF Reference. You can upload a multi-disk template.

Upload from local or ISO file

General information tab

Complete this form to create a new virtual machine template in the appliance library.

Disks tab
Disk from local file

Disk from ISO file

 

* Capacity of the Hard Disk

You must enter a correct value for the Capacity of the hard disk - see Determining the size of a VM Disk File. Otherwise, deployment may fail with a message such as "is not a virtual disk". The hard disk size of a deployed virtual machine is the physical size of the template disk for fixed formats, and the provisioning size for sparse formats and compressed formats, e.g. stream-optimized. The Hard disk size entered in this field is recorded in the template definition (a short version of an OVF description) and used to create the disk on deployment.

The disk you upload is saved as the 0 disk in the boot sequence. Abiquo will send this disk to the hypervisor as the boot disk. If your disk is not a bootable system disk, then move the disk to a different position in the boot sequence when you add a bootable system disk.

You can edit the uploaded disk but you cannot delete it before you save the template.

Advanced tab

Click Save to upload the template file. 

Abiquo will check that this template upload will not exceed the repository limits for your enterprise or your enterprise in the datacenter.

After you save the template, you can edit the template and add more disks, edit, reorder and delete disks. You can also add a cost code.

Downloading virtual machine templates

Downloading to client requires access to the Appliance Manager IP address configured for the current datacenter.

Incompatible Virtual Machine Templates

The GUI upload process is handled by the browser and there are some limitations. If a file is not compatible with GUI upload, you can upload it manually. Manual upload requires access to the filesystem, so it should be done by a system administrator. See Importing Templates into the Appliance Library#Manually Upload a VM Template to the NFS Repository

OVA upload

Abiquo supports OVA upload. You can upload a multi-disk template using this method.

When you select Create from OVA file, a dialog will open to select the file. The name of the OVA file must end in the extension ".ova"

You do not need to enter the details of the template disk files, but you must include an Abiquo-compatible OVF description file in the OVA file. See  OVF Reference

Abiquo will display the filename. Click Save. Abiquo will upload the file and create the template.

When the template has been uploaded, Abiquo will open the Edit template dialog. Check the template details and click Save.

 


More Information about VM Templates

See the Abiquo VM Template Guide.


Add VM Templates to Public Cloud Apps Library

Public cloud libraries can have many thousands of virtual machine templates (e.g. AWS has 19,000 AMIs) that are difficult to find and manage. In Abiquo you can define a cache of public cloud templates that will be registered in the platform database. The platform will display only the library of registered templates to your users.

When you restrict the number of templates available, it will be quicker and easier for your users to find and deploy templates. After you retrieve a public cloud template and store its details in the database, you can customize its representation in the Apps library to make it even easier for cloud users to find the right template. Cloud users can view and filter the cached templates. 

This feature improves administrative control over public cloud templates. It also enables users to work more efficiently, because 90% of the time, users work with a small set of templates and now this can be defined and managed by the administrator. Note that the platform registers public cloud templates in the Apps library but it does not convert them to other hypervisor formats.

Administrators can:

  • Search and filter the public cloud template library and retrieve templates
  • Select templates to store in the Abiquo database
  • Add custom name, icon, description, etc.

Other users with access to the Apps Library can:

  • Search and filter the public cloud templates registered in the database

Public cloud VM templates belong to regions

Public cloud templates can belong only to the region they were created in. Templates in one region usually cannot be accessed from another region. This rule also applies to templates in the Apps library. Public cloud templates that are effectively the same may have different names in each region.

Open the Apps Library

The Apps Library is a collection of virtual machine templates that enables users to quickly and easily deploy virtual machines. The platform stores public cloud template details in the database and displays them in the Apps library. By default the platform will display any cached templates.

To open the Apps library, click the Apps library icon   in the main menu bar.

Display public templates

Click on the Public tab. In the Public list, click on the name of the public cloud region. By default you will see any templates you can deploy within this region.

Display template details

To display the details of a template, move the mouse over the template. A small tool tip will display the template information.

Template symbols

The virtual machine templates in the Apps library may be marked with symbols that indicate their purpose. A shared template is marked with an orange user symbol in the lower left corner.  A Chef logo in the lower right corner shows that is Chef enabled.

Filter local public cloud templates

Public cloud template search and filter is used for all public clouds, all OpenStack clouds and Docker images

A public cloud template library may have many thousands of templates, for example, the AWS template library contains approximately 19,000 virtual machine templates. Templates belong to regions, so a similar template may have different IDs in different regions.

Local templates are registered in the Abiquo template cache. These are the templates users can deploy.

You can filter to find the templates you want to work with. To open the filter, click the funnel Filter button.

Enter filter values and click Accept.

 

 

Filter

Type

Comments

ID

Free text

For example, ami-0354b96a

Name

Free text

Search for this text in each template Name and Description. The search is not case sensitive

OS type

Selector

Any, Windows or Other. The default value is Any

32 bits

Checkbox

32-bit images

64 bits

Checkbox

64-bit images

Click Clear to reset filter values to defaults, which will be to display all local templates.

 

Use Templates

In the Virtual datacenters view, click and drag a template into your virtual appliance to create a virtual machine with this template

Add a public cloud template to the platform

To import a template from a public cloud region into the Abiquo template cache, open the Apps library at the Public cloud tab.

In the column on the left, select the public cloud region.

Then click the Import template button on the upper right-hand side of the screen.

The Import template popup will open.

Enter the search criteria for your template.

Filter

Type

Comments

ID

Free text

For example, ami-0354b96a

Name

Free text

Search for this text in each template Name and Description. The search is not case sensitive

OS type

Selector

Any, Windows or Other. The default value is Any

Private

Checkbox

Private images that are only available to your user account in the public cloud provider

Public

Checkbox

Public images that are available to all users in the public cloud provider

32 bits

Checkbox

32-bit images

64 bits

Checkbox

64-bit images

Then click Search to perform the search. The search can take some time and return several pages of templates.

To see more details of a template, move the mouse over it to display a tooltip with template details.

To import a template, click the Import symbol in the top right-hand corner of the template.  

When a template has been imported, the color of the Import symbol will change to gray. You can import many templates in one session.

When you have finished importing templates click Close.

Edit a public cloud template in the Abiquo Apps Library

  • Move the mouse over a template
  • Click the options button and select edit

Modify Public Cloud Template Details