\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{Caughlin Bohn (cbohn4)} \pdfinfo{ /Title (apptainer.pdf) /Creator (Cheatography) /Author (Caughlin Bohn (cbohn4)) /Subject (Apptainer Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{A31515} \definecolor{LightBackground}{HTML}{F9F0F0} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{Apptainer Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{Caughlin Bohn (cbohn4)} via \textcolor{DarkBackground}{\uline{cheatography.com/203697/cs/43402/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}Caughlin Bohn (cbohn4) \\ \uline{cheatography.com/cbohn4} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 16th May, 2024.\\ Updated 16th May, 2024.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{tabularx}{17.67cm}{x{8.635 cm} x{8.635 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{17.67cm}}{\bf\textcolor{white}{Pulling images}} \tn % Row 0 \SetRowColor{LightBackground} apptainer pull \textless{}output.sif\textgreater{} shub://{[}reposiory/name/{]} & Pull sif image from Singularity Hub \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} apptainer pull \textless{}output.sif\textgreater{} docker://{[}docker\_image{]} & Pull Docker image from Dockerhub or remote container registry \tn % Row Count 7 (+ 4) % Row 2 \SetRowColor{LightBackground} apptainer pull \textless{}output.sif\textgreater{} docker-daemon://{[}image\_name{]} & Pull docker image from local Docker image builds \tn % Row Count 10 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{17.67cm}}{Before a Docker image can be used by Apptainer, it must be pulled to make it compatible with Apptainer.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{6.3899 cm} x{10.8801 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{17.67cm}}{\bf\textcolor{white}{Apptainer Cache}} \tn % Row 0 \SetRowColor{LightBackground} apptainer cache list & Show basic details on what is in the local cache \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} apptainer cache list -v & Lists SIF images stored in the local cache \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} apptainer cache clean & Remove everything stored in the local cache \tn % Row Count 6 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{17.67cm}}{By default, Apptainer stores the cache in \seqsplit{`\$HOME/.apptainer/cache`}, but can be changed by modifying the `APPTAINER\_CACHEDIR` variable} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{8.635 cm} x{8.635 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{17.67cm}}{\bf\textcolor{white}{Executing commands from a image}} \tn % Row 0 \SetRowColor{LightBackground} apptainer exec {[}SIF\_File.sif{]} \textless{}command\_to\_execute\textgreater{} & Execute a command from the image \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} apptainer run {[}SIF\_File.sif{]} & Executes the default command for the image \tn % Row Count 6 (+ 3) % Row 2 \SetRowColor{LightBackground} apptainer inspect -r {[}SIF\_File.sif{]} & Inspect the SIF image and locate the default command \tn % Row Count 9 (+ 3) % Row 3 \SetRowColor{white} apptainer shell {[}SIF\_File.sif{]} & Open an interactive shell within the container \tn % Row Count 12 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{8.635 cm} x{8.635 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{17.67cm}}{\bf\textcolor{white}{Binding host directories to a container}} \tn % Row 0 \SetRowColor{LightBackground} apptainer shell -B /directory/to/add {[}SIF\_File.sif{]} & Add a directory to the same location in the container \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} apptainer shell -B \seqsplit{/directory/to/add:/new/location/in\_container} {[}SIF\_File.sif{]} & Add a directory to a different location in the container \tn % Row Count 7 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{17.67cm}}{The "-B" arguement can apply to the `shell`, `exec`, and `run` sub commands of Apptainer. `shell` is only used as an example. This is refered to as "{\bf{B}}inding" the directory inside of the container.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{8.635 cm} x{8.635 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{17.67cm}}{\bf\textcolor{white}{Building Apptainer Images}} \tn % Row 0 \SetRowColor{LightBackground} apptainer build /path/to/ouput.sif /path/to/input.def & Build a sif image using the .def definition file. \tn % Row Count 3 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{3.0366 cm} x{4.7236 cm} x{9.1098 cm} } \SetRowColor{DarkBackground} \mymulticolumn{3}{x{17.67cm}}{\bf\textcolor{white}{Apptainer Definition File Keywords}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{Apptainer}} & {\bf{Docker Equivalent}} & {\bf{Description}} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} From: & FROM & Base image for the image \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} \%files & ADD & Add files from the host system into the image \tn % Row Count 7 (+ 3) % Row 3 \SetRowColor{white} \seqsplit{\%environment} & ENV & Add environment variables to the image \tn % Row Count 9 (+ 2) % Row 4 \SetRowColor{LightBackground} \%post & RUN & Run commands to build or install software in the image \tn % Row Count 12 (+ 3) % Row 5 \SetRowColor{white} \seqsplit{\%runscript} & CMD / ENTRYPOINT & What to run when the container is used with `apptainer run` \tn % Row Count 15 (+ 3) % Row 6 \SetRowColor{LightBackground} \%setup & & Run commands on the host system before starting the build \tn % Row Count 18 (+ 3) % Row 7 \SetRowColor{white} \seqsplit{\%labels} & LABEL & Add metadata labels \tn % Row Count 19 (+ 1) % Row 8 \SetRowColor{LightBackground} \seqsplit{Bootstrap} & & Tells Apptainer which type of source the base image will be. \tn % Row Count 22 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}---} \SetRowColor{LightBackground} \mymulticolumn{3}{x{17.67cm}}{Examples and more information is available at \seqsplit{https://apptainer.org/docs/user/main/definition\_files.html}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}---} \end{tabularx} \par\addvspace{1.3em} \end{document}