1CHARLIECLOUD(1)                  Charliecloud                  CHARLIECLOUD(1)
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       · Reid Priedhorsky <reidpr@lanl.gov>, co-founder and project lead
75
76       · Tim Randles <trandles@lanl.gov>, co-founder
77
78       · Matthew Vernon <mv3@sanger.ac.uk>
79
80       · Peter Wienemann <wienemann@physik.uni-bonn.de>
81
82       · Lowell Wofford <lowell@lanl.gov>
83

HOW CAN I PARTICIPATE?

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

100       Charliecloud  is  copyright  ©  2014–2018 Los Alamos National Security,
101       LLC. This software has been approved for  open  source  release,  LA-CC
102       14-096.
103
104       Licensed under the Apache License, Version 2.0 (the “License”); you may
105       not use this software except in compliance with the License. A copy  of
106       the license is included in file LICENSE.
107
108       This   material   was   produced   under   U.S.   Government   contract
109       DE-AC52-06NA25396 for Los Alamos National Laboratory (LANL),  which  is
110       operated  by  Los Alamos National Security, LLC for the U.S. Department
111       of Energy. The U.S. Government has rights to use, reproduce,  and  dis‐
112       tribute  this  software. NEITHER THE GOVERNMENT NOR LOS ALAMOS NATIONAL
113       SECURITY, LLC MAKES ANY WARRANTY, EXPRESS OR IMPLIED,  OR  ASSUMES  ANY
114       LIABILITY FOR THE USE OF THIS SOFTWARE. If software is modified to pro‐
115       duce derivative works, such modified software should be clearly marked,
116       so as not to confuse it with the version available from LANL.
117
118   Reporting bugs
119       If  Charliecloud  was  obtained  from your Linux distribution, use your
120       distribution’s bug reporting procedures.
121
122       Otherwise, report bugs to: <https://github.com/hpc/charliecloud/issues>
123

SEE ALSO

125       ch-build(1),   ch-build2dir(1),    ch-builder2tar(1),    ch-checkns(1),
126       ch-dir2squash(1),   ch-docker2squash(1),   ch-fromhost(1),  ch-grow(1),
127       ch-mount(1), ch-pull2dir(1), ch-pull2tar(1), ch-run(1),  ch-run-oci(1),
128       ch-ssh(1), ch-tar2dir(1) ch-tar2dir(1), ch-tar2squash(1), ch-umount(1)
129
130       Full documentation at: <https://hpc.github.io/charliecloud>
131

NOTE

133       These man pages are for Charliecloud version 0.10 (Git commit ).
134

136       2014–2018, Los Alamos National Security, LLC
137
138
139
140
141                  2020-01-28 00:00 Coordinated Universal Time  CHARLIECLOUD(1)
Impressum