Templates: CloudStack

Description

Templates are images of a base operating system that the user can choose from when creating a new instance. A template can be reused to create multiple instances.


Contents

Viewing a Template/ISO (by filter)

There are various filters using which you can sort and view templates. 

Perform the following steps to view a template/ISO:

  1. On the left panel, click Templates.
    The Templates page displays.
  2. Click the "Select view" drop down list and select an option to view the template. The following options are provided:


    Field Name Description
    Templates A domainadmin can view all templates available in the domain. A normal user can view templates associated to or created by the user. You can register new templates from this page.
    ISO A domainadmin can view all ISOs available in the domain. A normal user can view ISOs associated to or created by the user. You can also register new ISOs from this page.
  3. Based on your selection, the following information is displayed:

    For Templates:

    Field Name Description
    Name Displays the name of the template. Note: You can click on individual templates to view additional information and perform various tasks.
    Domain Displays the name of the domain where the template is made available.  LeaseWeb shared templates will have default value as root.
    Account Displays the name of the Account who made the template available. LeaseWeb shared templates will have default value as admin.
    Hypervisor Displays the type of hypervisor on which the template is deployed.
    Order

    Use the following icons to arrange the display of templates:

    Click this to move the template to the top of the list.
    Click this to move the template to the bottom of the list.
    Click this to move the template a row above.
    Click this to move the template a row below.
    Click this to drag and drop the template to any position on the list.
    Quickview Displays an overview of the templates and the tasks that can be performed on them.

    For ISOs:

    Field Name Description
    Name Displays the name of the ISO. Note: You can click on individual ISOs to view additional information and perform various tasks.
    Domain Displays the name of the domain where the ISO is made available.  LeaseWeb shared templates will have default value as root.
    Account Displays the name of the Account who made the ISO available. LeaseWeb shared templates will have default value as admin.
    Order

    Use the following icons to arrange the display of ISOs:

    Click this to move the ISO to the top of the list.
    Click this to move the ISO to the bottom of the list.
    Click this to move the ISO a row above.
    Click this to move the ISO a row below.
    Click this to drag and drop the ISO to any position on the list.
    Overview Displays an overview of the ISOs and the tasks that can be performed on it.

Registering a Template

Templates form the basic structure of your instance. You can upload a template either from a web server or upload from local file to your resource pool. 

Perform the following steps to register (upload) a template via any of the above methods:

  1. On the left panel, click Templates.
    The Templates page displays.
  2. Click the "Select view" drop down list and select Templates.
    The Templates page displays. 

  3. To upload template from local file ,Click Upload from Local tab
    The Upload from Local dialog box displays
  4. Enter the following information and click OK.

    Field Name Description
    Local File Option to browse and locate the local qcow2 file for upload
    Name Enter a name using which you can identify the template.
    Description Enter a description for the template. This description will help you to identify the template when you need to select one for creating an instance.
    Zone Select the zone where this template should reside. Note: Currently, LeaseWeb provides only 1 pre-configured zone.
    Hypervisor Select the type of hypervisor for which you want to create the template. Note: For LeaseWeb, KVM is selected by default.
    Format Select the format of the file that you want to upload. Note: Currently, LeaseWeb support only QCOW2 format.
    OS Type Select the operating system of the template that you want to create. Note: It is important to select the correct operating system as it will impact performance. If you do not find your specific operating system from the drop-down list, select either "Other PV (32-bit)" or "Other PV (64-bit)" depending on the type of operating system.
    Extractable

    Select this check box to allow this template to be downloaded. Note: You can download a template by clicking . However, if this check box is not selected, you will not be able to download it to your local system.

    Password Enabled Select this check box if you want your template to have the capability of resetting password. Note: If you select this check box, the Reset Password icon will appear for the instance. In order to have this capability, your template must have the "cloud-set-guest-password" script file. If you are configuring the template yourself, you can find information on downloading the "cloud-set-guest-password" script file from cloudstack-administration-guide.
    Public

    Select this check box to make this template available to the community. Any user on the platform can access it. Once made public, you cannot revert the state

    HVM Select this check box if Hardware Virtualization need to enabled for the template. Un-check if need to use Para Virtualization mode.
  5. To upload from URL, Click +Add tab.
    The Register template from URL dialog box displays.
     
  6. Enter the following information and click OK.


    Field Name Description
    URL Enter the webserver address and path where the file to be uploaded resides.
    Name Enter a name using which you can identify the template.
    Description Enter a description for the template. This description will help you to identify the template when you need to select one for creating an instance.
    Zone Select the zone where this template should reside. Note: Currently, LeaseWeb provides only 1 pre-configured zone.
    Hypervisor Select the type of hypervisor for which you want to create the template. Note: For LeaseWeb, KVM is selected by default.
    Root Disk Controller Select the type of disk controller needed for the root disk of the template ,  Currently Leaseweb supports  ide,osdefault,virtio & virtio-scsi options.
    Format Select the format of the file that you want to upload. Note: Currently, LeaseWeb support only QCOW2 format.
    OS Type Select the operating system of the template that you want to create. Note: It is important to select the correct operating system as it will impact performance. If you do not find your specific operating system from the drop-down list, select either "Other PV (32-bit)" or "Other PV (64-bit)" depending on the type of operating system.
    Extractable

    Select this check box to allow this template to be downloaded. Note: You can download a template by clicking . However, if this check box is not selected, you will not be able to download it to your local system.

    Password Enabled Select this check box if you want your template to have the capability of resetting password. Note: If you select this check box, the Reset Password icon will appear for the instance. In order to have this capability, your template must have the "cloud-set-guest-password" script file. If you are configuring the template yourself, you can find information on downloading the "cloud-set-guest-password" script file from the cloudstack-administration-guide.
    Domain Wide Select this check box to make this template available to all the users. The iso will appear in the community list for any user to use.
    HVM Select this check box if Hardware Virtualization need to enabled for the template. Un-check if need to use Para Virtualization mode.

