From 973112009bf13f1db57ecd35c02e0790ecd0951b Mon Sep 17 00:00:00 2001 From: Manuel Plonski Date: Sat, 21 Mar 2020 10:52:55 +0100 Subject: [PATCH] doku --- pandoc/DemoDoku.html | 256 +++++++++++++++++++++++++++++++++++++++++++ pandoc/doku.tex | 32 +++--- thesis.tex | 3 +- 3 files changed, 271 insertions(+), 20 deletions(-) create mode 100644 pandoc/DemoDoku.html diff --git a/pandoc/DemoDoku.html b/pandoc/DemoDoku.html new file mode 100644 index 0000000..af1baee --- /dev/null +++ b/pandoc/DemoDoku.html @@ -0,0 +1,256 @@ + + + + + + + DemoDoku + + + + +

CI/CD Dokumentation

+

Dies ist die Dokumentation für die CI/CD Pipeline von dem

+

Was wird Automatisiert ?

+

Durch das CI/CD System werden Folgende Prozesse Automatisiert durchgeführt :

+ +

Welche Komponenten/Tools werden verwendet

+

Folgende Komponenten/Tools werden im CI/CD Prozess verwendet:

+ +

CI/CD Engine: Serverless Jenkins X

+

CI/CD In-,Outputs

+

Trigger

+

Jenkins X erhält verschiedene Inputs,Trigger und Signale durch einen Webhook-Server namens Lighthouse. An ihn werden Eventbenachichtigungen durch GitLab gesendet um anschließend ein CI-Run zu starten.

+

Dabei wird ein CI-Run durch folgende Trigger und Konditionen gestartet:

+ +

Inputs und Kontexte Daten

+

Diese Daten fliesen und beeinflussen den CI-Build:

+ +

Es existieren zwei verschiedene Pipelines die durch die Trigger ausgelöst werden können:

+ +

Release

+

Diese Pipeline kompeliert, testet, analysiert, verpackt und bereitet die Software zum Deployment vor.

+

Sie deployed jedoch die Anwendung nicht, sondern erstellt/modifiziert lediglich verschiedene Umgebungskonfigurationen, bei denen das automatische Deployment vorgesehen ist.

+

Trigger: Push oder Merge auf den master Branch.

+

Stage: Setup (Buildpack Maven)

+

In dieser Stage wird der Buildprozess vorbereitet und eingeleitet.

+

Befehle:

+ +

Stage: Build (Buildpack Maven)

+

In dieser Stage werden alle zum Build dazugehörigen komponenten und Tools ausgeführt. Bei einigen befehlen werden mehrere Tools und Komponenten gleichzeitig ausgeführt um den Buildprozess erfolgreich abzuschließen.

+

Befehle:

+ +

Stage: Promote (Buildpack Maven)

+

In dieser Stage werden die erzeugten Artefakte in die zugehörigen Artefaktarchivierungssysteme hochgeladen und die verschiedenen Umgebungskonfigurationen modifiziert um den CD-Prozess zu starten.

+

Befehle:

+ +

Preview

+

Diese Pipeline kompeliert, testet, analysiert, verpackt und bereitet die Software zum deployment in eine temporäre Previewenvirgonment.

+

Diese Pipeline ist nicht zum Bau einer Realease Version gedacht und bereitet die Software nur für ein themporäres Preview vor.

+

Trigger: Push oder Merge auf einen Branch, der Quelle eines offenen Merge-Request ist.

+

Stage: Build (Buildpack Maven)

+

In dieser Stage werden alle zum Build dazugehörigen komponenten und Tools ausgeführt. Bei einigen befehlen werden mehrere Tools und Komponenten gleichzeitig ausgeführt um den Buildprozess erfolgreich abzuschließen.

+

Befehle:

+ +

Stage: Promote (Buildpack Maven)

+

In dieser Stage werden die erzeugten Artefakte in die zugehörigen Artefaktarchivierungssysteme hochgeladen und eine temporäre Previewumgebung erstellt um die Anwendung kurzzeitig zu testen.

+

Befehle:

