Skip to content

image2disk

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

image2disk

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
image
image
 
 
Dockerfile
Dockerfile
 
 
README.md
README.md
 
 
main.go
main.go
 
 

README.md

image2disk

quay.io/tinkerbell/actions/image2disk:latest

This Action will stream a remote disk image (raw) to a block device, and is mainly used to write cloud images to a disk. It is recommended to use the qemu-img tool to convert disk images into raw, it is also possible to compress the raw images with tar+gzip to prevent wasted disk space.

env var data type default value required description
IMG_URL string "" yes URL of the image to be streamed
DEST_DISK string "" yes Block device to which to write the image
COMPRESSED bool false no Decompress the image before writing it to the disk
RETRY_ENABLED bool false no Retry the Action, using exponential backoff, for the duration specified in RETRY_DURATION_MINUTES before failing
RETRY_DURATION_MINUTES int 10 no Duration for which the Action will retry before failing
PROGRESS_INTERVAL_SECONDS int 3 no Interval at which the progress of the image transfer will be logged
TEXT_LOGGING bool false no Output from the Action will be logged in a more human friendly text format, JSON format is used by default

The below example will stream a raw ubuntu cloud image (converted by qemu-img) and write it to the block storage disk /dev/sda. The raw image is uncompressed in this example.

qemu-img convert ubuntu.img ubuntu.raw
actions:
- name: "stream ubuntu"
  image: quay.io/tinkerbell/actions/image2disk:latest
  timeout: 90
  environment:
      IMG_URL: http://192.168.1.2/ubuntu.raw
      DEST_DISK: /dev/sda
      COMPRESSED: false

The below example will stream a compressed raw ubuntu cloud image (converted by qemu-img) and write it to the block storage disk /dev/sda. The raw image is compressed with gzip in this example.

qemu-img convert ubuntu.img ubuntu.raw
gzip ubuntu.raw
actions:
- name: "stream ubuntu"
  image: quay.io/tinkerbell/actions/image2disk:latest
  timeout: 90
  environment:
      IMG_URL: http://192.168.1.2/ubuntu.tar.gz
      DEST_DISK: /dev/sda
      COMPRESSED: true

Supported Compression formats

  • bzip2 (.bzip2, .bz2)
  • gzip (.gz)
  • xz (.xz)
  • zstd (.zs, .zst)