VM Images Overview

Create Custom Images

Use the compute images create to create a custom image:

crusoe compute images create --name <image-name> --vm-name <vm-name>  --tags <tag1,tag2> --description <description> --project-name <project-name>

info

The Create Custom Image workflow can take a few minutes to complete and the time taken depends on the used capacity of the source VM OS disk. Do not turn the source VM off while it is being created.

Listing Images

CLI
UI
Terraform

Use the compute images list to list all images:

crusoe compute images list

# Data source to get all custom images
data "crusoe_compute_custom_image" "clean_list_images" {
}
output "custom_image_list" {
  value = data.crusoe_compute_custom_image.clean_list_images.custom_images
}

Using Images

CLI
UI
Terraform

Use the compute vms create command, passing an image flag with the chosen curated image or passing a --custom-image flag with the chosen custom image:

crusoe compute vms create \
  --image ubuntu:22.04 \
  ...
crusoe compute vms create \
  --custom-image my-custom-image \
  ...

# Create the VM using the custom image
resource "crusoe_compute_instance" "my_vm_with_custom_image" {
  name         = "my-vm"
  location     = "us-east1-a"
  type         = "c1a.2x"
  custom_image = "my-custom-image"  # Use custom_image parameter with image name
  ssh_key      = file("~/.ssh/id_ed25519.pub")
}

Update Custom Images

Use the compute images update command, passing an description flag to update the description:

crusoe compute images update <vm-name>\
  --description my-new-description \
  ...

Use the compute images add-tags command, passing an tags flag to add tags to the custom image:

crusoe compute images add-tags <vm-name>\
  --tags my-new-tag1,my-new-tag2 \
  ...

Use the compute images delete-tags command, passing an tags flag to delete tags from the custom image:

crusoe compute images delete-tags <vm-name>\
  --tags my-tags-to-delete1,my-tags-to-delete2 \
  ...

Delete Custom Images

Use the compute images delete command:

crusoe compute images delete <my-custom-image>

VM Images Overview

Create Custom Images​

Listing Images​

Using Images​

Update Custom Images​

Delete Custom Images​

Create Custom Images

Listing Images

Using Images

Update Custom Images

Delete Custom Images