+ + + diff --git a/pandoc/doku.tex b/pandoc/doku.tex index 925f92a..6d27152 100644 --- a/pandoc/doku.tex +++ b/pandoc/doku.tex @@ -2,7 +2,6 @@ \newcommand{\VERB}{\Verb[commandchars=\\\{\}]} \DefineVerbatimEnvironment{Highlighting}{Verbatim}{commandchars=\\\{\}} % Add ',fontsize=\small' for more characters per line -\newenvironment{Shaded}{}{} \newcommand{\AlertTok}[1]{\textcolor[rgb]{1.00,0.00,0.00}{\textbf{#1}}} \newcommand{\AnnotationTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}} \newcommand{\AttributeTok}[1]{\textcolor[rgb]{0.49,0.56,0.16}{#1}} @@ -37,17 +36,18 @@ \setlength{\emergencystretch}{3em} % prevent overfull lines \providecommand{\tightlist}{% \setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}} -\setcounter{secnumdepth}{-\maxdimen} % remove section numbering +%\setcounter{secnumdepth}{-\maxdimen} % remove section numbering \hypertarget{cicd-dokumentation}{% +\chapter{CI/CD Dokumentation} \section{CI/CD Dokumentation}\label{cicd-dokumentation}} -Dies ist die Dokumentation für die CI/CD Pipeline von dem +Dies ist die Dokumentation für die CI/CD Pipeline von dem \textit{} \hypertarget{was-wird-automatisiert}{% \subsection{Was wird Automatisiert ?}\label{was-wird-automatisiert}} -Durch das CI/CD System werden Folgende Prozesse Automatisiert +Durch das CI/CD System werden folgende Prozesse Automatisiert durchgeführt : \begin{itemize} @@ -86,7 +86,7 @@ durchgeführt : Analyse des Modul-Test Ergebnisses \end{itemize} \item - \textbf{Package}: Cloudgerechte Verpackung des Software + \textbf{Package}: Cloudgerechtes packaging der Software \begin{itemize} \tightlist @@ -139,13 +139,7 @@ Folgende Komponenten/Tools werden im CI/CD Prozess verwendet: \begin{itemize} \tightlist \item - Static Code Analysis - - \begin{itemize} - \tightlist - \item - SonarQube 7 - \end{itemize} + SonarQube 7 \end{itemize} \item \textbf{Package} @@ -172,12 +166,12 @@ Folgende Komponenten/Tools werden im CI/CD Prozess verwendet: \textbf{CI/CD Engine}: Serverless Jenkins X \hypertarget{cicd-in-outputs}{% -\section{CI/CD In-,Outputs}\label{cicd-in-outputs}} - +\section{CI/CD In-/Outputs}\label{cicd-in-outputs}} +Hier werden die verschiedenen Parameter aufgelistet, die die CI/CD Pipeline beeinflussen könnten. \hypertarget{trigger}{% \subsection{Trigger}\label{trigger}} -Jenkins X erhält verschiedene Inputs,Trigger und Signale durch einen +Jenkins X erhält verschiedene Inputs, Trigger und Signale durch einen Webhook-Server namens \emph{Lighthouse}. An ihn werden Eventbenachichtigungen durch GitLab gesendet um anschließend ein \textbf{CI-Run} zu starten. @@ -321,7 +315,7 @@ abzuschließen. \item Sonarqube Analyse (Custom addition) -\begin{Shaded} + \begin{Highlighting}[] \ExtensionTok{mvn}\NormalTok{ {-}{-}batch{-}mode sonar:sonar \textbackslash{}} \NormalTok{ {-}Dsonar.projectKey=}\OperatorTok{\textless{}}\NormalTok{sonarqube projekt key}\OperatorTok{\textgreater{}}\NormalTok{ \textbackslash{}} @@ -333,7 +327,7 @@ abzuschließen. \NormalTok{ {-}Dsonar.branch.name=}\VariableTok{$BRANCH\_NAME}\NormalTok{ \textbackslash{}} \NormalTok{ {-}Dsonar.gitlab.user\_token=}\OperatorTok{\textless{}}\NormalTok{gitlab access toekn}\OperatorTok{\textgreater{}}\NormalTok{\textbackslash{}} \end{Highlighting} -\end{Shaded} + Analysiert Projekt mit Hilfe von SonarQube und bricht die Pipeline ab wenn Qualitätsprobleme gefunden wurden. @@ -433,7 +427,7 @@ abzuschließen. \item Sonarqube Analyse (Custom addition) -\begin{Shaded} + \begin{Highlighting}[] \ExtensionTok{mvn}\NormalTok{ {-}{-}batch{-}mode sonar:sonar \textbackslash{}} \NormalTok{ {-}Dsonar.projectKey=}\OperatorTok{\textless{}}\NormalTok{sonarqube projekt key}\OperatorTok{\textgreater{}}\NormalTok{ \textbackslash{}} @@ -445,7 +439,7 @@ abzuschließen. \NormalTok{ {-}Dsonar.branch.name=}\VariableTok{$BRANCH\_NAME}\NormalTok{ \textbackslash{}} \NormalTok{ {-}Dsonar.gitlab.user\_token=}\OperatorTok{\textless{}}\NormalTok{gitlab access toekn}\OperatorTok{\textgreater{}}\NormalTok{\textbackslash{}} \end{Highlighting} -\end{Shaded} + Analysiert Projekt mit Hilfe von SonarQube. \end{itemize} diff --git a/thesis.tex b/thesis.tex index f846d4e..e791ac1 100644 --- a/thesis.tex +++ b/thesis.tex @@ -121,7 +121,8 @@ \cleardoublepage \part{Appendix} \include{chapters/experience} -%\include{pandoc/doku} + +\cleardoublepage\include{pandoc/doku} %\include{chapters/examples/appendix01} %\include{chapters/examples/appendix02} %*************************************************************************