Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rafftechnologies.com/llms.txt

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

Updated May 8, 2026 A custom image is a snapshot of a VM’s OS disk preserved as a reusable template. Save one from any VM, then pick it from the create flow to launch identical VMs — same kernel, same packages, same configuration, fresh disks. Custom images sit alongside Raff’s stock OS templates (Ubuntu, Debian, Windows Server, …). The create-VM dialog lists both: stock templates under the OS tab, your custom images alongside Marketplace images.

Why use custom images

GoalCustom image solves it
Promote a VM from one region to anotherSave as image → create new VM in target region
Standardize a base config across many VMsBuild once, image, deploy from image N times
Roll back to a known-good stateSave before changes, recreate from image if needed
Cut provisioning time for repeat workloadsSkip cloud-init / Ansible runs after every create
Snapshots are good for one VM’s restore points; custom images are good for N VMs sharing a starting state.
Custom imageSnapshotBackupOS template
SourceYour VMYour VMYour VMRaff-provided
Reusable to create new VMsYesNo (restore-only)No (restore-only)Yes
LifecycleUntil you deleteUntil you deletePer retention policyUntil Raff retires
Survives source-VM deleteYesNo (deleted with VM)Yes (per retention)n/a
Best for”Golden image” patternPre-change checkpointRoutine protectionVanilla starting point
The big practical difference: snapshots are deleted when the source VM is deleted; custom images outlive the VM. If you want a starting point that persists, save the snapshot as an image first.

How to create one

Two paths reach the same outcome:
  1. From an existing VM — use Save VM disk as image (API today; dashboard exposure planned). The VM’s current OS disk is captured as an image.
  2. From a snapshot — convert an existing snapshot into a permanent image before deleting the source VM, so the image survives.
Both produce a custom image that appears in the create-VM template picker.

How to use one

Open the Create VM flow and pick the OS template step. The picker lists:
  • OS tab — Raff stock templates (vanilla distros, Windows Server)
  • Marketplace tab — pre-built application stacks
  • Your custom images — what you’ve saved
Select your image, choose region/plan/auth, and create as normal. The new VM boots with your saved disk as its OS disk.

What gets baked in

A custom image captures everything on the OS disk at the moment of capture:
  • Installed packages, configs, kernel, drivers
  • Application code in your usual paths
  • Set hostnames inside the OS, fixed IPs in /etc/netplan or similar (these will conflict — clear them before imaging)
  • Cron jobs, systemd units, mounted state
  • Any secrets or credentials sitting on disk — sanitize first
It does not capture:
  • Attached volumes (separate volumes, separate snapshots)
  • The dashboard hostname, tags, notes (those belong to the VM record)
  • Network configuration assigned by the platform — new VMs get fresh IPs

Best practices for golden images

  • Run a sanitization pass before imaging: clear shell history, remove machine-specific keys (ssh-keygen -A or cloud-init clean), zero out sensitive disk areas.
  • Pin package versions so the image is reproducible, or document the apt/yum state.
  • Version your images by name — web-base-2026-04, web-base-2026-05 — so you know what’s current.
  • Delete old image versions you no longer use to stop storage charges.

Pricing

Custom images bill per GB-stored, similar to backups and snapshots. The exact rate is in Pricing. Delete images you no longer need.

OS templates

Stock images Raff provides.

Snapshots vs Backups

Decision framework for protective copies.
Last modified on May 8, 2026