Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

PR

https://github.com/shapeblueapache/cloudstack/pull/45

Introduction

3748

Introduction

There are a number of occasions when a cloud operator must register and make active a system VM template, including:

  • When creating the first zone in CloudStack.
  • When adding a new zone in CloudStack.
  • When adding a new hypervisor to a CloudStack zone.
  • When replacing the existing template with a one containing newly applied security patches.
  • Changing to a custom System VM templates. For example, opening a specific port on a System VM for monitoring purposes or installing a monitoring agent that needs to run in the System VM template.
  • Downgrading to a previous version of a System VM template. For example, reverting a security patch that is causing errors.

When a new zone is created, the console proxy and secondary storage virtual machines for that zone also need to be created. These virtual machines need a template from which to be created. A database entry is created for a system VM template to be used for these console proxy and secondary storage virtual machines but no template image is actually copied or stored in secondary storage. The seeding of the template image into secondary storage is an extra step in the Cloudstack installation process. The system VM template APIs will help do the work of getting the required template image into secondary storage in these cases.

Purpose

This is the functional specification of the system VM template API

...

This feature adds an Application Programming Interface (API) and User Interface (UI) that will enable an administrator to:·

  • Upload a system VM template to the management server and into secondary storage from a web browser.

...

  • Register a system VM template by specifying a URL or choosing an official Cloudstack system VM template to download.

...

  • Copy a system VM template from an existing zone.

...

  • Activate a system VM template.

...

  • List inactive system VM templates.

Use casesFunctional Abilities

  • Upload a system VM template from a browser running on a local machine to secondary storage

...

  • (via the management server).
  • Install a system VM template from a URL.
  • Install a system VM template from

...

  • the official template locations stored in the database.
  • Copy a system VM template from one zone to another

...

  • (via the management server)

These options are available from the add zone wizard and the template upload and register forms.

...

NameParametersRequiredUsage

Name 

Parameters 

Required 

Usage 

ActivateTemplate 

templateId 

Yes 

The id of the template to be set as the system VM template to use.

SeedSystemVMTemplate 

fileuuid 

No 

The uuid of the file that was uploaded to the management server for seeding the template. 

 

hypervisor 

Yes 

The target hypervisor 

 id

zoneid 

Yes 

Destination zone id 

 

url 

No 

URL where to download the system VM template from. 

 

localfile 

Yes 

Boolean indicating if a file was uploaded to the management server 

GetSystemVMTemplateDefaultUrl 

 

hypervisor 

Yes 

The target hypervisor. 

...