snippetbashTip

apptainer overlay — Manage EXT3 writable overlay images for Apptainer containers. More information: <https://apptainer.o

Submitted by: @import:tldr-pages·Mar 2, 2026·

Viewed 0 times

apptainer overlaycommandext3imagesclimanagewritableoverlay

linux

Problem

How to use the apptainer overlay command: Manage EXT3 writable overlay images for Apptainer containers. More information: <https://apptainer.org/docs/user/main/cli/apptainer_overlay.html>.

Solution

apptainer overlay — Manage EXT3 writable overlay images for Apptainer containers. More information: <https://apptainer.org/docs/user/main/cli/apptainer_overlay.html>.

Add a writable overlay to an existing SIF image:

apptainer overlay create {{[-s|--size]}} {{size}} {{path/to/image.sif}}

Create a standalone EXT3 writable overlay image:

apptainer overlay create {{[-s|--size]}} {{size}} {{path/to/overlay.img}}

Create a sparse overlay image:

apptainer overlay create {{[-s|--size]}} {{size}} {{[-S|--sparse]}} {{path/to/overlay.img}}

Create an overlay for use with fakeroot:

apptainer overlay create {{[-f|--fakeroot]}} {{[-s|--size]}} {{size}} {{path/to/overlay.img}}

Create an overlay with a specific directory in the layout:

apptainer overlay create --create-dir {{path/to/directory}} {{path/to/overlay.img}}

Display help:

apptainer overlay {{[-h|--help]}}

Code Snippets

Add a writable overlay to an existing SIF image

apptainer overlay create {{[-s|--size]}} {{size}} {{path/to/image.sif}}

Create a standalone EXT3 writable overlay image

apptainer overlay create {{[-s|--size]}} {{size}} {{path/to/overlay.img}}

Create a sparse overlay image

apptainer overlay create {{[-s|--size]}} {{size}} {{[-S|--sparse]}} {{path/to/overlay.img}}

Create an overlay for use with fakeroot

apptainer overlay create {{[-f|--fakeroot]}} {{[-s|--size]}} {{size}} {{path/to/overlay.img}}

Create an overlay with a specific directory in the layout

apptainer overlay create --create-dir {{path/to/directory}} {{path/to/overlay.img}}

Context

tldr-pages: linux/apptainer overlay

Revisions (0)

No revisions yet.