Custom Images

Create custom operating system images from previously created snapshots.

In addition to the default images provided in Hyperstack, users can create custom operating system (OS) images from previously created snapshots. Like the default images, these custom images are pre-configured representations of the OS used to create and deploy the corresponding snapshot.

Custom images created by users are displayed in the image selection section during virtual machine (VM) deployment, allowing users to choose between a custom OS image or a default one.

See list of available default images here.

Step-by-Step: Create a Custom OS Image

To create a custom image, follow these steps:

Step 1: Create a Snapshot from a Running VM

To begin, navigate to your running virtual machine in the My Virtual Machines page.

1. Select the VM with the configuration and state you want to capture. The VM must be in either a SHUTOFF or ACTIVE state to be snapshotted.
2. Open the action menu (⋮) and click Snapshot.
3. Name your snapshot and confirm creation.

Snapshot status requirement

Snapshots must complete and enter a success state before they can be used to create a custom image.

Refer to Snapshots documentation for more details.

Step 2: Create Image from Snapshot

Once the snapshot is successful:

1. Go to the Snapshots page.
2. Find the snapshot you created.
3. Open the action menu (⋮) next to the snapshot and choose Create Image.
4. Provide a unique name for your new custom image.

How to Use a Custom Image

All successfully created custom images will appear on the Deploy Virtual Machine page.

1. Navigate to the Virtual Machines page and click Deploy Virtual Machine.

2. Under the Select OS Image section, click the Your Custom Images tab.

   

3. Select your custom image from the list to use it as the base image for your VM.

   

4. Configure networking, SSH keys, and any optional settings, then deploy the virtual machine.

Images API

The Infrahub API can be used to create, manage, and delete Custom Images using the following endpoints:

Endpoint Name	URL	Description
Create Image	POST/core/snapshots/{id}/image	Create an image from a snapshot.
List Images	GET/core/images	List all images.
Retrieve Image	GET/core/images/{id}	Retrieve a specific image.
Delete Image	DELETE/core/images/{id}	Deletes a specified image.