Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xloud.tech/llms.txt

Use this file to discover all available pages before exploring further.

Overview

The Xloud Image Service accepts virtual machine disk images in several formats for use as boot sources when launching new instances. Upload images through the Dashboard’s Create Image form or via the CLI.
Prerequisites
  • An active Xloud account with appropriate permissions
  • Access to the Xloud Dashboard or CLI configured with credentials
  • API credentials sourced (source openrc.sh)

Create an Image

1

Navigate to Images

Navigate to Compute > Images in the sidebar. Click Create Image. The create form opens as a full page.
2

Configure basic information

FieldTypeRequiredDescription
NameTextYesImage display name (e.g., ubuntu-24.04-lts)
Upload TypeRadioNoUpload File (default) or File URL
FileFile uploadIf Upload FileSelect the local disk image file
File URLTextIf File URLURL starting with http:// or https://
Disk FormatDropdownYesRAW, QCOW2, ISO (admin users also see AKI, ARI, AMI, VDI, VHD, VMDK)
Container FormatDropdownConditionalBare or Docker (shown when multiple formats are available)
Administrators see an additional Owned Project selector to upload images on behalf of other projects.
3

Configure OS details (bare container format)

When the container format is Bare (default), these OS fields appear:
FieldTypeRequiredDescription
OSDropdownYesCentOS, Ubuntu, Fedora, Windows, Debian, CoreOS, Arch, FreeBSD, Others
OS VersionTextYesVersion string (e.g., 24.04, 9.3)
OS AdminTextYesDefault admin user (root for Linux, Administrator for Windows)
Setting the OS Admin correctly enables password injection. The instance create wizard uses this field to pre-populate the login username.
4

Set resource requirements

FieldTypeDescription
Min System Disk (GiB)Number (0-500)Minimum root disk for launching (0 = unlimited)
Min Memory (GiB)Number (0-500)Minimum RAM for launching (0 = unlimited)
5

Configure visibility and usage

FieldTypeDescription
VisibilityRadio (admin only)Public (default for admin), Private (default for users), or Shared
ProjectMulti-select tableSelect projects to share with (shown when Shared visibility)
ProtectedCheckboxPrevent accidental deletion
Usage TypeDropdownCommon Server (default), Bare Metal. Administrators also see: Bare Metal Enroll, Load Balancer, Database, Container, Application Template
DescriptionText areaOptional notes (max 255 characters)
6

Advanced options (optional)

Click Advanced Options to expand:
FieldTypeDefaultDescription
qemu_guest_agent enabledRadioYesEnable the QEMU guest agent for password change support
CPU PolicyDropdownNot setshared, dedicated (for CPU pinning)
CPU Thread PolicyDropdownNot setprefer, isolate, require
7

Submit

Click Confirm. The image enters Saving status while data transfers.
Image status transitions to Active when upload completes. Ready for launching instances.

View Images

Navigate to Compute > Images. The list shows images in tabs:
TabShows
Current Project ImagesImages owned by your project
Public ImagesPublicly visible images
Shared ImagesImages shared with your project
All ImagesAll images (admin role required)
List columns:
ColumnDescription
ID/NameImage identifier (clickable to view details)
DescriptionOptional description
Use TypeCommon Server, Bare Metal, Load Balancer, etc.
Container FormatBare or Docker
TypeOS distribution (CentOS, Ubuntu, Windows, etc.)
StatusActive, Saving, Queued, Deactivated, etc.
VisibilityPublic, Private, or Shared
Disk FormatRAW, QCOW2, ISO, etc.
SizeImage file size
Created AtUpload timestamp
Filter by Name, Status, or Visibility.User actions:
ActionLocationDescription
EditFirst row actionEdit name, OS details, protection
Create InstanceMore dropdownLaunch a VM from this image
Create Ironic InstanceMore dropdownLaunch a bare metal instance (if Ironic enabled)
Create VolumeMore dropdownCreate a block storage volume from the image
DeleteMore dropdown / batchDelete the image
Admin actions (completely different set):
ActionLocationDescription
EditFirst row actionEdit name, OS details, visibility, protection
DeleteMore dropdownDelete the image
Manage AccessMore dropdownShare with projects (requires Shared visibility)
Manage MetadataMore dropdownEdit image metadata key-value pairs

Image Detail

Click an image name to open the detail page. The header shows Name, Status, Project ID, Description, Created At, and Updated At.The Detail tab shows:
SectionFields
Base InfoSize, Min System Disk, Min Memory, Disk Format, OS, OS Version, Container Format
Security InfoOwner (copyable), Filename (copyable), Visibility, Protected, Checksum (copyable)
Custom PropertiesAll image metadata key-value pairs

Upload Best Practices

Always set min_disk and min_ram

Setting minimum disk and RAM prevents instance launch failures on flavors too small for the image:
OSRecommended min_diskRecommended min_ram
Ubuntu 22.04+10 GiB1 GiB
CentOS/RHEL 915 GiB1 GiB
Windows Server40 GiB2 GiB
The QEMU guest agent enables password changes and other management operations from the Dashboard. Set hw_qemu_guest_agent=yes in Advanced Options (enabled by default in the Dashboard form).
Include OS version and build date for easy lifecycle management: ubuntu-24.04-lts-2026-03, windows-2022-std-2026-03.

Next Steps

Image Properties

Set hardware requirements and OS metadata on uploaded images

Share Images

Share images with other projects in your organization

Create a Snapshot

Capture running instances as golden images

Troubleshooting

Resolve upload failures and stuck images