Registering an ISO

You can upload an ISO from a webserver to your resource pool. 

Perform the following steps to register (upload) an ISO:

  1. On the left panel, click Templates.
    The Templates page displays.
  2. Click the "Select view" drop down list and select ISO.
    The ISO page displays. 
  3. Click Register ISO.
    The Register ISO dialog box displays.
     
  4. Enter the following information and click OK.


    Field Name Description
    Name Enter a name using which you can identify the ISO.
    Description Enter a description for the ISO. This description will help you to identify the ISO when you need to select one for creating an instance.
    URL Enter the webserver address where the file to be uploaded resides.
    Zone Select the zone where this ISO should reside. Note: Currently, LeaseWeb provides only 1 pre-configured zone.
    Bootable Select this check box to allow to boot from this ISO upon creating an instance.
    OS Type Select the operating system of the ISO that you want to create. Note: It is important to select the correct operating system as it will impact performance. If you do not find your specific operating system from the drop-down list, select either "Other PV (32-bit)" or "Other PV (64-bit)" depending on the type of operating system.
    Extractable

    Select this check box to allow this template to be downloaded. Note: You can download a template by clicking . However, if this check box is not selected, you will not be able to download it to your local system.

    Domain Wide Select this check box to make this template available to all the users. The iso will appear in the community list for any user to use.

Editing a Template/ISO

Perform the following steps to edit a template/ISO: 

  1. On the left panel, click Templates.
    The Templates page displays.
  2. Click the "Select view" drop down list and select Templates (or ISO—depending on what you want to edit).
    The Templates (or ISO) page displays. 
  3. Click the template (or ISO) that you want to edit.
    The Details tab displays.
     
  4. Click the Edit icon.
    The editable fields allow you to enter/select new values.
  5. Update the values and click Apply.
    The updated values display.

    Editable fields for a template—Name, Description, Password Enabled, Extractable, Featured,Public, and OS Type.

    Editable fields for an ISO—Name, Description, Public, Featured, and OS Type

Downloading a Template/ISO

You can download existing template (or ISO) displayed in the Templates (or ISO) page to your local system.

To download this template (or ISO), the Extractable check box for the template (or ISO) must be selected upon creation.

Perform the following steps to download a template/ISO: 

  1. On the left panel, click Templates.
    The Templates page displays.
  2. Click the "Select view" drop down list and select Templates (or ISO - depending on what you want to edit).
    The Templates (or ISO) page displays. 
  3. Click the template (or ISO) that you want to download.
    The Details tab displays.
     
  4. Click the Download Template icon.
    A Confirmation dialog box displays.
  5. Click Yes to download the template (or ISO).
    The Status dialog box displays the link using which you can download the template (or ISO).
    The URL will be available for 4 hours from creation.

Deleting a Template/ISO

You cannot delete an ISO that is attached to an instance.

Perform the following steps to download a template/ISO: 

  1. On the left panel, click Templates.
    The Templates page displays.
  2. Click the "Select view" drop down list and select Templates (or ISO—depending on what you want to edit).
    The Templates (or ISO) page displays. 
  3. Click the template (or ISO) that you want to delete.
    The Details tab displays.
     
  4. Click the Delete Template icon.
    A Confirmation dialog box displays.
  5. Click Yes to delete the template (or ISO).
    The template gets deleted from the list of templates (or ISOs) that display under the Templates (or ISO) list.