Skip to content

Commit 9153731

Browse files
authored
Merge pull request #16 from sarus-suite/readme-update
update to README
2 parents 3e0965b + 77f3c65 commit 9153731

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
# parallax
22

3-
*parallax* turbocharges Podman on HPC systems by providing an efficient and read-only container image storage for parallel filesystems. With parallax, users can migrate images, leverage SquashFS, and manage distributed storage.
3+
*parallax* turbocharges Rootless Podman on HPC systems by providing an efficient and read-only container image storage for parallel filesystems. With parallax, users can migrate images, leverage SquashFS, and manage distributed storage.
44
*parallax* is a Go utility that directly uses the container storage libraries to ensure compatibility with Podman.
55

66
## Why parallax?
7-
* Faster and lighter containers. It uses SquashFS images that boosts start times and runtimes.
8-
* Shared storage ready. Run Podman with container image store located in parallel filesystems.
9-
* Enhances Podman's overlay driver. No changes to your workflows are needed.
10-
* Pull-once, run-everywhere. Using Podman in a cluster does not require pulling iamges on every node, instead run directly from shared FS.
7+
* Pull-once, run-everywhere. Run Podman with a container image store located in parallel filesystems, avoiding redundant image pulls across cluster nodes.
8+
* Faster and lighter containers. It uses SquashFS images that boosts start times and runtimes, reducing IO contention with Read-Only shared storage.
9+
* Maintain compatibility with existing workflows. No changes to Podman itself.
1110

1211
## How it works?
13-
Parallax leverages existing container libraries for image handling, and a lightweight Bash wrapper to integrate SquashFS into Podman’s overlay driver—no C code or recompilation of Podman required.
12+
Parallax leverages existing container libraries for image handling, and a lightweight mount program to integrate SquashFS into Podman’s overlay driver—no C code or recompilation of Podman required.
1413

1514
* Migrate your container image to a shared, read-only store (parallax --migrate):
1615
* Pull & mount source image.
1716
* Flatten into a dummy layer + generate SquashFS side-car.
1817
* Record layer link in the read-only store.
19-
* Integrates with Podman overlay storage driver via our custom mount\_program script that provides overlay + SquashFS support.
18+
* Integrates with Podman overlay storage driver via a custom mount program that provides overlay + SquashFS support.
2019
* Enables HPC containers via Podman
2120
* Use with Podman --storage-opt additionalimagestore=… --storage-opt mount\_program=…/parallax-mount-program.sh.
2221
* Podman’s overlay driver invokes Parallax mount program instead of the overlay driver default.

0 commit comments

Comments
 (0)