-
Notifications
You must be signed in to change notification settings - Fork 0
Update README.md #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
fcruzcscs
wants to merge
2
commits into
main
Choose a base branch
from
readme-update
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,36 @@ | ||
| # Sarusctl | ||
|
|
||
| Testing CLI written in rust for raster and sarus-suite | ||
| Turning an EDF into a running container, with minimal friction. | ||
| `sarusctl` standardizes how you go from "recipe" to "runnable" containerized deployment. | ||
| Give it a EDF file and it will validate it, show you exactly what it resolves to, pulls and migrate the image if needed, and run the container using Podman with sane HPC defaults. Accelerating working with high performance containers with Podman on HPC systems. | ||
|
|
||
| ## Why it matters | ||
| * One file in, one predictable run out. EDF becomes a container with the same steps everywhere. No snowflake deployments. | ||
| * Delivery without friction. `sarusctl` pulls the image (if needed), migrates it into a read-only store with Parallax, and launches with ephemeral settings. | ||
| * Built-in guardrails. `validate` helps you catch errors early. | ||
| * Portable binary, repeatable builds. Prebuilt binaries for amd64 and arm64; devcontainer config ships a static optimized Rust build. | ||
|
|
||
| ## What sarusctl simplifies for you | ||
|
|
||
| * Understands your EDF. It parses the EDF via the `raster` library for validation and rendering. You get clear debugging information or a concrete, pretty printed plan. | ||
| * Builds the right Podman contexts. `sarusctl` setups and manages the correct Podman contexts to ensure a consistent setup. | ||
| * Pulls and migrates of images on demand. If the image is not present in the RO store in the parallel Filesystem, it pulls with Podman and then migrates it with Parallax, then runs from the EDF. | ||
| * Keeps host clean. Runs with managed temporal directories and a read-only imagestore for fast, low-friction work. | ||
|
|
||
| ## Getting started | ||
|
|
||
| * Prebuilt artifacts. CI builds both amd64 and arm64 artifacts. | ||
| * Build locally | ||
| ```bash | ||
| cargo build --release | ||
| ./target/release/sarusctl --help | ||
| ``` | ||
| * Quickstart | ||
| ```bash | ||
| # Check the EDF recipe | ||
| sarusctl validate my_env.edf | ||
|
|
||
| # Run it | ||
| sarusctl run my_env.edf cat /etc/os-release | ||
| ``` | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right now
sarusctlrelies on 3 envrionment variables to tell it about the location of Parallax, the RO storage and the Podman module to use. Those vars should be part of the quickstart for a smooth experience or the code should be changed to support a more direct experience and more intelligent config handling.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, I will test this before merge and publish something that works