\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{Sam15} \pdfinfo{ /Title (kubectl.pdf) /Creator (Cheatography) /Author (Sam15) /Subject (Kubectl 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}{2C0735} \definecolor{LightBackground}{HTML}{F8F7F8} \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{Kubectl Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{Sam15} via \textcolor{DarkBackground}{\uline{cheatography.com/127983/cs/24960/}}} \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}Sam15 \\ \uline{cheatography.com/sam15} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 26th October, 2020.\\ Updated 26th October, 2020.\\ 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*}{4} \begin{tabularx}{3.833cm}{x{1.7165 cm} x{1.7165 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{3.833cm}}{\bf\textcolor{white}{Viewing and Finding Resources}} \tn % Row 0 \SetRowColor{LightBackground} List all namespaces in the cluster & kubectl get namespaces \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} List all services in the namespace & kubectl get services \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} List all pods in all namespaces & kubectl get pods -{}-all-namespaces \tn % Row Count 6 (+ 2) % Row 3 \SetRowColor{white} List all pods in the namespace, with more details & kubectl get pods -o wide \tn % Row Count 9 (+ 3) % Row 4 \SetRowColor{LightBackground} List a particular deployment & kubectl get deployment my-dep \tn % Row Count 11 (+ 2) % Row 5 \SetRowColor{white} List all pods in the namespace & kubectl get pods \tn % Row Count 13 (+ 2) % Row 6 \SetRowColor{LightBackground} Get a pod's YAML & kubectl get pod my-pod -o yaml \tn % Row Count 15 (+ 2) % Row 7 \SetRowColor{white} List Services Sorted by Name & kubectl get services -{}-sort-by=.metadata.name \tn % Row Count 18 (+ 3) % Row 8 \SetRowColor{LightBackground} Get all running pods in the namespace & kubectl get pods -{}-field-selector=status.phase=Running \tn % Row Count 21 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{3.833cm}{x{1.7165 cm} x{1.7165 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{3.833cm}}{\bf\textcolor{white}{Creating Objects}} \tn % Row 0 \SetRowColor{LightBackground} Create resource(s) & kubectl apply -f ./my-manifest.yaml \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} Create resource(s) in all manifest files in dir & kubectl apply -f ./dir \tn % Row Count 5 (+ 3) % Row 2 \SetRowColor{LightBackground} Create resource(s) from URL & kubectl apply -f \seqsplit{https://git.io/vPieo} \tn % Row Count 7 (+ 2) % Row 3 \SetRowColor{white} Start a single instance of nginx & kubectl create deployment nginx -{}-image=nginx \tn % Row Count 10 (+ 3) % Row 4 \SetRowColor{LightBackground} Get the documentation for pod manifests & kubectl explain pods \tn % Row Count 12 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{3.833cm}{x{1.0299 cm} x{2.4031 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{3.833cm}}{\bf\textcolor{white}{Modifying and Deleting Resources}} \tn % Row 0 \SetRowColor{LightBackground} Add a label & kubectl label pods my-pod new-label=awesome \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} Add an annotation & kubectl annotate pods my-pod \seqsplit{icon-url=http://goo.gl/XXBTWq} \tn % Row Count 5 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{3.833cm}{x{1.75083 cm} x{1.68217 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{3.833cm}}{\bf\textcolor{white}{Interacting with Running Pods}} \tn % Row 0 \SetRowColor{LightBackground} Dump pod logs (stdout) & kubectl logs my-pod \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} Dump pod logs, with label name=myLabel (stdout) & kubectl logs -l name=myLabel \tn % Row Count 5 (+ 3) % Row 2 \SetRowColor{LightBackground} Dump pod logs (stdout) for a previous instantiation of a container & kubectl logs my-pod -{}-previous \tn % Row Count 9 (+ 4) % Row 3 \SetRowColor{white} Dump pod container logs (stdout, multi-container case) & kubectl logs my-pod -c my-container \tn % Row Count 12 (+ 3) % Row 4 \SetRowColor{LightBackground} Stream pod logs (stdout) & kubectl logs -f my-pod \tn % Row Count 14 (+ 2) % Row 5 \SetRowColor{white} Stream pod container logs (stdout, multi-container case) & kubectl logs -f my-pod -c my-container \tn % Row Count 17 (+ 3) % Row 6 \SetRowColor{LightBackground} Run command in existing pod (1 container case) & kubectl exec my-pod -{}- ls / \tn % Row Count 20 (+ 3) % Row 7 \SetRowColor{white} Show metrics for a given pod and its containers & kubectl top pod POD\_NAME -{}-containers \tn % Row Count 23 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{3.833cm}{x{1.88815 cm} x{1.54485 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{3.833cm}}{\bf\textcolor{white}{Formatting Output}} \tn % Row 0 \SetRowColor{LightBackground} Print a table using a comma separated list of custom columns & -o=custom-columns=\textless{}spec\textgreater{} \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} Print a table using the custom columns template in the \textless{}filename\textgreater{} file & -o=custom-columns-file=\textless{}filename\textgreater{} \tn % Row Count 7 (+ 4) % Row 2 \SetRowColor{LightBackground} Print only the resource name and nothing else & -o=name \tn % Row Count 10 (+ 3) % Row 3 \SetRowColor{white} Print the fields defined in a jsonpath expression & -o=jsonpath=\textless{}template\textgreater{} \tn % Row Count 13 (+ 3) % Row 4 \SetRowColor{LightBackground} Print the fields defined by the jsonpath expression in the \textless{}filename\textgreater{} file & -o=jsonpath-file=\textless{}filename\textgreater{} \tn % Row Count 17 (+ 4) % Row 5 \SetRowColor{white} Output a YAML formatted API object & -o=yaml \tn % Row Count 19 (+ 2) % Row 6 \SetRowColor{LightBackground} Output in the plain-text format with any additional information, and for pods, the node name is included & -o=wide \tn % Row Count 24 (+ 5) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}