1CHARLIECLOUD(7)                  Charliecloud                  CHARLIECLOUD(7)
2
3
4

NAME

6       charliecloud  -  Lightweight user-defined software stacks for high-per‐
7       formance computing
8

WHAT IS CHARLIECLOUD?

10       Charliecloud provides user-defined software stacks (UDSS) for high-per‐
11       formance  computing (HPC) centers. This “bring your own software stack”
12       functionality addresses needs such as:
13
14       · software dependencies that are numerous,  complex,  unusual,  differ‐
15         ently  configured,  or  simply  newer/older than what the center pro‐
16         vides;
17
18       · build-time requirements unavailable within the center, such as  rela‐
19         tively unfettered internet access;
20
21       · validated  software stacks and configuration to meet the standards of
22         a particular field of inquiry;
23
24       · portability of environments between resources, including workstations
25         and other test and development system not managed by the center;
26
27       · consistent  environments,  even  archivally  so,  that can be easily,
28         reliabily, and verifiably reproduced in the future; and/or
29
30       · usability and comprehensibility.
31

HOW DOES IT WORK?

33       Charliecloud uses Linux user namespaces to run containers with no priv‐
34       ileged  operations or daemons and minimal configuration changes on cen‐
35       ter resources.  This simple approach avoids most security  risks  while
36       maintaining  access  to  the  performance  and functionality already on
37       offer.
38
39       Container images can be built using Docker or anything  else  that  can
40       generate a standard Linux filesystem tree.
41

HOW DO I LEARN MORE?

43       · Documentation: https://hpc.github.io/charliecloud
44
45       · GitHub repository: https://github.com/hpc/charliecloud
46
47       · We  wrote  an  article for USENIX’s magazine ;login: that explains in
48         more detail the motivation for Charliecloud and the  technology  upon
49         which                  it                  is                  based:
50         https://www.usenix.org/publications/login/fall2017/priedhorsky
51
52       · A  more  technical  resource  is  our  Supercomputing   2017   paper:
53         https://dl.acm.org/citation.cfm?id=3126925
54

WHO IS RESPONSIBLE?

56       Contributors:
57
58       · Rusty Davis <rustyd@lanl.gov>
59
60       · Hunter Easterday <heasterday@lanl.gov>
61
62       · Oliver Freyermuth <o.freyermuth@googlemail.com>
63
64       · Shane Goff <rgoff@lanl.gov>
65
66       · Michael Jennings <mej@lanl.gov>
67
68       · Christoph Junghans <junghans@lanl.gov>
69
70       · Jordan Ogas <jogas@lanl.gov>
71
72       · Kevin Pelzel <kpelzel@lanl.gov>
73
74       · Megan Phinney <mphinney@lanl.gov>
75
76       · Reid Priedhorsky <reidpr@lanl.gov>, co-founder and project lead
77
78       · Tim Randles <trandles@lanl.gov>, co-founder
79
80       · Matthew Vernon <mv3@sanger.ac.uk>
81
82       · Peter Wienemann <wienemann@physik.uni-bonn.de>
83
84       · Lowell Wofford <lowell@lanl.gov>
85

HOW CAN I PARTICIPATE?

87       Questions,  comments,  feature  requests,  bug  reports,  etc.  can  be
88       directed to:
89
90       · our       mailing       list:        charliecloud@groups.io        or
91         https://groups.io/g/charliecloud
92
93       · issues on GitHub
94
95       Patches are much appreciated on the software itself as well as documen‐
96       tation.  Optionally, please include in your first patch  a  credit  for
97       yourself in the list above.
98
99       We are friendly and welcoming of diversity on all dimensions.
100

102       Charliecloud is copyright © 2014–2020 Triad National Security, LLC.
103
104       This   software   was   produced   under   U.S.   Government   contract
105       89233218CNA000001 for Los Alamos National Laboratory (LANL),  which  is
106       operated  by  Triad  National  Security, LLC for the U.S. Department of
107       Energy/National Nuclear Security Administration.
108
109       This is open source software (LA-CC 14-096); you  can  redistribute  it
110       and/or  modify it under the terms of the Apache License, Version 2.0. A
111       copy is included in file LICENSE. You may not use this software  except
112       in compliance with the license.
113
114       The  Government is granted for itself and others acting on its behalf a
115       nonexclusive, paid-up, irrevocable worldwide license in  this  material
116       to  reproduce,  prepare derivative works, distribute copies to the pub‐
117       lic, perform publicly and display publicly, and to permit others to  do
118       so.
119
120       Neither  the government nor Triad National Security, LLC makes any war‐
121       ranty, express or implied, or assumes any liability  for  use  of  this
122       software.
123
124       If  software  is  modified to produce derivative works, such derivative
125       works should be clearly marked, so as not to confuse it with  the  ver‐
126       sion available from LANL.
127
128   Reporting bugs
129       If  Charliecloud  was  obtained  from your Linux distribution, use your
130       distribution’s bug reporting procedures.
131
132       Otherwise, report bugs to: <https://github.com/hpc/charliecloud/issues>
133

SEE ALSO

135       ch-build(1), ch-build2dir(1), ch-builder2squash(1),  ch-builder2tar(1),
136       ch-checkns(1),     ch-dir2squash(1),     ch-fromhost(1),    ch-grow(1),
137       ch-image(1), ch-mount(1),  ch-pull2dir(1),  ch-pull2tar(1),  ch-run(1),
138       ch-run-oci(1),   ch-ssh(1),  ch-tar2dir(1)  ch-tar2dir(1),  ch-test(1),
139       ch-umount(1)
140
141       Full documentation at: <https://hpc.github.io/charliecloud>
142

NOTE

144       These man pages are for Charliecloud version 0.22 (Git commit 0.22).
145

147       2014–2020, Triad National Security, LLC
148
149
150
151
1520.22              2021-03-08 00:00 Coordinated Universal Time  CHARLIECLOUD(7)
Impressum