Modify a VM template

Modify a virtual machine template

Before you begin:

1. Log in or switch enterprises to the tenant that owns the template

To modify a VM template:

1. Go to Catalogue → Virtual machine templates

2. Select Private or Public cloud

3. Select a datacenter or cloud location

4. Select the template and click on the control menu button in the top-right corner and select Edit

Open

Modify a VM template

Edit template general information

Enter the general information about the template as follows:

Open

Edit template with general information

1. Enter a Name to identify the template. This will be the default name in the hypervisor of the VMs that users create from the template

2. Optionally, select the Category in which the template will appear for users

3. If you are not using hardware profiles only, enter default values for CPU and RAM

   1. For the Min values of CPU or RAM. If 0 or empty, then there is no minimum. You cannot set a minimum below the current template value. Changes apply to new VMs, not existing VMs.

   2. For the Max values of CPU or RAM. If 0 or empty, then there is no maximum. Changes apply to new VMs, not existing VMs.

4. For Cores per socket, the number of CPUs must be divisible by the number of cores per socket. The maximum value is 32

5. For the Icon, enter a URL with a public IP address, not localhost or 127.0.0.1. It may contain the IP address of the API server.

• We recommend square images of size 128x128 pixels with a transparent background. Compatible formats are PNG, JPG, and GIF.

• If an administrator shares the template with other tenants, then this icon will display for their users

• If you change the icon of a template with instance templates, when you create the next instance, it will have the new icon

• If you do not set an Icon, the platform will use the default VM icon from the UI theme

• If the Operating System is set on the Advanced tab, and you don't set an icon, the platform may display the icon for a specific OS type or a generic OS type. The platform will not assign this icon to VMs.
  See Configure default template icons by operating system type

Modify VM template disks

See Modify VM template disks

Edit VM template variables

You can add variables to VM templates and the platform will automatically add them to new VMs that users create from the templates. Users can then edit the variables when configuring their VMs.

After the VM deploys, users can then access variables in the guest. For example, AWS stores the variables in the ~/vm-variables.rc file. Cloud-init may use variables.

To add variables to a VM template, enter the Key and Value, then click Add.

To edit an existing value, click the pencil icon, enter the new Value, then click ok. To save your changes to the template, click Save.

Share VM templates

In the Catalogue view, shared templates are marked with the outstretched hand symbol. 

By default, templates are local to the tenant that creates them (the "owner" enterprise). To share templates, assign scopes to them. 

To share a template with a scope:

1. Go to Users → Scopes

2. Create a scope

   1. For enterprises to use the template, select them in the scope

3. Log in or switch to the enterprise that owns the template

4. Go to Catalogue → Templates

5. Edit a template

6. Go to Scopes

7. Select the scope

   1. To share the template with all enterprises, select Global scope

For more information, see Manage scopes  and Manage resource scopes

Screenshot: To share a template with the enterprises in one or more scopes, select template scopes.

To remove enterprise access to a template, remove the scope containing the enterprise. 

• You cannot remove a scope from the template if an enterprise in the scope is using the template, for example, if it has deployed VMs or instances of VMs. 

To make a template private to the owner enterprise, unselect all scopes.

In private cloud, the instances of shared templates belong to the enterprise that created them. When a template has instances, it is in use by the enterprises with instances. This may mean that you cannot delete a template without deleting or promoting the instances first.

When you make a shared template unavailable, other enterprises cannot deploy it, but it may not be marked as unavailable in the catalogue of other enterprises until you refresh your catalogue.

Activate hardware profiles for a VM template

When you edit a VM template, you can recommend some hardware profiles for users when they create VMs from this template. You can also activate only the recommended hardware profiles.

By default, users can access all hardware profiles that are active in the infrastructure and allowed for their enterprise. For how to create and activate hardware profiles, see Hardware profiles. For how to allow hardware profiles for an enterprise, see Configure an enterprise in a cloud location.

To activate a set of selected hardware profiles for a VM template:

1. Go to Catalogue → Public/Private

2. Select a region or datacenter and go to Templates

3. Edit a template

4. Go to Recommended

5. Select the hardware profiles to recommend for this template. When the user creates a VM, the platform will display (Recommended) beside them.
   For shared templates, remember that the administrator must allow the user's tenant to access the hardware profiles. See Configure an enterprise in a cloud location.

6. To activate and display the recommended hardware profiles only, select the Enable only recommended HPs option

Activate datastore tiers for a VM template

When you edit a VM template in private cloud, you can recommend some datastore tiers for users when they create VMs from this template. You can also restrict users to the recommended tiers.

By default, when users configure VMs, they can access all datastore tiers that are appropriately configured in the infrastructure and allowed for their enterprise. 

To activate a set of selected datastore tiers for a template:

1. Go to Catalogue → Private 

2. Select region or datacenter and Templates

3. Edit your template

4. Go to Recommended

5. Select the datastore tiers to recommend for this template. The platform will display these datastore tiers in the selection list with (Recommended) beside them. Remember that the administrator must allow the user's tenant to access the datastore tiers

6. To activate and display the recommended datastore tiers only, select the Enable only recommended DS tiers option

Add a bootstrap script to a VM template

Add a bootstrap script to a VM template and the platform will add it to all VMs created from the template to use with the Cloud-init (or similar) option, for Guest setup, which you can configure on the Advanced tab. You can also use scripts that are saved as Script templates.  

Before you begin:

1. Prepare a template that is compatible with cloud-init (version 0.7.9 or above), or cloudbase-init, or a similar system

2. In private cloud, the platform will create an ISO disk for Configuration drive

To add a VM bootstrap configuration or script:

1. In the Catalogue, edit a VM template

2. Go to Bootstrap

3. If you have the Add a script template to a VM template privilege, select Use own script or Use script template

   • For Use own script, paste your configuration or script in the Bootstrap script text box

   • For Use script template, click Search, and double-click a script template, or select a script template and click Accept. If you have the privilege to Manage script templates, you can also create a new script template in this step.

4. Continue to configure the VM template or click Save to finish

Note: when you save VM disks to an instance template, Abiquo copies the VM bootstrap script to the instance template.

Related links

• VM bootstrap script

• Prepare for guest setup with cloud-init or similar

• Manage script templates

Edit template advanced tab

You can also specify some Advanced template values using the OVF and the API. See Extended OVF support and template definition .

Enable hot add and hot reconfigure for VM templates

To allow users to reconfigure their VMs without powering off:

1. Go to Catalogue and select Private or Public

2. Select datacenter or public cloud region

3. Select and edit the VM template

4. Go to Advanced tab

5. Select the options under Enable hot-add/reconfigure

6. Save the template

Hot add and hot reconfigure options table

Add extra charges for a VM template

When you edit a VM template, for cloud billing you can add extra charges, which are cost codes.

1. Create extra charges. See Manage extra charges with cost codes

   1. For the Type select VM template or All

2. Set values for extra charges. See https://abiquo.atlassian.net/wiki/spaces/doc/pages/311362596

3. Go to the Catalogue

4. Edit a VM template

5. Go to Extra charges

6. Add extra charges as required

Add tags to a VM template

When you edit a VM template, you can add tags to group resources and manage them in Control view.

To manage tags for a template:

1. Go to Catalogue → select a datacenter or public cloud region

2. Go to Templates

3. Edit a template

4. Go to Tags

5. Add tags 

    

   For more details see https://abiquo.atlassian.net/wiki/spaces/doc/pages/311370191

Manage VM templates with the API

Pages related to VM templates

• Main Catalogue page with links to related pages: https://abiquo.atlassian.net/wiki/spaces/doc/pages/311371369

• Guest setup