commit d800e16c9fa249847d98419fafc986ebd5a16ff5
parent 1de49aa2d9e6f23408af04e5a8dea6485cf60500
Author: MTRNord <mtrnord1@gmail.com>
Date: Sat, 9 Nov 2024 00:36:10 +0100
Add some placeholder text and fix the figure placement
Diffstat:
| M | root.tex | | | 239 | ++++++++++++++++++++++++++++++++++++++++--------------------------------------- |
1 file changed, 120 insertions(+), 119 deletions(-)
diff --git a/root.tex b/root.tex
@@ -1,10 +1,11 @@
-% arara: lualatex: { shell: yes, synctex: yes }
+% arara: lualatex: { shell: yes }
% arara: biber
% arara: makeglossaries if found('aux', '@istfilename')
-% arara: lualatex: { shell: yes, synctex: yes }
-% arara: lualatex: { shell: yes, synctex: yes }
-\documentclass[english]{scrbook}
+% arara: lualatex: { shell: yes}
+% arara: lualatex: { shell: yes }
+\documentclass[english,10pt]{scrbook}
\input{style.sty}
+\usepackage{lipsum}
\addbibresource{bibliography.bib}
@@ -90,6 +91,7 @@ This is the default name you get in the official template.}:
.4 test-connection.yaml.
.2 values.yaml.
}
+\clearpage
\section{The \enquote{Chart.yaml}}
This is the file defining the metadata of the Helm Chart.
@@ -97,9 +99,7 @@ Important fields are the name, description, type, version and appVersion fields.
Most of these are self-explanatory.
Below the special fields will be explained.
-\begin{figure}[!hp]
-\centering
-\begin{singlespace}
+\begin{figure}[h]
\begin{minted}[numbers=left, frame=lines,breaklines,breakanywhere,samepage=false]{yaml}
apiVersion: v2
name: matrix-neoboard-widget
@@ -109,15 +109,16 @@ version: 0.1.0
appVersion: "0.0.0"
home: https://github.com/nordeck/matrix-neoboard
\end{minted}
-\end{singlespace}
\caption{A simple application Chart.yaml}\label{code:Chart.yaml}
\end{figure}
-
-\subsection{The \emph{appVersion} field}
+\clearpage
+\subsection{The \emph{appVersion} field}
+\lipsum[2-4]
\subsection{The \emph{maintainers} field}
+\lipsum[2-4]
\subsection{Other available fields}
-
+\lipsum[2-4]
\section{The \enquote{values.yaml}}
@@ -126,9 +127,7 @@ home: https://github.com/nordeck/matrix-neoboard
The core of every application in Kubernetes is the image used for deploying it.
This is being done in the \enquote{image} section of the \gls{values}.
-\begin{figure}[!hp]
-\centering
-\begin{singlespace}
+\begin{figure}[h]
\begin{minted}[numbers=left, frame=lines,breaklines,breakanywhere,samepage=false]{yaml}
# This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/
image:
@@ -140,7 +139,6 @@ image:
# This is for the secretes for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
imagePullSecrets: []
\end{minted}
-\end{singlespace}
\caption{The \enquote{image} section of the \gls{values}}\label{code:image_section}
\end{figure}
@@ -153,12 +151,11 @@ Things to note here are the 3 fields it should contain:
\end{enumerate}
Additionally there is the \enquote{imagePullSecrets} field which allows you to pull from private repositories. For more information on this take a look at \url{https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/}
+\clearpage
\subsection{Service Account}
-\begin{figure}[!hp]
-\centering
-\begin{singlespace}
+\begin{figure}[h]
\begin{minted}[numbers=left, frame=lines,breaklines,breakanywhere,samepage=false]{yaml}
#This section builds out the service account more information can be found here: https://kubernetes.io/docs/concepts/security/service-accounts/
serviceAccount:
@@ -172,19 +169,18 @@ serviceAccount:
# If not set and create is true, a name is generated using the fullname template
name: ""
\end{minted}
-\end{singlespace}
\caption{The \enquote{serviceAccount} section of the \gls{values}}\label{code:service_account_section}
\end{figure}
Service Accounts are required for accessing the resources of the \gls{k8s} Cluster itself.
They are scoped accounts to the cluster and require most likely more setup in the templates to actually be useful.
They are commonly used by operators or similar things which listen to or write to resources in the cluster.
+\clearpage
-\subsection{\enquote{service} and \enquote{ingress}}
+\subsection{Service and Ingress}
+\lipsum[2-4]
-\begin{figure}[!hp]
-\centering
-\begin{singlespace}
+\begin{figure}[h]
\begin{minted}[numbers=left, frame=lines,breaklines,breakanywhere,samepage=false]{yaml}
service:
# This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
@@ -209,86 +205,86 @@ ingress:
# hosts:
# - chart-example.local
\end{minted}
-\end{singlespace}
\caption{The \enquote{service} section and the \enquote{ingress} section of the \gls{values}}\label{code:service_and_ingress_section}
\end{figure}
+\clearpage
+
+\subsection{Volumes}
+\lipsum[2-4]
-\begingroup
-\centering
-\label{figure:values.yaml}
-\begin{singlespace}
+\begin{figure}[h]
\begin{minted}[numbers=left, frame=lines,breaklines,breakanywhere,samepage=false]{yaml}
-# This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/
-replicaCount: 1
+# Additional volumes on the output Deployment definition.
+volumes: []
+# - name: foo
+# secret:
+# secretName: mysecret
+# optional: false
+# Additional volumeMounts on the output Deployment definition.
-# This is to override the chart name.
-nameOverride: ""
-fullnameOverride: ""
+volumeMounts: []
+# - name: foo
+# mountPath: "/etc/foo"
+# readOnly: true
+\end{minted}
+\caption{The \enquote{volumes} section and the \enquote{volumeMounts} section of the \gls{values}}\label{code:volumes_section}
+\end{figure}
+\clearpage
-# This is for setting Kubernetes Annotations to a Pod.
-# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
-podAnnotations: {}
-# This is for setting Kubernetes Labels to a Pod.
-# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
-podLabels: {}
+\subsection{Security Contexts}
+\lipsum[2-4]
+\begin{figure}[h]
+\begin{minted}[numbers=left, frame=lines,breaklines,breakanywhere,samepage=false]{yaml}
podSecurityContext: {}
- # fsGroup: 2000
-
+# fsGroup: 2000
+
securityContext: {}
- # capabilities:
- # drop:
- # - ALL
- # readOnlyRootFilesystem: true
- # runAsNonRoot: true
- # runAsUser: 1000
- # This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/
-
-service:
- # This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
- type: ClusterIP
- # This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports
- port: 80
-
-# This block is for setting up the ingress for more information can be found here: https://kubernetes.io/docs/concepts/services-networking/ingress/
-ingress:
- enabled: false
- className: ""
- annotations: {}
- # kubernetes.io/ingress.class: nginx
- # kubernetes.io/tls-acme: "true"
- hosts:
- - host: chart-example.local
- paths:
- - path: /
- pathType: ImplementationSpecific
- tls: []
- # - secretName: chart-example-tls
- # hosts:
- # - chart-example.local
-
+# capabilities:
+# drop:
+# - ALL
+# readOnlyRootFilesystem: true
+# runAsNonRoot: true
+# runAsUser: 1000
+# This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/
+\end{minted}
+\caption{The security context sections of the \gls{values}}\label{code:security_section}
+\end{figure}
+\clearpage
+
+\subsection{Resources}
+\lipsum[2-4]
+
+\begin{figure}[h]
+\begin{minted}[numbers=left, frame=lines,breaklines,breakanywhere,samepage=false]{yaml}
resources: {}
- # We usually recommend not to specify default resources and to leave this as a conscious
- # choice for the user. This also increases chances charts run on environments with little
- # resources, such as Minikube. If you do want to specify resources, uncomment the following
- # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
- # limits:
- # cpu: 100m
- # memory: 128Mi
- # requests:
- # cpu: 100m
- # memory: 128Mi
-
-# This is to setup the liveness and readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
-livenessProbe:
- httpGet:
- path: /
- port: http
-readinessProbe:
- httpGet:
- path: /
- port: http
-
+# We usually recommend not to specify default resources and to leave this as a conscious
+# choice for the user. This also increases chances charts run on environments with little
+# resources, such as Minikube. If you do want to specify resources, uncomment the following
+# lines, adjust them as necessary, and remove the curly braces after 'resources:'.
+# limits:
+# cpu: 100m
+# memory: 128Mi
+# requests:
+# cpu: 100m
+# memory: 128Mi
+\end{minted}
+\caption{The \enquote{resources} section of the \gls{values}}\label{code:resources_section}
+\end{figure}
+\clearpage
+
+\subsection{Probes}
+
+TODO: Explain why it probably makes no sense to keep in values.yaml
+
+\lipsum[2-4]
+\clearpage
+
+\subsection{Autoscaling}
+\lipsum[2-4]
+
+\begin{figure}[h]
+\begin{minted}[numbers=left, frame=lines,breaklines,breakanywhere,samepage=false]{yaml}
#This section is for setting up autoscaling more information can be found here: https://kubernetes.io/docs/concepts/workloads/autoscaling/
autoscaling:
enabled: false
@@ -296,19 +292,29 @@ autoscaling:
maxReplicas: 100
targetCPUUtilizationPercentage: 80
# targetMemoryUtilizationPercentage: 80
-
-# Additional volumes on the output Deployment definition.
-volumes: []
-# - name: foo
-# secret:
-# secretName: mysecret
-# optional: false
-# Additional volumeMounts on the output Deployment definition.
+\end{minted}
+\caption{The \enquote{autoscaling} section of the \gls{values}}\label{code:autoscaling_section}
+\end{figure}
+\clearpage
-volumeMounts: []
-# - name: foo
-# mountPath: "/etc/foo"
-# readOnly: true
+\subsection{Misc}
+\lipsum[2-4]
+
+\begin{figure}[h]
+\begin{minted}[numbers=left, frame=lines,breaklines,breakanywhere,samepage=false]{yaml}
+# This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/
+replicaCount: 1
+
+# This is to override the chart name.
+nameOverride: ""
+fullnameOverride: ""
+
+# This is for setting Kubernetes Annotations to a Pod.
+# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
+podAnnotations: {}
+# This is for setting Kubernetes Labels to a Pod.
+# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
+podLabels: {}
nodeSelector: {}
@@ -316,26 +322,21 @@ tolerations: []
affinity: {}
\end{minted}
-\end{singlespace}
-\captionof{figure}{A simple application values.yaml}\label{code:values.yaml}
-\endgroup
+\caption{Values which affect the pods or the deployment but are not in a specific group of things}\label{code:misc_values}
+\end{figure}
+\clearpage
\section{The \enquote{NOTES.txt}}
-\begin{figure}[!hp]
-\centering
-\begin{singlespace}
+\lipsum[2-4]
+
+\begin{figure}[h]
\begin{minted}[numbers=left, frame=lines,breaklines,breakanywhere,samepage=false]{text}
-apiVersion: v2
-name: matrix-neoboard-widget
-description: A whiteboard widget for the Element messenger
-type: application
-version: 0.1.0
-appVersion: "0.0.0"
-home: https://github.com/nordeck/matrix-neoboard
+TODO
\end{minted}
-\end{singlespace}
\caption{A simple NOTES.txt}\label{code:NOTES.txt}
\end{figure}
+\clearpage
+
%%%%%%%%%%%%%%%%%%%%%%%%
\cleardoublepage
\appendix
