Custom Operating System Images
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.
In this article
How to create a custom image
To create a custom image, users must have at least one snapshot. A custom image can be created from any snapshot in a "success" state by navigating to the Snapshots page and selecting the appropriate action from the dropdown menu.
When creating an image from a snapshot, users only need to provide a unique name for the new image.
How to use a custom image
All custom images successfully created by the user will appear in the "Deploy VM" page during virtual machine (VM) deployment. In the image selection section, a new tab called "Custom Images" displays these records. This includes any custom image created from any snapshot.
Images API
The Infrahub API can be used to create, manage and delete Custom Images using the following APIs:
| Endpoint Name | URL | Description |
|---|---|---|
| Create Image | POST /core/snapshots/ | Create an image from a snapshot. |
| List Images | GET /core/images | List all images. |
| Retrieve Image | GET /core/images/ | Retrieve a specific image. |
| Delete Image | DELETE /core/images/ | Deletes a specified image. |