\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{achang} \pdfinfo{ /Title (docker-tools-and-terms.pdf) /Creator (Cheatography) /Author (achang) /Subject (Docker Tools and Terms 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}{51BAEF} \definecolor{LightBackground}{HTML}{E9F6FD} \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{Docker Tools and Terms Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{achang} via \textcolor{DarkBackground}{\uline{cheatography.com/39709/cs/12310/}}} \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}achang \\ \uline{cheatography.com/achang} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 17th July, 2017.\\ Updated 29th August, 2017.\\ 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{multicols*}{2} \begin{tabularx}{8.4cm}{x{3.52 cm} x{4.48 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Container Tools}} \tn % Row 0 \SetRowColor{LightBackground} `docker ps` & lists all currently running containers \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} `docker ps -a` & lists all containers (including stopped ones) \tn % Row Count 5 (+ 3) % Row 2 \SetRowColor{LightBackground} `docker logs CONTAINER(S)` & shows the output of the given container(s) \tn % Row Count 7 (+ 2) % Row 3 \SetRowColor{white} `docker rm CONTAINER(S)` & removes a container(s) - including any local data changes \tn % Row Count 10 (+ 3) % Row 4 \SetRowColor{LightBackground} `docker rm -f CONTAINER(S)` & same as `docker rm` except also force stops a container(s) \tn % Row Count 13 (+ 3) % Row 5 \SetRowColor{white} `docker start CONTAINER(S)` & attempts to start a stopped container(s) \tn % Row Count 15 (+ 2) % Row 6 \SetRowColor{LightBackground} `docker stop CONTAINER(S)` & attempts to stop a running container(s) \tn % Row Count 17 (+ 2) % Row 7 \SetRowColor{white} `docker restart CONTAINER(S)` & stops and then starts the specified container(s) \tn % Row Count 20 (+ 3) % Row 8 \SetRowColor{LightBackground} `docker cp SRC DEST` & copies files to/from a specific container to a local location\{\{nl\}\}container location format: \seqsplit{`CONTAINER:PATH\_ON\_CONTAINER`} \tn % Row Count 26 (+ 6) % Row 9 \SetRowColor{white} `docker exec -it CONTAINER bash` & starts a bash terminal session in the CONTAINER specified \tn % Row Count 29 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Aliases}} \tn % Row 0 \SetRowColor{LightBackground} `docker\_build` & `docker\_compose` followed by a `docker\_build\_js` \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} `docker\_build\_js` & builds front-end components using `yarn run compile` \tn % Row Count 6 (+ 3) % Row 2 \SetRowColor{LightBackground} `docker\_compose` & installs dependencies as defined in `composer.lock` - does not update \tn % Row Count 10 (+ 4) % Row 3 \SetRowColor{white} `docker\_start` & runs all containers as defined in \seqsplit{`docker-compose.yml`} with the default command as defined by the image \tn % Row Count 16 (+ 6) % Row 4 \SetRowColor{LightBackground} `dockerize` & logs in to aws in order to pull new images \tn % Row Count 19 (+ 3) % Row 5 \SetRowColor{white} `src\_sync` & copies source code into all running containers and makes sure container source is up to date \tn % Row Count 24 (+ 5) % Row 6 \SetRowColor{LightBackground} \seqsplit{`docker\_cache\_clear`} & runs `CacheClearCommand` in order to remove cached assets \tn % Row Count 27 (+ 3) % Row 7 \SetRowColor{white} \seqsplit{`docker\_cache\_force\_clear`} & `rm -rf app/cache` \tn % Row Count 29 (+ 2) % Row 8 \SetRowColor{LightBackground} \seqsplit{`docker\_run\_single\_test} \seqsplit{TEST\_FILE\_LOCATION`} & runs a single phpUnit test file \tn % Row Count 32 (+ 3) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Aliases (cont)}} \tn % Row 9 \SetRowColor{LightBackground} `cmd` & starts a new container using the scriptbox image and starts an interactive bash session \tn % Row Count 5 (+ 5) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{2.16 cm} x{5.84 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Terms}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{Image}} & A snapshot of a lightweight filesystem in order to run specific tasks \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} {\bf{Container}} & An instantiation of an environment created from a specific image \tn % Row Count 6 (+ 3) % Row 2 \SetRowColor{LightBackground} {\bf{Filecabinet}} & A file mount that is shared across all containers \tn % Row Count 8 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Troubleshooting}} \tn % Row 0 \SetRowColor{LightBackground} `docker ps -a` & use to see which containers are not starting if linking errors occur \tn % Row Count 4 (+ 4) % Row 1 \SetRowColor{white} `docker logs CONTAINER` & use to see specific logs and errors for a container to trouble shoot bad exit codes \tn % Row Count 9 (+ 5) % Row 2 \SetRowColor{LightBackground} `src\_sync` & use if logs reveal that files cannot be found \tn % Row Count 12 (+ 3) % Row 3 \SetRowColor{white} \seqsplit{`docker\_build/build\_js/compose`} & use if \seqsplit{parameters/dependencies} seem to be incorrect \tn % Row Count 15 (+ 3) % Row 4 \SetRowColor{LightBackground} `docker rm CONTAINER` & use if a file is corrupt in a container\{\{nl\}\}NOTE: DO NOT REMOVE `*\_data` CONTAINERS AS THEY WILL TAKE A LONG TIME TO DOWNLOAD \tn % Row Count 22 (+ 7) % Row 5 \SetRowColor{white} \seqsplit{`docker\_cache\_clear/docker\_cache\_force\_clear`} & use if annotations or other cached assets seem to be corrupt/not updating \tn % Row Count 26 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{2.32 cm} x{5.68 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Docker ps columns}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{NAMES}} & Interchangeable with `CONTAINER ID` - used to reference a specific container \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} {\bf{CONTAINER ID}} & Interchangeable with `NAMES` - used to reference a specific container \tn % Row Count 6 (+ 3) % Row 2 \SetRowColor{LightBackground} {\bf{IMAGE}} & Image that the container environment is running on \tn % Row Count 8 (+ 2) % Row 3 \SetRowColor{white} {\bf{COMMAND}} & Command(s) that the container is runs when started \tn % Row Count 10 (+ 2) % Row 4 \SetRowColor{LightBackground} {\bf{CREATED}} & Date when container was first created \tn % Row Count 12 (+ 2) % Row 5 \SetRowColor{white} {\bf{STATUS}} & Current status of container - will also display exit codes \tn % Row Count 15 (+ 3) % Row 6 \SetRowColor{LightBackground} {\bf{PORTS}} & Displays external -\textgreater{} internal port mapping and protocal \tn % Row Count 17 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{xdebug - docker native}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{`sudo ifconfig lo0 alias 10.254.254.254`} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`docker exec -it webserver bash`} \tn % Row Count 2 (+ 1) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{`vi /etc/php.d/xdebug.ini`} \tn % Row Count 3 (+ 1) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{press `i` to be able to edit, arrows to navigate} \tn % Row Count 4 (+ 1) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{set \seqsplit{`xdebug.remote\_connect\_back=0`}} \tn % Row Count 5 (+ 1) % Row 5 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{set \seqsplit{`xdebug.remote\_host=10.254.254.254`}} \tn % Row Count 6 (+ 1) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{set \seqsplit{`xdebug.remote\_autostart=1`}} \tn % Row Count 7 (+ 1) % Row 7 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{to save and quit from vi:} \tn % Row Count 8 (+ 1) % Row 8 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{press `esc`} \tn % Row Count 9 (+ 1) % Row 9 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{type `:wq`} \tn % Row Count 10 (+ 1) % Row 10 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{press `enter`} \tn % Row Count 11 (+ 1) % Row 11 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`exit` to get out of the container} \tn % Row Count 12 (+ 1) % Row 12 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{run `docker restart webserver` in order to have the new config values take place} \tn % Row Count 14 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}