Skip to main content

Quickstart

Disk templates let you create new virtual machines with system disks preloaded with the template's contents. Most virtual machines are built using templates, which are created from snapshots of your existing virtual machines.

Create a disk template

  1. In the Katapult Console, navigate to Storage > Disk Templates.
  2. Click Add new disk template.
  3. Enter a descriptive Name for your template.
  4. Add a Description (optional) explaining the template's purpose.
  5. Select an Operating system from the dropdown if applicable.
  6. Set an End of life date if the template should expire (optional).
  7. Toggle Available? to control whether the template can be used.
  8. Add an Update script if needed (optional).
  9. Click Create disk template.

Your disk template will be created, but you need to create a version before it can be used.

Create a template version

Templates must have at least one version before they can be used to create virtual machines.

  1. From your template's details page, click Create new version.
  2. Source type: Choose Disk snapshot to create from an existing disk snapshot.
  3. Disk snapshot: Select from available snapshots in your organization.
  4. Configure other version settings as needed.
  5. Click Create version.

Your template version will be created and made available for VM creation.

Use a disk template

Once your template has a version, you can use it when creating virtual machines:

  1. Navigate to Compute > Virtual Machines.
  2. Click Launch to create a new virtual machine.
  3. In the Operating system section, look for your template under the distribution matching the OS you set on the template.
  4. Select your template from the available options.
  5. Complete the VM creation process.

Create VM with Disk Template

The virtual machine will be created using your disk template.

View template logs

  1. Navigate to Storage > Disks > Templates.
  2. Select your disk template to view its details.
  3. Click the Logs button to view execution logs.
info

Logs are only generated for versions that use an update script. Logs will be automatically deleted after 90 days.

Delete a disk template

  1. Navigate to Storage > Disk Templates.
  2. Select the template you want to delete.
  3. In the Actions section, click Move to trash.
  4. Confirm the deletion.

The template will be moved to trash and automatically deleted after 48 hours.