This repository has been archived by the owner on Oct 2, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
replace README with GitLab.com notice
- Loading branch information
Showing
1 changed file
with
3 additions
and
149 deletions.
There are no files selected for viewing
This file contains 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,149 +1,3 @@ | ||
| What is Charliecloud? | ||
| --------------------- | ||
|
|
||
| Charliecloud provides user-defined software stacks (UDSS) for high-performance | ||
| computing (HPC) centers. This “bring your own software stack” functionality | ||
| addresses needs such as: | ||
|
|
||
| * software dependencies that are numerous, complex, unusual, differently | ||
| configured, or simply newer/older than what the center provides; | ||
|
|
||
| * build-time requirements unavailable within the center, such as relatively | ||
| unfettered internet access; | ||
|
|
||
| * validated software stacks and configuration to meet the standards of a | ||
| particular field of inquiry; | ||
|
|
||
| * portability of environments between resources, including workstations and | ||
| other test and development system not managed by the center; | ||
|
|
||
| * consistent environments, even archivally so, that can be easily, reliably, | ||
| and verifiably reproduced in the future; and/or | ||
|
|
||
| * usability and comprehensibility. | ||
|
|
||
| How does it work? | ||
| ----------------- | ||
|
|
||
| Charliecloud uses Linux user namespaces to run containers with no privileged | ||
| operations or daemons and minimal configuration changes on center resources. | ||
| This simple approach avoids most security risks while maintaining access to | ||
| the performance and functionality already on offer. | ||
|
|
||
| Container images can be built using Docker or anything else that can generate | ||
| a standard Linux filesystem tree. | ||
|
|
||
| How do I learn more? | ||
| -------------------- | ||
|
|
||
| * Documentation: https://hpc.github.io/charliecloud | ||
|
|
||
| * GitHub repository: https://github.com/hpc/charliecloud | ||
|
|
||
| * Low-traffic mailing list for announcements: https://groups.io/g/charliecloud | ||
|
|
||
| * We wrote an article for USENIX's magazine *;login:* that explains in more | ||
| detail the motivation for Charliecloud and the technology upon which it is | ||
| based: https://www.usenix.org/publications/login/fall2017/priedhorsky | ||
|
|
||
| * For technical papers about Charliecloud, refer to the *Technical | ||
| publications* section below. | ||
|
|
||
| Who is responsible? | ||
| ------------------- | ||
|
|
||
| Contributors: | ||
|
|
||
| * Richard Berger <[email protected]> | ||
| * Lucas Caudill <[email protected]> | ||
| * Rusty Davis <[email protected]> | ||
| * Hunter Easterday <[email protected]> | ||
| * Oliver Freyermuth <[email protected]> | ||
| * Shane Goff <[email protected]> | ||
| * Michael Jennings <[email protected]> | ||
| * Christoph Junghans <[email protected]> | ||
| * Dave Love <[email protected]> | ||
| * Jordan Ogas <[email protected]> | ||
| * Kevin Pelzel <[email protected]> | ||
| * Megan Phinney <[email protected]> | ||
| * Reid Priedhorsky <[email protected]>, co-founder and project lead | ||
| * Tim Randles <[email protected]>, co-founder | ||
| * Benjamin "The Storm" Stormer <[email protected]> | ||
| * Meisam Tabriz <[email protected]> | ||
| * Matthew Vernon <[email protected]> | ||
| * Peter Wienemann <[email protected]> | ||
| * Lowell Wofford <[email protected]> | ||
|
|
||
| How can I participate? | ||
| ---------------------- | ||
|
|
||
| Use our GitHub page: https://github.com/hpc/charliecloud | ||
|
|
||
| Bug reports and feature requests should be filed as “Issues”. Questions, | ||
| comments, support requests, and everything else should use our “Discussions”. | ||
| Don't worry if you put something in the wrong place; we’ll be more than happy | ||
| to help regardless. | ||
|
|
||
| We also have a mailing list for announcements: https://groups.io/g/charliecloud | ||
|
|
||
| Patches are much appreciated on the software itself as well as documentation. | ||
| Optionally, please include in your first patch a credit for yourself in the | ||
| list above. | ||
|
|
||
| We are friendly and welcoming of diversity on all dimensions. | ||
|
|
||
| Technical publications | ||
| ---------------------- | ||
|
|
||
| If Charliecloud helped your research, or it was useful to you in any other | ||
| context where bibliographic citations are appropriate, please cite the | ||
| following open-access paper: | ||
|
|
||
| Reid Priedhorsky and Tim Randles. “Charliecloud: Unprivileged containers for | ||
| user-defined software stacks in HPC”, 2017. In *Proc. Supercomputing*. | ||
| DOI: `10.1145/3126908.3126925 <https://doi.org/10.1145/3126908.3126925>`_. | ||
|
|
||
| *Note:* This paper contains out-of-date number for the size of Charliecloud’s | ||
| code. Please instead use the current number in the FAQ. | ||
|
|
||
| Other publications: | ||
|
|
||
| * We compare the performance of three HPC-specific container technologies | ||
| against bare metal, finding no concerns about performance degradation. | ||
|
|
||
| Alfred Torrez, Tim Randles, and Reid Priedhorsky. “HPC container runtimes | ||
| have minimal or no performance impact”, 2019. In *Proc. CANOPIE HPC | ||
| Workshop @ SC*. DOI: `10.1109/CANOPIE-HPC49598.2019.00010 | ||
| <https://ieeexplore.ieee.org/document/8950978>`_. | ||
|
|
||
| * A demonstration of how low-privilege containers solve increasing demand for | ||
| software flexibility. | ||
|
|
||
| Reid Priedhorsky, R. Shane Canon, Timothy Randles, and Andrew J. Younge. | ||
| “Minimizing privilege for building HPC containers”, 2021. In *Proc. | ||
| Supercomputing*. DOI: `10.6084/m9.figshare.14396099 | ||
| <https://doi.org/10.6084/m9.figshare.14396099>`_. | ||
|
|
||
| * Charliecloud’s build cache performs competitively with the standard | ||
| many-layered union filesystem approach and has structural advantages | ||
| including a better diff format, lower cache overhead, and better file | ||
| de-duplication. | ||
|
|
||
| Reid Priedhorsky, Jordan Ogas, Claude H. (Rusty) Davis IV, Z. Noah | ||
| Hounshel, Ashlyn Lee, Benjamin Stormer, and R. Shane Goff. "Charliecloud’s | ||
| layer-free, Git-based container build cache", 2023. In *Proc. | ||
| Supercomputing*. DOI: `10.1145/3624062.3624585 | ||
| <https://doi.org/10.1145/3624062.3624585>`_. | ||
|
|
||
| License and intellectual property | ||
| --------------------------------- | ||
|
|
||
| Charliecloud is open source software; you can redistribute it and/or modify it | ||
| under the terms of the Apache License, Version 2.0. A copy is included in file | ||
| LICENSE. You may not use this software except in compliance with the license. | ||
|
|
||
| Copyrights and patents are retained by contributors. No copyright assignment | ||
| is required to contribute to Charliecloud. | ||
|
|
||
|
|
||
| .. LocalWords: USENIX's CNA Meisam figshare | ||
| Charliecloud is a lightweight, fully unprivileged container implementation for | ||
| HPC applications. The project is now hosted on GitLab: | ||
| https://gitlab.com/charliecloud/main |