diff --git a/public/404.html b/public/404.html
index 44a83e52127047b4c7faabfc51d51aab5581219f..506ee230d75e936db3e3bcd8d7ddd5d15c776c42 100644
--- a/public/404.html
+++ b/public/404.html
@@ -252,6 +252,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/ch2-discover-github-actions-tp/" class="md-nav__link">
+ TP part 02 - Github Actions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -300,6 +314,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/ch2-discover-github-actions-td/" class="md-nav__link">
+ TD part 02 - Github Actions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
diff --git a/public/ch1-discover-docker-td/index.html b/public/ch1-discover-docker-td/index.html
index 8598a3cd71886ee7c89ca155e73033eee32ed7e8..8b1bd393781ceb133983932b3250b5cb471159d4 100644
--- a/public/ch1-discover-docker-td/index.html
+++ b/public/ch1-discover-docker-td/index.html
@@ -259,6 +259,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../ch2-discover-github-actions-tp/" class="md-nav__link">
+ TP part 02 - Github Actions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -481,6 +495,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../ch2-discover-github-actions-td/" class="md-nav__link">
+ TD part 02 - Github Actions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1105,7 +1133,7 @@ Head over to <a href="http://localhost:8888" target="_blank">http://localhost:88
<nav class="md-footer__inner md-grid" aria-label="Footer">
- <a href="../ch1-discover-docker-tp/" class="md-footer__link md-footer__link--prev" aria-label="Previous: TP part 01 - Docker" rel="prev">
+ <a href="../ch2-discover-github-actions-tp/" class="md-footer__link md-footer__link--prev" aria-label="Previous: TP part 02 - Github Actions" rel="prev">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</div>
@@ -1114,12 +1142,27 @@ Head over to <a href="http://localhost:8888" target="_blank">http://localhost:88
<span class="md-footer__direction">
Previous
</span>
- TP part 01 - Docker
+ TP part 02 - Github Actions
</div>
</div>
</a>
+
+ <a href="../ch2-discover-github-actions-td/" class="md-footer__link md-footer__link--next" aria-label="Next: TD part 02 - Github Actions" rel="next">
+ <div class="md-footer__title">
+ <div class="md-ellipsis">
+ <span class="md-footer__direction">
+ Next
+ </span>
+ TD part 02 - Github Actions
+ </div>
+ </div>
+ <div class="md-footer__button md-icon">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg>
+ </div>
+ </a>
+
</nav>
<div class="md-footer-meta md-typeset">
diff --git a/public/ch1-discover-docker-tp/index.html b/public/ch1-discover-docker-tp/index.html
index 9391074ed052565f41e2c8f9d3dabffff61db8b1..7dbc1d97339050226f8193287a7c3d75ccb2145f 100644
--- a/public/ch1-discover-docker-tp/index.html
+++ b/public/ch1-discover-docker-tp/index.html
@@ -478,6 +478,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../ch2-discover-github-actions-tp/" class="md-nav__link">
+ TP part 02 - Github Actions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -526,6 +540,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../ch2-discover-github-actions-td/" class="md-nav__link">
+ TD part 02 - Github Actions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1141,13 +1169,13 @@ How to access the database container from your backend application? Use the depr
- <a href="../ch1-discover-docker-td/" class="md-footer__link md-footer__link--next" aria-label="Next: TD part 01 - Docker" rel="next">
+ <a href="../ch2-discover-github-actions-tp/" class="md-footer__link md-footer__link--next" aria-label="Next: TP part 02 - Github Actions" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
- TD part 01 - Docker
+ TP part 02 - Github Actions
</div>
</div>
<div class="md-footer__button md-icon">
diff --git a/public/ch2-discover-github-actions-td/index.html b/public/ch2-discover-github-actions-td/index.html
new file mode 100644
index 0000000000000000000000000000000000000000..5700869bb2d5f47a6c20295caca9368a78f806a4
--- /dev/null
+++ b/public/ch2-discover-github-actions-td/index.html
@@ -0,0 +1,683 @@
+
+<!doctype html>
+<html lang="en" class="no-js">
+ <head>
+
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+
+
+
+ <link rel="icon" href="../assets/images/favicon.png">
+ <meta name="generator" content="mkdocs-1.3.0, mkdocs-material-8.2.15">
+
+
+
+ <title>TD part 02 - Github Actions - Devops</title>
+
+
+
+ <link rel="stylesheet" href="../assets/stylesheets/main.c382b1dc.min.css">
+
+
+ <link rel="stylesheet" href="../assets/stylesheets/palette.cc9b2e1e.min.css">
+
+
+
+ <meta name="theme-color" content="#e92063">
+
+
+
+
+
+
+
+
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
+ <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
+
+
+
+ <script>__md_scope=new URL("..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+
+
+
+
+
+ </head>
+
+
+
+
+
+
+
+ <body dir="ltr" data-md-color-scheme="" data-md-color-primary="pink" data-md-color-accent="">
+
+
+
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+ <label class="md-overlay" for="__drawer"></label>
+ <div data-md-component="skip">
+
+
+ <a href="#discover-github" class="md-skip">
+ Skip to content
+ </a>
+
+ </div>
+ <div data-md-component="announce">
+
+ </div>
+
+
+
+
+<header class="md-header" data-md-component="header">
+ <nav class="md-header__inner md-grid" aria-label="Header">
+ <a href=".." title="Devops" class="md-header__button md-logo" aria-label="Devops" data-md-component="logo">
+
+ <img src="../assets/logo.png" alt="logo">
+
+ </a>
+ <label class="md-header__button md-icon" for="__drawer">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
+ </label>
+ <div class="md-header__title" data-md-component="header-title">
+ <div class="md-header__ellipsis">
+ <div class="md-header__topic">
+ <span class="md-ellipsis">
+ Devops
+ </span>
+ </div>
+ <div class="md-header__topic" data-md-component="header-topic">
+ <span class="md-ellipsis">
+
+ TD part 02 - Github Actions
+
+ </span>
+ </div>
+ </div>
+ </div>
+
+
+
+ <label class="md-header__button md-icon" for="__search">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
+ </label>
+ <div class="md-search" data-md-component="search" role="dialog">
+ <label class="md-search__overlay" for="__search"></label>
+ <div class="md-search__inner" role="search">
+ <form class="md-search__form" name="search">
+ <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
+ <label class="md-search__icon md-icon" for="__search">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
+ </label>
+ <nav class="md-search__options" aria-label="Search">
+
+ <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
+ </button>
+ </nav>
+
+ </form>
+ <div class="md-search__output">
+ <div class="md-search__scrollwrap" data-md-scrollfix>
+ <div class="md-search-result" data-md-component="search-result">
+ <div class="md-search-result__meta">
+ Initializing search
+ </div>
+ <ol class="md-search-result__list"></ol>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ </nav>
+
+</header>
+
+ <div class="md-container" data-md-component="container">
+
+
+
+
+
+<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
+ <div class="md-tabs__inner md-grid">
+ <ul class="md-tabs__list">
+
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../ch1-discover-docker-tp/" class="md-tabs__link">
+ TP
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../ch1-discover-docker-td/" class="md-tabs__link md-tabs__link--active">
+ TD
+ </a>
+ </li>
+
+
+
+ </ul>
+ </div>
+</nav>
+
+
+
+ <main class="md-main" data-md-component="main">
+ <div class="md-main__inner md-grid">
+
+
+
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
+ <div class="md-sidebar__scrollwrap">
+ <div class="md-sidebar__inner">
+
+
+
+
+
+<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
+ <label class="md-nav__title" for="__drawer">
+ <a href=".." title="Devops" class="md-nav__button md-logo" aria-label="Devops" data-md-component="logo">
+
+ <img src="../assets/logo.png" alt="logo">
+
+ </a>
+ Devops
+ </label>
+
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" type="checkbox" id="__nav_1" >
+
+
+
+
+ <label class="md-nav__link" for="__nav_1">
+ TP
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="TP" data-md-level="1">
+ <label class="md-nav__title" for="__nav_1">
+ <span class="md-nav__icon md-icon"></span>
+ TP
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../ch1-discover-docker-tp/" class="md-nav__link">
+ TP part 01 - Docker
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../ch2-discover-github-actions-tp/" class="md-nav__link">
+ TP part 02 - Github Actions
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
+
+
+
+
+ <label class="md-nav__link" for="__nav_2">
+ TD
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="TD" data-md-level="1">
+ <label class="md-nav__title" for="__nav_2">
+ <span class="md-nav__icon md-icon"></span>
+ TD
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../ch1-discover-docker-td/" class="md-nav__link">
+ TD part 01 - Docker
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--active">
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
+
+
+
+
+
+ <label class="md-nav__link md-nav__link--active" for="__toc">
+ TD part 02 - Github Actions
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <a href="./" class="md-nav__link md-nav__link--active">
+ TD part 02 - Github Actions
+ </a>
+
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+
+
+ <label class="md-nav__title" for="__toc">
+ <span class="md-nav__icon md-icon"></span>
+ Table of contents
+ </label>
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+ <li class="md-nav__item">
+ <a href="#setup" class="md-nav__link">
+ Setup
+ </a>
+
+ <nav class="md-nav" aria-label="Setup">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#prerequisites" class="md-nav__link">
+ Prerequisites
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#sign-up-to-github" class="md-nav__link">
+ Sign up to Github
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#project-forking-and-publishing" class="md-nav__link">
+ Project forking and publishing
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#securing-github-access" class="md-nav__link">
+ Securing Github access
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#lets-publish" class="md-nav__link">
+ Let’s publish
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#configure-your-repository" class="md-nav__link">
+ Configure your repository
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#git-basic-commands" class="md-nav__link">
+ Git basic commands
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ </ul>
+
+</nav>
+
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+ </ul>
+</nav>
+ </div>
+ </div>
+ </div>
+
+
+
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
+ <div class="md-sidebar__scrollwrap">
+ <div class="md-sidebar__inner">
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+
+
+ <label class="md-nav__title" for="__toc">
+ <span class="md-nav__icon md-icon"></span>
+ Table of contents
+ </label>
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+ <li class="md-nav__item">
+ <a href="#setup" class="md-nav__link">
+ Setup
+ </a>
+
+ <nav class="md-nav" aria-label="Setup">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#prerequisites" class="md-nav__link">
+ Prerequisites
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#sign-up-to-github" class="md-nav__link">
+ Sign up to Github
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#project-forking-and-publishing" class="md-nav__link">
+ Project forking and publishing
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#securing-github-access" class="md-nav__link">
+ Securing Github access
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#lets-publish" class="md-nav__link">
+ Let’s publish
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#configure-your-repository" class="md-nav__link">
+ Configure your repository
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#git-basic-commands" class="md-nav__link">
+ Git basic commands
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ </ul>
+
+</nav>
+ </div>
+ </div>
+ </div>
+
+
+ <div class="md-content" data-md-component="content">
+ <article class="md-content__inner md-typeset">
+
+
+
+
+<h1 id="discover-github">Discover Github</h1>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Checkpoint: call us to check your results (don’t stay blocked on a checkpoint if we are busy, we can check ⅔ checkpoints at the same time) </p>
+</div>
+<div class="admonition question">
+<p class="admonition-title">Question</p>
+<p>Point to document/report </p>
+</div>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>Interesting information</p>
+</div>
+<h2 id="setup">Setup</h2>
+<h3 id="prerequisites">Prerequisites</h3>
+<p>Even if it seems pretty usual to use Git in the development world, not every project is managed with this tool. </p>
+<p>The main goal here is to have you create and set up a Github account before using it for further purposes. Git will be required as well as it is a must have. You might want to start with </p>
+<h3 id="sign-up-to-github">Sign up to Github</h3>
+<p>First step is (if not already done) to <a href="https://github.com/join" target="_blank">sign up</a> to Github with your school mail address and fill the required information. We recommend you to use an individual free plan for the next steps of this project. You can eventually fill the last page but it’s not really important. Select “Complete setup”. </p>
+<p>There you are, your (probably not first) Github account is set up. Yay ! Now, let’s move on to the next step ! </p>
+<h3 id="project-forking-and-publishing">Project forking and publishing</h3>
+<p>For this part, we are going to fork the project that will be used for the rest of the lesson (I mean, till the end of the week).</p>
+<p>Now you own the <a href="https://github.com/maximepakula/tp-devops-correction-docker" target="_blank"> project </a> under your Github workspace, you can basically do whatever you want on this project. However we recommend not to modify the whole java and maven content if you still want this project to compile. </p>
+<p>First of all, make sure the git CLI is installed on your computer and then clone the project on your computer to be able to modify it locally. </p>
+<h3 id="securing-github-access">Securing Github access</h3>
+<p>There are actually two different ways of cloning and publishing a project. By default, Github will propose you to clone by HTTPS link. Copy to clipboard, then open a new terminal and enter : </p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span><project_url_with_https><span class="w"> </span>
+</code></pre></div>
+<p>Git will probably ask you to authenticate in order to be able to clone the repository. It will ask you the same thing every time you want to publish your work on a branch. This might be painful and you don’t want to do this. </p>
+<p>The second option is “use SSH” and the link starts with “git@github.com:…”, but there is a prerequisite to use this solution, you’ll need to create an SSH key and have it added to your account. Fine, then tape: </p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>$<span class="w"> </span>ssh-keygen<span class="w"> </span>-t<span class="w"> </span>rsa<span class="w"> </span>-b<span class="w"> </span><span class="m">4096</span><span class="w"> </span>-f<span class="w"> </span>~/.ssh/<span class="o">{</span>theNameOfYourKeyPair<span class="o">}</span><span class="w"> </span>
+</code></pre></div>
+<p>It will ask you to enter and confirm a passphrase, this is for security purposes but we will let it empty for this course. Well done, you’ve generated a new RSA key pair of 4096 bits size. </p>
+<p>If you do “ls ~/.ssh” you’ll see new files inside your folder, one is named theNameOfYourKeyPair and the other one theNameOfYourKeyPair.pub.
+The first one is your private key to NEVER communicate to anyone and the second one is you public key. Let’s take a look to this last one, enter “cat ~/.ssh/theNameOfYourKeyPair.pub”: </p>
+<p><img alt="ssh-key" src="../assets/ssh-key.png" /></p>
+<p>Something like this will appear on you terminal, this is the content of your public key that you will communicate to Github. Copy the whole content and past it to you Github account under “Settings” and “SSH and GPG keys”. Click on New SSH key and paste the content
+of your public key. Give it a name and validate the operation. </p>
+<p>Now try to clone the repository again with the git@ prefix. It will ask you to select a key pair to perform the action. Take the one you’ve just indicated to Github and press enter.
+Now you are able to clone and publish work on your Github repository without entering a password every time, I hope you enjoy this. </p>
+<h3 id="lets-publish">Let’s publish</h3>
+<p>Open the project inside your favorite IDE (I hope it’s IntelliJ) and open the file README.md. Modify this file entering, for example “This project is now mine”. Save it and check that Git has correctly seen you changes </p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="w"> </span>$<span class="w"> </span>git<span class="w"> </span>status<span class="w"> </span>
+</code></pre></div>
+<p>You’ll see you file colored in red. This means that Git has seen you’ve made some modifications to this file, but it will not take them into account once you will publish them. Then ask git to add them to your work. </p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="w"> </span>$<span class="w"> </span>git<span class="w"> </span>add<span class="w"> </span>.
+</code></pre></div>
+<p>Actually, we did not ask him to add our file, but to add any modification made to any file inside our working directory. Now if you enter “git status” again you’ll see that your file is colored in green. You work will be taken into account, hopefully. Let’s commit this work: </p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>$<span class="w"> </span>git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span>“The<span class="w"> </span>message<span class="w"> </span>of<span class="w"> </span>your<span class="w"> </span>commit”<span class="w"> </span>
+</code></pre></div>
+<p>Now if you try to “git status” again you’ll see that your workspace is “clean”. Git created a new reference with all the changes you’ve made. If you go on and enter: </p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="w"> </span>$<span class="w"> </span>git<span class="w"> </span>log<span class="w"> </span>
+</code></pre></div>
+<p>You’ll see the message of you last commit on top of the references. However you cannot see the changes on the Github website because we did not publish yet our work. Let’s do it ! </p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="w"> </span>$<span class="w"> </span>git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>master<span class="w"> </span>
+</code></pre></div>
+<p>This command literally means “I want to publish my work on the distant/remote branch master”. And now you can see that your work is published online ! Big up guys ! </p>
+<h3 id="configure-your-repository">Configure your repository</h3>
+<p>Git is one of the most useful tool you’ll find in your developer life. Almost everybody uses it and most of the time you’ll have to work with other people on project using Github. </p>
+<p>However you’ll find many people that use it wrongly, and many people that will create things you don’t want to merge in you production branch. Let’s secure a bit our labor to prevent any fool to throw it away. </p>
+<p>Go back to your project on the Github webpage and click on settings. Go to Branches and you’ll see that your default branch is master. Fine, it means that every time you connect on your repository, this branch will be displayed. Just under this indication, you’ll see a Branch protection rule. Try to add one. </p>
+<p>You’ll see a bunch of options, most of them are very useful working in team (especially asking for pull request and review before merging inside master branch). You can also select options to block push force (when someone does push -f) because it doesn’t take care of Git warning messages that usually prevent you from pushing. As you are working alone on this project we will only add the name “master” to the naming pattern and let the rest as it is. It will only prevent you from doing bad things on you master branch. </p>
+<p>Finally, be aware that all the work you do on Github is public by default. Therefore you should or you must NEVER publish any password on your repository. Thankfully you can turn your repository to private from the options and there are Environment Variables that you can set and secure (I mean encrypt) inside your Github repository under Secrets. </p>
+<h3 id="git-basic-commands">Git basic commands</h3>
+<p>Clone a project</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span><url_of_the_project><span class="w"> </span>
+</code></pre></div>
+<p>Fetch distant modifications without merging them into your branch </p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>$<span class="w"> </span>git<span class="w"> </span>fetch<span class="w"> </span>-p<span class="w"> </span>
+</code></pre></div>
+<p>Fetch distant modifications and merge them into you branch </p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>$<span class="w"> </span>git<span class="w"> </span>pull<span class="w"> </span>
+</code></pre></div>
+<p>Add your changes to the workspace </p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>$<span class="w"> </span>git<span class="w"> </span>add<span class="w"> </span>.
+</code></pre></div>
+<p>Commit your changes </p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>$<span class="w"> </span>git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span>“Your<span class="w"> </span>message”<span class="w"> </span>
+</code></pre></div>
+<p>Publish your changes </p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>$<span class="w"> </span>git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span><name_of_the_remote_branch><span class="w"> </span>
+</code></pre></div>
+
+
+ </article>
+ </div>
+ </div>
+
+ </main>
+
+ <footer class="md-footer">
+
+ <nav class="md-footer__inner md-grid" aria-label="Footer">
+
+
+ <a href="../ch1-discover-docker-td/" class="md-footer__link md-footer__link--prev" aria-label="Previous: TD part 01 - Docker" rel="prev">
+ <div class="md-footer__button md-icon">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
+ </div>
+ <div class="md-footer__title">
+ <div class="md-ellipsis">
+ <span class="md-footer__direction">
+ Previous
+ </span>
+ TD part 01 - Docker
+ </div>
+ </div>
+ </a>
+
+
+ </nav>
+
+ <div class="md-footer-meta md-typeset">
+ <div class="md-footer-meta__inner md-grid">
+ <div class="md-copyright">
+
+
+ Made with
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+ Material for MkDocs
+ </a>
+
+</div>
+
+ </div>
+ </div>
+</footer>
+
+ </div>
+ <div class="md-dialog" data-md-component="dialog">
+ <div class="md-dialog__inner md-typeset"></div>
+ </div>
+ <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.instant"], "search": "../assets/javascripts/workers/search.2a1c317c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
+
+
+ <script src="../assets/javascripts/bundle.a6c66575.min.js"></script>
+
+
+ </body>
+</html>
\ No newline at end of file
diff --git a/public/ch2-discover-github-actions-tp/index.html b/public/ch2-discover-github-actions-tp/index.html
new file mode 100644
index 0000000000000000000000000000000000000000..19e439aa40ba7a4ed6307b0d4ea0562d4a7be307
--- /dev/null
+++ b/public/ch2-discover-github-actions-tp/index.html
@@ -0,0 +1,908 @@
+
+<!doctype html>
+<html lang="en" class="no-js">
+ <head>
+
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+
+
+
+ <link rel="icon" href="../assets/images/favicon.png">
+ <meta name="generator" content="mkdocs-1.3.0, mkdocs-material-8.2.15">
+
+
+
+ <title>TP part 02 - Github Actions - Devops</title>
+
+
+
+ <link rel="stylesheet" href="../assets/stylesheets/main.c382b1dc.min.css">
+
+
+ <link rel="stylesheet" href="../assets/stylesheets/palette.cc9b2e1e.min.css">
+
+
+
+ <meta name="theme-color" content="#e92063">
+
+
+
+
+
+
+
+
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
+ <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
+
+
+
+ <script>__md_scope=new URL("..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+
+
+
+
+
+ </head>
+
+
+
+
+
+
+
+ <body dir="ltr" data-md-color-scheme="" data-md-color-primary="pink" data-md-color-accent="">
+
+
+
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+ <label class="md-overlay" for="__drawer"></label>
+ <div data-md-component="skip">
+
+
+ <a href="#discover-github-action" class="md-skip">
+ Skip to content
+ </a>
+
+ </div>
+ <div data-md-component="announce">
+
+ </div>
+
+
+
+
+<header class="md-header" data-md-component="header">
+ <nav class="md-header__inner md-grid" aria-label="Header">
+ <a href=".." title="Devops" class="md-header__button md-logo" aria-label="Devops" data-md-component="logo">
+
+ <img src="../assets/logo.png" alt="logo">
+
+ </a>
+ <label class="md-header__button md-icon" for="__drawer">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
+ </label>
+ <div class="md-header__title" data-md-component="header-title">
+ <div class="md-header__ellipsis">
+ <div class="md-header__topic">
+ <span class="md-ellipsis">
+ Devops
+ </span>
+ </div>
+ <div class="md-header__topic" data-md-component="header-topic">
+ <span class="md-ellipsis">
+
+ TP part 02 - Github Actions
+
+ </span>
+ </div>
+ </div>
+ </div>
+
+
+
+ <label class="md-header__button md-icon" for="__search">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
+ </label>
+ <div class="md-search" data-md-component="search" role="dialog">
+ <label class="md-search__overlay" for="__search"></label>
+ <div class="md-search__inner" role="search">
+ <form class="md-search__form" name="search">
+ <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
+ <label class="md-search__icon md-icon" for="__search">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
+ </label>
+ <nav class="md-search__options" aria-label="Search">
+
+ <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
+ </button>
+ </nav>
+
+ </form>
+ <div class="md-search__output">
+ <div class="md-search__scrollwrap" data-md-scrollfix>
+ <div class="md-search-result" data-md-component="search-result">
+ <div class="md-search-result__meta">
+ Initializing search
+ </div>
+ <ol class="md-search-result__list"></ol>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ </nav>
+
+</header>
+
+ <div class="md-container" data-md-component="container">
+
+
+
+
+
+<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
+ <div class="md-tabs__inner md-grid">
+ <ul class="md-tabs__list">
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../ch1-discover-docker-tp/" class="md-tabs__link md-tabs__link--active">
+ TP
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../ch1-discover-docker-td/" class="md-tabs__link">
+ TD
+ </a>
+ </li>
+
+
+
+ </ul>
+ </div>
+</nav>
+
+
+
+ <main class="md-main" data-md-component="main">
+ <div class="md-main__inner md-grid">
+
+
+
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
+ <div class="md-sidebar__scrollwrap">
+ <div class="md-sidebar__inner">
+
+
+
+
+
+<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
+ <label class="md-nav__title" for="__drawer">
+ <a href=".." title="Devops" class="md-nav__button md-logo" aria-label="Devops" data-md-component="logo">
+
+ <img src="../assets/logo.png" alt="logo">
+
+ </a>
+ Devops
+ </label>
+
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" type="checkbox" id="__nav_1" checked>
+
+
+
+
+ <label class="md-nav__link" for="__nav_1">
+ TP
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="TP" data-md-level="1">
+ <label class="md-nav__title" for="__nav_1">
+ <span class="md-nav__icon md-icon"></span>
+ TP
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../ch1-discover-docker-tp/" class="md-nav__link">
+ TP part 01 - Docker
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--active">
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
+
+
+
+
+
+ <label class="md-nav__link md-nav__link--active" for="__toc">
+ TP part 02 - Github Actions
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <a href="./" class="md-nav__link md-nav__link--active">
+ TP part 02 - Github Actions
+ </a>
+
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+
+
+ <label class="md-nav__title" for="__toc">
+ <span class="md-nav__icon md-icon"></span>
+ Table of contents
+ </label>
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+ <li class="md-nav__item">
+ <a href="#goals" class="md-nav__link">
+ Goals
+ </a>
+
+ <nav class="md-nav" aria-label="Goals">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#good-practice" class="md-nav__link">
+ Good Practice
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#target-application" class="md-nav__link">
+ Target Application
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#setup-github-actions" class="md-nav__link">
+ Setup GitHub Actions
+ </a>
+
+ <nav class="md-nav" aria-label="Setup GitHub Actions">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#first-steps-into-the-ci-world" class="md-nav__link">
+ First steps into the CI World
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#build-and-test-your-application" class="md-nav__link">
+ Build and test your Application
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#first-steps-into-the-cd-world" class="md-nav__link">
+ First steps into the CD World
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#setup-quality-gate" class="md-nav__link">
+ Setup Quality Gate
+ </a>
+
+ <nav class="md-nav" aria-label="Setup Quality Gate">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#what-is-quality-about" class="md-nav__link">
+ What is quality about?
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#register-to-sonarcloud" class="md-nav__link">
+ Register to SonarCloud
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#going-further-split-pipelines" class="md-nav__link">
+ Going further: Split pipelines
+ </a>
+
+</li>
+
+ </ul>
+
+</nav>
+
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
+
+
+
+
+ <label class="md-nav__link" for="__nav_2">
+ TD
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="TD" data-md-level="1">
+ <label class="md-nav__title" for="__nav_2">
+ <span class="md-nav__icon md-icon"></span>
+ TD
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../ch1-discover-docker-td/" class="md-nav__link">
+ TD part 01 - Docker
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../ch2-discover-github-actions-td/" class="md-nav__link">
+ TD part 02 - Github Actions
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+ </ul>
+</nav>
+ </div>
+ </div>
+ </div>
+
+
+
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
+ <div class="md-sidebar__scrollwrap">
+ <div class="md-sidebar__inner">
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+
+
+ <label class="md-nav__title" for="__toc">
+ <span class="md-nav__icon md-icon"></span>
+ Table of contents
+ </label>
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+ <li class="md-nav__item">
+ <a href="#goals" class="md-nav__link">
+ Goals
+ </a>
+
+ <nav class="md-nav" aria-label="Goals">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#good-practice" class="md-nav__link">
+ Good Practice
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#target-application" class="md-nav__link">
+ Target Application
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#setup-github-actions" class="md-nav__link">
+ Setup GitHub Actions
+ </a>
+
+ <nav class="md-nav" aria-label="Setup GitHub Actions">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#first-steps-into-the-ci-world" class="md-nav__link">
+ First steps into the CI World
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#build-and-test-your-application" class="md-nav__link">
+ Build and test your Application
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#first-steps-into-the-cd-world" class="md-nav__link">
+ First steps into the CD World
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#setup-quality-gate" class="md-nav__link">
+ Setup Quality Gate
+ </a>
+
+ <nav class="md-nav" aria-label="Setup Quality Gate">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#what-is-quality-about" class="md-nav__link">
+ What is quality about?
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#register-to-sonarcloud" class="md-nav__link">
+ Register to SonarCloud
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#going-further-split-pipelines" class="md-nav__link">
+ Going further: Split pipelines
+ </a>
+
+</li>
+
+ </ul>
+
+</nav>
+ </div>
+ </div>
+ </div>
+
+
+ <div class="md-content" data-md-component="content">
+ <article class="md-content__inner md-typeset">
+
+
+
+
+<h1 id="discover-github-action">Discover Github Action</h1>
+<div class="admonition check">
+<p class="admonition-title">Check</p>
+<p>Checkpoint: call us to check your results (don’t stay blocked on a checkpoint if we are busy, we can check ⅔ checkpoints at the same time) </p>
+</div>
+<div class="admonition question">
+<p class="admonition-title">Question</p>
+<p>Point to document/report </p>
+</div>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>Interesting information</p>
+</div>
+<h2 id="goals">Goals</h2>
+<h3 id="good-practice">Good Practice</h3>
+<p>Do not forget to document what you do along the steps.</p>
+<p>Create an appropriate file structure, 1 folder per image.</p>
+<h3 id="target-application">Target Application</h3>
+<p>Complete pipeline workflow for testing and delivering your software application.</p>
+<p>We are going to use different useful tools to build your application, test it automatically, and check the code quality at the same time.</p>
+<div class="admonition link">
+<p class="admonition-title">Link</p>
+<p><a href="https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions" target="_blank">GitHub Actions</a></p>
+</div>
+<h2 id="setup-github-actions">Setup GitHub Actions</h2>
+<p>The first tool we are going to use is <strong>GitHub Actions</strong>. <strong>GitHub Actions</strong> is an online service that allows you to build pipelines to test your application. Keep in mind that <strong>GitHub Actions</strong> is not the only one on the market to build integration pipelines. </p>
+<p>Historically many companies were using <a href="https://jenkins.io/" target="_blank">Jenkins</a> (and still a lot continue to do it), it is way less accessible than <strong>GitHub Actions</strong> but much more configurable. You will also hear about <a href="https://about.gitlab.com/product/continuous-integration/" target="_blank">Gitlab CI</a> and <a href="https://bitbucket.org/product/fr/features/pipelines" target="_blank">Bitbucket Pipelines</a> during your work life.</p>
+<h3 id="first-steps-into-the-ci-world">First steps into the CI World</h3>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Use your repository from the end of the Docker TP</p>
+</div>
+<p>Most of the CI services use a <a href="https://yaml.org/" target="_blank">yaml</a> file (except Jenkins that uses a… <a href="https://groovy-lang.org/" target="_blank">Groovy</a> file…) to describe the expected steps to be done over the pipeline execution. Go on and create your first main.yml file into your project’s root directory.</p>
+<h3 id="build-and-test-your-application">Build and test your Application</h3>
+<p>For those who are not familiar with <a href="https://maven.apache.org/" target="_blank">Maven</a> and <a href="https://www.java.com/fr/" target="_blank">Java</a> project structures, here is the command for building and running your tests:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>mvn<span class="w"> </span>clean<span class="w"> </span>verify
+</code></pre></div>
+<p>You need to launch this command from your <code>pom.xml</code> directory, or specify the path to it with <code>--file /path/to/pom.xml</code> argument.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>What is it supposed to do?</p>
+</div>
+<p>This command will actually clear your previous builds inside your cache (otherwise your can have unexpected behavior because maven did not build again each part of your application), then it will freshly build each module inside your application, and finally it will run both <a href="https://www.guru99.com/unit-testing-guide.html#2" target="_blank">Unit Tests</a> and <a href="https://www.guru99.com/integration-testing.html" target="_blank">Integration Tests</a> (sometime called Component Tests as well).</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Unit tests? Component tests?</p>
+</div>
+<p>Integration tests require a database to verify you correctly inserted or retrieved data from it. Fortunately for you, we’ve already taken care of this! But you still need to understand how it works under the hood. Take a look at your application file tree. </p>
+<p>Let’s take a look at the <code>pom.xml</code> that is inside the <strong>simple-api</strong>, you will find some very helpful dependencies for your testing.</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt"><dependencies></span>
+<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w"> </span><span class="nt"><dependency></span>
+<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span><span class="nt"><groupId></span>org.testcontainers<span class="nt"></groupId></span>
+<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="nt"><artifactId></span>testcontainers<span class="nt"></artifactId></span>
+<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w"> </span><span class="nt"><version></span>${testcontainers.version}<span class="nt"></version></span>
+<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w"> </span><span class="nt"><scope></span>test<span class="nt"></scope></span>
+<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w"> </span><span class="nt"></dependency></span>
+<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w"> </span><span class="nt"><dependency></span>
+<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w"> </span><span class="nt"><groupId></span>org.testcontainers<span class="nt"></groupId></span>
+<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w"> </span><span class="nt"><artifactId></span>jdbc<span class="nt"></artifactId></span>
+<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="w"> </span><span class="nt"><version></span>${testcontainers.version}<span class="nt"></version></span>
+<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="w"> </span><span class="nt"><scope></span>test<span class="nt"></scope></span>
+<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a><span class="w"> </span><span class="nt"></dependency></span>
+<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a><span class="w"> </span><span class="nt"><dependency></span>
+<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a><span class="w"> </span><span class="nt"><groupId></span>org.testcontainers<span class="nt"></groupId></span>
+<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a><span class="w"> </span><span class="nt"><artifactId></span>postgresql<span class="nt"></artifactId></span>
+<a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a><span class="w"> </span><span class="nt"><version></span>${testcontainers.version}<span class="nt"></version></span>
+<a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a><span class="w"> </span><span class="nt"><scope></span>test<span class="nt"></scope></span>
+<a id="__codelineno-1-19" name="__codelineno-1-19" href="#__codelineno-1-19"></a><span class="w"> </span><span class="nt"></dependency></span>
+<a id="__codelineno-1-20" name="__codelineno-1-20" href="#__codelineno-1-20"></a><span class="nt"></dependencies></span>
+</code></pre></div>
+<p>As you can see, there are a bunch of testcontainers dependencies inside the pom. </p>
+<div class="admonition question">
+<p class="admonition-title">Question</p>
+<p>2-1 What are testcontainers?</p>
+</div>
+<p>They simply are java libraries that allow you to run a bunch of docker containers while testing. Here we use the postgresql container to attach to our application while testing. If you run the command <code>mvn clean verify</code> you’ll be able to see the following:</p>
+<p><img alt="logs_spring" src="../assets/logs_spring.png" /></p>
+<p>As you can see, a docker container has been launched while your tests were running, pretty convenient, isn’t it? </p>
+<p>Finally, you’ll see your test results. </p>
+<p>Now, it is up to you! Create your first CI, asking to build and test your application every time someone commits and pushes code on the repository.</p>
+<p>First you create a <code>.github/workflows</code> directory in your repository on GitHub.</p>
+<p><img alt="github_actions_1" src="../assets/github_actions_1.png" /></p>
+<p>Put your <code>main.yml</code> inside workflows.</p>
+<p>The <code>main.yml</code> holds the architecture of your pipeline. Each job will represent a step of what you want to do. Each job will be run in parallel unless a link is specified.</p>
+<p>Here is what your <code>main.yml</code> should look like:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">CI devops 2025</span>
+<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="nt">on</span><span class="p">:</span>
+<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w"> </span><span class="c1">#to begin you want to launch this job in main and develop</span>
+<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w"> </span><span class="nt">push</span><span class="p">:</span>
+<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="w"> </span><span class="nt">branches</span><span class="p">:</span><span class="w"> </span><span class="c1">#TODO </span>
+<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="w"> </span><span class="nt">pull_request</span><span class="p">:</span>
+<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a>
+<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="nt">jobs</span><span class="p">:</span>
+<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="w"> </span><span class="nt">test-backend</span><span class="p">:</span><span class="w"> </span>
+<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="w"> </span><span class="nt">runs-on</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ubuntu-24.04</span>
+<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a><span class="w"> </span><span class="nt">steps</span><span class="p">:</span>
+<a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a><span class="w"> </span><span class="c1">#checkout your github code using actions/checkout@v4</span>
+<a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">actions/checkout@v4</span>
+<a id="__codelineno-2-14" name="__codelineno-2-14" href="#__codelineno-2-14"></a>
+<a id="__codelineno-2-15" name="__codelineno-2-15" href="#__codelineno-2-15"></a><span class="w"> </span><span class="c1">#do the same with another action (actions/setup-java@v4) that enable to setup jdk 21</span>
+<a id="__codelineno-2-16" name="__codelineno-2-16" href="#__codelineno-2-16"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Set up JDK 21</span>
+<a id="__codelineno-2-17" name="__codelineno-2-17" href="#__codelineno-2-17"></a><span class="w"> </span><span class="c1">#TODO</span>
+<a id="__codelineno-2-18" name="__codelineno-2-18" href="#__codelineno-2-18"></a>
+<a id="__codelineno-2-19" name="__codelineno-2-19" href="#__codelineno-2-19"></a><span class="w"> </span><span class="c1">#finally build your app with the latest command</span>
+<a id="__codelineno-2-20" name="__codelineno-2-20" href="#__codelineno-2-20"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Build and test with Maven</span>
+<a id="__codelineno-2-21" name="__codelineno-2-21" href="#__codelineno-2-21"></a><span class="w"> </span><span class="nt">run</span><span class="p">:</span><span class="w"> </span><span class="c1">#TODO</span>
+</code></pre></div>
+<p>It’s your turn, fill the #TODOs!</p>
+<p>To see the result you must follow the next steps:</p>
+<p><img alt="github_actions_2" src="../assets/github_actions_2.png" /></p>
+<p>And if it’s GREEN you win! </p>
+<p><img alt="github_actions_3" src="../assets/github_actions_3.png" /></p>
+<div class="admonition check">
+<p class="admonition-title">Check</p>
+</div>
+<p>First CI with backend test !</p>
+<div class="admonition question">
+<p class="admonition-title">Question</p>
+<p>2-2 Document your Github Actions configurations.</p>
+</div>
+<h3 id="first-steps-into-the-cd-world">First steps into the CD World</h3>
+<p>Here we are going to configure the Continuous Delivery of our project. Therefore, the main goal will be to create and save a docker image containing our application on the Docker Hub every time there is a commit on a main branch.</p>
+<p>As you probably already noticed, you need to log in to docker hub to perform any publication. However, you don’t want to publish your credentials on a public repository (it is not even a good practise to do it on a private repository). Fortunately, <strong>GitHub</strong> allows you to create secured environment variables.</p>
+<p>1- Add your docker hub credentials to the environment variables in <strong>GitHub Actions</strong> (and let them secured).</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Secured Variables, why?</p>
+</div>
+<p>Now that you added them, you can freely declare them and use them inside your <strong>GitHub Actions</strong> pipeline. </p>
+<p><img alt="github_actions_4" src="../assets/github_actions_4.png" /></p>
+<p>2- Build your docker images inside your <strong>GitHub Actions</strong> pipeline.</p>
+<p>Maybe the template Build a docker image can help you! For now, we only need to build the images</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="c1"># define job to build and publish docker image</span>
+<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="nt">build-and-push-docker-image</span><span class="p">:</span>
+<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="w"> </span><span class="nt">needs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">test-backend</span>
+<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="w"> </span><span class="c1"># run only when code is compiling and tests are passing</span>
+<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a><span class="w"> </span><span class="nt">runs-on</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ubuntu-24.04</span>
+<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a>
+<a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="w"> </span><span class="c1"># steps to perform in job</span>
+<a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a><span class="w"> </span><span class="nt">steps</span><span class="p">:</span>
+<a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Checkout code</span>
+<a id="__codelineno-3-10" name="__codelineno-3-10" href="#__codelineno-3-10"></a><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">actions/checkout@v4</span>
+<a id="__codelineno-3-11" name="__codelineno-3-11" href="#__codelineno-3-11"></a>
+<a id="__codelineno-3-12" name="__codelineno-3-12" href="#__codelineno-3-12"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Build image and push backend</span>
+<a id="__codelineno-3-13" name="__codelineno-3-13" href="#__codelineno-3-13"></a><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker/build-push-action@v6</span>
+<a id="__codelineno-3-14" name="__codelineno-3-14" href="#__codelineno-3-14"></a><span class="w"> </span><span class="nt">with</span><span class="p">:</span>
+<a id="__codelineno-3-15" name="__codelineno-3-15" href="#__codelineno-3-15"></a><span class="w"> </span><span class="c1"># relative path to the place where source code with Dockerfile is located</span>
+<a id="__codelineno-3-16" name="__codelineno-3-16" href="#__codelineno-3-16"></a><span class="w"> </span><span class="nt">context</span><span class="p">:</span><span class="w"> </span>
+<a id="__codelineno-3-17" name="__codelineno-3-17" href="#__codelineno-3-17"></a><span class="w"> </span><span class="c1"># Note: tags has to be all lower-case</span>
+<a id="__codelineno-3-18" name="__codelineno-3-18" href="#__codelineno-3-18"></a><span class="w"> </span><span class="nt">tags</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${{secrets.DOCKERHUB_USERNAME}}/tp-devops-simple-api:latest</span>
+<a id="__codelineno-3-19" name="__codelineno-3-19" href="#__codelineno-3-19"></a>
+<a id="__codelineno-3-20" name="__codelineno-3-20" href="#__codelineno-3-20"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Build image and push database</span>
+<a id="__codelineno-3-21" name="__codelineno-3-21" href="#__codelineno-3-21"></a><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain"># DO the same for database</span>
+<a id="__codelineno-3-22" name="__codelineno-3-22" href="#__codelineno-3-22"></a>
+<a id="__codelineno-3-23" name="__codelineno-3-23" href="#__codelineno-3-23"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Build image and push httpd</span>
+<a id="__codelineno-3-24" name="__codelineno-3-24" href="#__codelineno-3-24"></a><span class="w"> </span><span class="c1"># DO the same for httpd</span>
+</code></pre></div>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Why did we put <strong>needs: build-and-test-backend</strong> on this job? Maybe try without this and you will see!</p>
+</div>
+<p>OK your images are built but not yet published on <a href="https://hub.docker.com/" target="_blank">dockerhub</a>.</p>
+<p>3- Publish your docker images when there is a commit on the main branch.</p>
+<p>Don’t forget to do a docker login and to put your credentials on secrets!</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Login to DockerHub</span>
+<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span><span class="nt">run</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">echo "${{ secrets.DOCKERHUB_TOKEN }}" | docker login --username ${{ secrets.DOCKERHUB_USERNAME }} --password-stdin</span>
+</code></pre></div>
+<p>And after modify job <code>Build image and push backend</code> to add a <code>push</code> action:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Build image and push backend</span>
+<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker/build-push-action@v6</span>
+<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span><span class="nt">with</span><span class="p">:</span>
+<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="w"> </span><span class="c1"># relative path to the place where source code with Dockerfile is located</span>
+<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="w"> </span><span class="nt">context</span><span class="p">:</span><span class="w"> </span>
+<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a><span class="w"> </span><span class="c1"># Note: tags has to be all lower-case</span>
+<a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a><span class="w"> </span><span class="nt">tags</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${{secrets.DOCKERHUB_USERNAME}}/tp-devops-simple-api:latest</span>
+<a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a><span class="w"> </span><span class="c1"># build on feature branches, push only on main branch</span>
+<a id="__codelineno-5-9" name="__codelineno-5-9" href="#__codelineno-5-9"></a><span class="w"> </span><span class="nt">push</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${{ github.ref == 'refs/heads/main' }}</span>
+</code></pre></div>
+<p>Do the same for other containers.</p>
+<div class="admonition question">
+<p class="admonition-title">Question</p>
+<p>2-3 For what purpose do we need to push docker images?</p>
+</div>
+<p>Now you should be able to find your docker images on your docker repository.</p>
+<div class="admonition check">
+<p class="admonition-title">Check</p>
+<p>Working CI & Docker images pushed to your repository.</p>
+</div>
+<h2 id="setup-quality-gate">Setup Quality Gate</h2>
+<h3 id="what-is-quality-about">What is quality about?</h3>
+<p>Quality is here to make sure your code will be maintainable and determine every unsecured block. It helps you produce better and tested features, and it will also prevent having dirty code pushed inside your main branch.</p>
+<p>For this purpose, we are going to use <strong>SonarCloud</strong>, a cloud solution that makes analysis and reports of your code. This is a useful tool that everyone should use in order to learn java best practices.</p>
+<h3 id="register-to-sonarcloud">Register to SonarCloud</h3>
+<p>Create your free-tier account on <a href="https://sonarcloud.io/" target="_blank">SonarCloud</a>.</p>
+<p><strong>SonarCloud</strong> will propose you to set up your <strong>GitHub Actions</strong> pipeline from the <strong>GitHub Actions</strong>, but forget about that, there is a much better way to save the <strong>SonarCloud</strong> provided and provide it into your <code>main.yml</code>.</p>
+<p>1- You must create an organization.</p>
+<p><img alt="sonarcloud_1" src="../assets/sonarcloud_1.png" /></p>
+<p>2- And keep the project key and the organization key you will need it later.</p>
+<p><img alt="sonarcloud_2" src="../assets/sonarcloud_2.png" /></p>
+<p>3- You need to add this script to your <code>main.yml</code> for launch sonar at each commit.</p>
+<p>Set up your pipeline to use <strong>SonarCloud</strong> analysis while testing.</p>
+<p>For that, you need to add a <strong>new step</strong> after <strong>Build and test</strong> with Maven and change sonar organization and project key.</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>mvn<span class="w"> </span>-B<span class="w"> </span>verify<span class="w"> </span>sonar:sonar<span class="w"> </span>-Dsonar.projectKey<span class="o">=</span><your-project-key><span class="w"> </span>-Dsonar.organization<span class="o">=</span><your-organization><span class="w"> </span>-Dsonar.host.url<span class="o">=</span>https://sonarcloud.io<span class="w"> </span>-Dsonar.login<span class="o">=</span><span class="si">${</span><span class="p">{ secrets.SONAR_TOKEN </span><span class="si">}</span><span class="o">}</span><span class="w"> </span>--file<span class="w"> </span>./simple-api/pom.xml
+</code></pre></div>
+<p>If you did your configuration correctly, you should be able to see the <strong>SonarCloud analysis</strong> report online:</p>
+<p><img alt="sonarcloud_3" src="../assets/sonarcloud_3.png" /></p>
+<div class="admonition check">
+<p class="admonition-title">Check</p>
+<p>Working quality gate.</p>
+</div>
+<div class="admonition question">
+<p class="admonition-title">Question</p>
+<p>2-4 Document your quality gate configuration.</p>
+</div>
+<p>Well done buddies, you’ve created your very first Quality Gate! Yay!</p>
+<h2 id="going-further-split-pipelines">Going further: Split pipelines</h2>
+<p>In this step you have to separate your jobs into different workflows so that they respect 2 things:</p>
+<ul>
+<li><strong>test-backend</strong> must be launched on develop and master branch and <strong>build-and-push-docker-image</strong> on master only.</li>
+<li>The job that pushes the docker api image must be launched only if <strong>test-backend</strong> is passed.</li>
+</ul>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>You can use <strong>on: workflow_run</strong> to trigger a workflow when another workflow is passed.</p>
+</div>
+<p align="center">© Takima 2025</p>
+
+
+ </article>
+ </div>
+ </div>
+
+ </main>
+
+ <footer class="md-footer">
+
+ <nav class="md-footer__inner md-grid" aria-label="Footer">
+
+
+ <a href="../ch1-discover-docker-tp/" class="md-footer__link md-footer__link--prev" aria-label="Previous: TP part 01 - Docker" rel="prev">
+ <div class="md-footer__button md-icon">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
+ </div>
+ <div class="md-footer__title">
+ <div class="md-ellipsis">
+ <span class="md-footer__direction">
+ Previous
+ </span>
+ TP part 01 - Docker
+ </div>
+ </div>
+ </a>
+
+
+
+ <a href="../ch1-discover-docker-td/" class="md-footer__link md-footer__link--next" aria-label="Next: TD part 01 - Docker" rel="next">
+ <div class="md-footer__title">
+ <div class="md-ellipsis">
+ <span class="md-footer__direction">
+ Next
+ </span>
+ TD part 01 - Docker
+ </div>
+ </div>
+ <div class="md-footer__button md-icon">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg>
+ </div>
+ </a>
+
+ </nav>
+
+ <div class="md-footer-meta md-typeset">
+ <div class="md-footer-meta__inner md-grid">
+ <div class="md-copyright">
+
+
+ Made with
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+ Material for MkDocs
+ </a>
+
+</div>
+
+ </div>
+ </div>
+</footer>
+
+ </div>
+ <div class="md-dialog" data-md-component="dialog">
+ <div class="md-dialog__inner md-typeset"></div>
+ </div>
+ <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.instant"], "search": "../assets/javascripts/workers/search.2a1c317c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
+
+
+ <script src="../assets/javascripts/bundle.a6c66575.min.js"></script>
+
+
+ </body>
+</html>
\ No newline at end of file
diff --git a/public/cheatsheet/index.html b/public/cheatsheet/index.html
index 39a3dcf9badec81397918804b4f1fb0d86029f66..20c92ce0aa4d25a2dcceb69cde83b68fc2081a40 100644
--- a/public/cheatsheet/index.html
+++ b/public/cheatsheet/index.html
@@ -257,6 +257,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../ch2-discover-github-actions-tp/" class="md-nav__link">
+ TP part 02 - Github Actions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -305,6 +319,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../ch2-discover-github-actions-td/" class="md-nav__link">
+ TD part 02 - Github Actions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
diff --git a/public/index.html b/public/index.html
index f0b342d5e60766ba688323c7db94f5743cf5b49d..1528771d86f5b4e8dc5b3a3aceb339138b919d13 100644
--- a/public/index.html
+++ b/public/index.html
@@ -257,6 +257,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="ch2-discover-github-actions-tp/" class="md-nav__link">
+ TP part 02 - Github Actions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -305,6 +319,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="ch2-discover-github-actions-td/" class="md-nav__link">
+ TD part 02 - Github Actions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -351,6 +379,10 @@ For that we will give you each a server and a Java application.</p>
<p><a href="ch1-discover-docker-td/">Docker TDs are available here</a> <br />
<a href="ch1-discover-docker-tp/">Docker TPs are available here</a> <br />
<a href="https://docs.google.com/presentation/d/1YRcnfqvw6rWccCdiAPWjDcV7R2ThiGRswUB-CV1O9ug/edit?usp=sharing">Docker slides are available here</a></p>
+<p><strong>Part 2 - Github Action session</strong></p>
+<p><a href="ch2-discover-github-actions-td/">Github Actions TDs are available here</a> <br />
+<a href="ch2-discover-github-actions-tp/">Github Actions TPs are available here</a> <br />
+<a href="https://docs.google.com/presentation/d/15nEzGSqN1z0Uvy6sVu7svJGzD1I8Odb2kU8c6fGlUzw/edit?usp=sharing">Github Actions slides are availabe here</a> </p>
<p><strong>Please read the indications carefully, most of the time what you need is in front of your eyes!</strong></p>
<p align="center">© Takima 2025</p>
diff --git a/public/search/search_index.json b/public/search/search_index.json
index 73a3df5302df49b6d625a4035ff328eaf652b004..4fe54ef763a435768c5624933e43da9bab3e5188 100644
--- a/public/search/search_index.json
+++ b/public/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Devops in Action - Guide For each step you have a TD to discover the subject and a TP to put it into practice. The TPs follow each other and the goal is to make you start from a local application and get to an application delivered in production and accessible to all. For that we will give you each a server and a Java application. Part 1 - Docker session Docker TDs are available here Docker TPs are available here Docker slides are available here Please read the indications carefully, most of the time what you need is in front of your eyes! \u00a9 Takima 2025","title":"Devops in Action - Guide"},{"location":"#devops-in-action-guide","text":"For each step you have a TD to discover the subject and a TP to put it into practice. The TPs follow each other and the goal is to make you start from a local application and get to an application delivered in production and accessible to all. For that we will give you each a server and a Java application. Part 1 - Docker session Docker TDs are available here Docker TPs are available here Docker slides are available here Please read the indications carefully, most of the time what you need is in front of your eyes! \u00a9 Takima 2025","title":"Devops in Action - Guide"},{"location":"ch1-discover-docker-td/","text":"Discover Docker Check Checkpoint: call us to check your results (don\u2019t stay blocked on a checkpoint if we are busy, we can check \u2154 checkpoints at the same time) Question Point to document/report Tip Interesting information Setup Prerequisites There are no specific skills needed for this tutorial beyond a basic comfort with the command line and using a text editor. Prior experience in developing web applications will be helpful but is not required. As you proceed further along the tutorial, we'll make use of https://cloud.docker.com/. Setting up your computer Getting all the tooling setup on your computer can be a daunting task, but getting Docker up and running on your favorite OS has become very easy. The getting started guide on Docker has detailed instructions for setting up Docker on Mac , Linux and Windows If you're using Docker for Windows make sure you have shared your drive. Important note If you're using an older version of Windows or MacOS you may need to use Docker Machine instead. All commands work in either bash or Powershell on Windows Once you are done installing Docker, test your Docker installation by running the following: docker run hello-world Unable to find image 'hello-world:latest' locally latest: Pulling from library/hello-world 03f4658f8b78: Pull complete a3ed95caeb02: Pull complete Digest: sha256:8be990ef2aeb16dbcb9271ddfe2610fa6658d13f6dfb8bc72074cc1ca36966a7 Status: Downloaded newer image for hello-world:latest Hello from Docker. ... This message shows that your installation appears to be working correctly. Running your first container Now that you have everything setup, it's time to get our hands dirty. In this section, you are going to run an Alpine Linux container (a lightweight linux distribution) on your system and get a taste of the docker run command. To get started, let's run the following in our terminal: docker pull alpine Note Depending on how you've installed docker on your system, you might see a permission denied error after running the above command. Try the commands from the Getting Started tutorial to verify your installation . If you're on Linux, you may need to prefix your docker commands with sudo . Alternatively you can create a docker group to get rid of this issue. The pull command fetches the alpine image from the Docker registry and saves it in our system. You can use the docker images command to see a list of all images on your system. docker images REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE alpine latest c51f86c28340 4 weeks ago 1 .109 MB hello-world latest 690ed74de00f 5 months ago 960 B 1.1 Docker Run Great! Let's now run a Docker container based on this image. To do that you are going to use the docker run command. docker run alpine ls -l total 48 drwxr-xr-x 2 root root 4096 Mar 2 16:20 bin drwxr-xr-x 5 root root 360 Mar 18 09:47 dev drwxr-xr-x 13 root root 4096 Mar 18 09:47 etc drwxr-xr-x 2 root root 4096 Mar 2 16:20 home drwxr-xr-x 5 root root 4096 Mar 2 16:20 lib ...... ...... What happened? Behind the scenes, a lot of stuff happened. When you call run : 1. The Docker client contacts the Docker daemon. The Docker daemon checks local store if the image (alpine in this case) is available locally, and if not, downloads it from Docker Store. (Since we have issued docker pull alpine before, the download step is not necessary) The Docker daemon creates the container and then runs a command in that container. The Docker daemon streams the output of the command to the Docker client When you run docker run alpine , you provided a command ( ls -l ), so Docker started the command specified and you saw the listing. Let's try something more exciting. docker run alpine echo \"hello from alpine\" hello from alpine OK, that's some actual output. In this case, the Docker client dutifully ran the echo command in our alpine container and then exited it. If you've noticed, all of that happened pretty quickly. Imagine booting up a virtual machine, running a command and then killing it. Now you know why they say containers are fast! Try another command. docker run alpine /bin/sh Wait, nothing happened! Is that a bug? Well, no. These interactive shells will exit after running any scripted commands, unless they are run in an interactive terminal - so for this example to not exit, you need to docker run -it alpine /bin/sh . You are now inside the container shell and you can try out a few commands like ls -l , uname -a and others. Exit out of the container by giving the exit command. Ok, now it's time to see the docker ps command. The docker ps command shows you all containers that are currently running. docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES Since no containers are running, you see a blank line. Let's try a more useful variant: docker ps -a docker ps -a CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 36171a5da744 alpine \"/bin/sh\" 5 minutes ago Exited ( 0 ) 2 minutes ago fervent_newton a6a9d46d0b2f alpine \"echo 'hello from alp\" 6 minutes ago Exited ( 0 ) 6 minutes ago lonely_kilby ff0a5c3750b9 alpine \"ls -l\" 8 minutes ago Exited ( 0 ) 8 minutes ago elated_ramanujan c317d0a9e3d2 hello-world \"/hello\" 34 seconds ago Exited ( 0 ) 12 minutes ago stupefied_mcclintock What you see above is a list of all containers that you ran. Notice that the STATUS column shows that these containers exited a few minutes ago. You're probably wondering if there is a way to run more than just one command in a container. Let's try that now: docker run -it alpine /bin/sh / # ls bin dev etc home lib linuxrc media mnt proc root run sbin sys tmp usr var / # uname -a Linux 97916e8cb5dc 4.4.27-moby #1 SMP Wed Oct 26 14:01:48 UTC 2016 x86_64 Linux Running the run command with the -it flags attaches us to an interactive tty in the container. Now you can run as many commands in the container as you want. Take some time to run your favorite commands. Tip run -it is a very useful command to debug at the lowest level a container. That concludes a whirlwind tour of the docker run command which would most likely be the command you'll use most often. It makes sense to spend some time getting comfortable with it. To find out more about run , use docker run --help to see a list of all flags it supports. As you proceed further, we'll see a few more variants of docker run. 1.2 Terminology In the last section, you saw a lot of Docker-specific jargon which might be confusing to some. So before you go further, let's clarify some terminology that is used frequently in the Docker ecosystem. Images - The file system and configuration of our application which are used to create containers. To find out more about a Docker image, run docker inspect alpine . In the demo above, you used the docker pull command to download the alpine image. When you executed the command docker run hello-world , it also did a docker pull behind the scenes to download the hello-world image. Containers - Running instances of Docker images \u2014 containers run the actual applications. A container includes an application and all of its dependencies. It shares the kernel with other containers, and runs as an isolated process in user space on the host OS. You created a container using docker run which you did using the alpine image that you downloaded. A list of running containers can be seen using the docker ps command. Docker daemon - The background service running on the host that manages building, running and distributing Docker containers. Docker client - The command line tool that allows the user to interact with the Docker daemon. Docker Store - A registry of Docker images, where you can find trusted and enterprise ready containers, plugins, and Docker editions. You'll be using this later in this tutorial. 2.0 Webapps with Docker Great! So you have now looked at docker run , played with a Docker container and also got the hang of some terminology. Armed with all this knowledge, you are now ready to get to the real stuff \u2014 deploying web applications with Docker. 2.1 Run a static website in a container Note Code for this section is in this repo in the static-site directory Let's start by taking baby-steps. First, we'll use Docker to run a static website in a container. The website is based on an existing image. We'll pull a Docker image from Docker Store, run the container, and see how easy it is to set up a web server. The image that you are going to use is a single-page website that was already created for this demo and is available on the Docker Store as dockersamples/static-site . You can download and run the image directly in one go using docker run as follows. docker run -d dockersamples/static-site Note The current version of this image doesn't run without the -d flag. The -d flag enables detached mode, which detaches the running container from the terminal/shell and returns your prompt after the container starts. We are debugging the problem with this image but for now, use -d even for this first example. Tip -d is a very useful option. So, what happens when you run this command? Since the image doesn't exist on your Docker host, the Docker daemon first fetches it from the registry and then runs it as a container. Now that the server is running, do you see the website? What port is it running on? And more importantly, how do you access the container directly from our host machine? Actually, you probably won't be able to answer any of these questions yet! \u263a In this case, the client didn't tell the Docker Engine to publish any of the ports, so you need to re-run the docker run command to add this instruction. Let's re-run the command with some new flags to publish ports and pass your name to the container to customize the message displayed. We'll use the -d option again to run the container in detached mode. First, stop the container that you have just launched. In order to do this, we need the container ID. Since we ran the container in detached mode, we don't have to launch another terminal to do this. Run docker ps to view the running containers. docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES a7a0e504ca3e dockersamples/static-site \"/bin/sh -c 'cd /usr/\" 28 seconds ago Up 26 seconds 80 /tcp, 443 /tcp stupefied_mahavira Check out the CONTAINER ID column. You will need to use this CONTAINER ID value, a long sequence of characters, to identify the container you want to stop, and then to remove it. The example below provides the CONTAINER ID on our system; you should use the value that you see in your terminal. docker stop a7a0e504ca3e docker rm a7a0e504ca3e Note A cool feature is that you do not need to specify the entire CONTAINER ID . You can just specify a few starting characters and if it is unique among all the containers that you have launched, the Docker client will intelligently pick it up. Now, let's launch a container in detached mode as shown below: docker run --name static-site -e AUTHOR = \"Enter Your Name Here\" -d -P dockersamples/static-site e61d12292d69556eabe2a44c16cbd54486b2527e2ce4f95438e504afb7b02810 In the above command: -d will create a container with the process detached from our terminal -P will publish all the exposed container ports to random ports on the Docker host -e is how you pass environment variables to the container. --name allows you to specify a container name AUTHOR is the environment variable name and Your Name is the value that you can pass. Now you can see the ports by running the docker port command. docker port static-site 443 /tcp -> 0 .0.0.0:32772 80 /tcp -> 0 .0.0.0:32773 You can open your freshly created website on http://localhost:[YOUR_PORT_FOR 80/tcp] . For our example this is http://localhost:32773 . You can now open http://localhost:[YOUR_PORT_FOR 80/tcp] to see your site live! For our example, this is: http://192.168.99.100:32773 . You can also run a second webserver at the same time, specifying a custom host port mapping to the container's webserver. docker run --name static-site-2 -e AUTHOR = \"Enter Your Name Here\" -d -p 8888 :80 dockersamples/static-site To deploy this on a real server you would just need to install Docker, and run the above docker command (as in this case you can see the AUTHOR is Docker which we passed as an environment variable). Now that you've seen how to run a webserver inside a Docker container, how do you create your own Docker image? This is the question we'll explore in the next section. But first, let's stop and remove the containers since you won't be using them anymore. docker stop static-site docker rm static-site Let's use a shortcut to remove the second site: docker rm -f static-site-2 Tip rm -f is a very useful option Run docker ps to make sure the containers are gone. docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 2.2 Docker Images In this section, let's dive deeper into what Docker images are. You will build your own image, use that image to run an application locally, and finally, push some of your own images to Docker Cloud. Docker images are the basis of containers. In the previous example, you pulled the dockersamples/static-site image from the. registry and asked the Docker client to run a container based on that image. To see the list of images that are available locally on your system, run the docker images command. docker images REPOSITORY TAG IMAGE ID CREATED SIZE dockersamples/static-site latest 92a386b6e686 2 hours ago 190 .5 MB nginx latest af4b3d7d5401 3 hours ago 190 .5 MB python 2 .7 1c32174fd534 14 hours ago 676 .8 MB postgres 9 .4 88d845ac7a88 14 hours ago 263 .6 MB containous/traefik latest 27b4e0c6b2fd 4 days ago 20 .75 MB node 0 .10 42426a5cba5f 6 days ago 633 .7 MB redis latest 4f5f397d4b7c 7 days ago 177 .5 MB mongo latest 467eb21035a8 7 days ago 309 .7 MB alpine 3 .3 70c557e50ed6 8 days ago 4 .794 MB java 7 21f6ce84e43c 8 days ago 587 .7 MB Above is a list of images that I've pulled from the registry and those I've created myself (we'll shortly see how). You will have a different list of images on your machine. The TAG refers to a particular snapshot of the image and the ID is the corresponding unique identifier for that image. For simplicity, you can think of an image akin to a git repository - images can be committed with changes and have multiple. versions. When you do not provide a specific version number, the client defaults to latest. For example you could pull a specific version of ubuntu image as follows: docker pull ubuntu:12.04 If you do not specify the version number of the image then, as mentioned, the Docker client will default to a version named latest . So for example, the docker pull command given below will pull an image named ubuntu:latest : docker pull ubuntu To get a new Docker image you can either get it from a registry (such as the Docker Store) or create your own. There are hundreds of thousands of images available on Docker Store . You can also search for images directly from the command line using docker search . An important distinction with regard to images is between base images and child images . Base images are images that have no parent images, usually images with an OS like ubuntu, alpine or debian. Child images are images that build on base images and add additional functionality. Another key concept is the idea of official images and user images. (Both of which can be base images or child images.) Official images are Docker sanctioned images. Docker, Inc. sponsors a dedicated team that is responsible for reviewing and publishing all Official Repositories content. This team works in collaboration with upstream software maintainers, security experts, and the broader Docker community. These are not prefixed by an organization or user name. In the list of images above, the python , node , alpine and nginx images are official (base) images. To find out more about them, check out the Official Images Documentation . User images are images created and shared by users like you. They build on base images and add additional functionality. Typically these are formatted as user/image-name . The user value in the image name is your Docker Store user or organization name. 2.3 Create your first image Now that you have a better understanding of images, it's time to create your own. Our main objective here is to create an image that sandboxes a small Flask application. The goal of this exercise is to create a Docker image which will run a Flask app. We'll do this by first pulling together the components for a random cat picture generator built with Python Flask, then dockerizing it by writing a Dockerfile . Finally, we'll build the image, and then run it. 2.3.1 Create a Python Flask app that displays random cat pix. For the purposes of this workshop, we've created a fun little Python Flask app that displays a random cat .gif every time it is loaded - because, you know, who doesn't like cats? Start by creating a directory called flask-app where we'll create the following files: app.py requirements.txt templates/index.html Dockerfile Make sure to cd flask-app before you start creating the files, because you don't want to start adding a whole bunch of other random files to your image. app.py Create the app.py with the following content: from flask import Flask , render_template import random app = Flask ( __name__ ) # list of cat images images = [ \"https://c.tenor.com/GTcT7HODLRgAAAAM/smiling-cat-creepy-cat.gif\" , \"https://media0.giphy.com/media/10dU7AN7xsi1I4/giphy.webp?cid=ecf05e47gk63rd81vzlot57qmebr7drtgf6a3khmzvjsdtu7&rid=giphy.webp&ct=g\" , \"https://media0.giphy.com/media/S6VGjvmFRu5Qk/giphy.webp?cid=ecf05e478yofpawrhffnnvb3sgjkos96vyfo5mtqhds35as6&rid=giphy.webp&ct=g\" , \"https://media3.giphy.com/media/JIX9t2j0ZTN9S/200w.webp?cid=ecf05e47gk63rd81vzlot57qmebr7drtgf6a3khmzvjsdtu7&rid=200w.webp&ct=g\" ] @app . route ( '/' ) def index (): url = random . choice ( images ) return render_template ( 'index.html' , url = url ) if __name__ == \"__main__\" : app . run ( host = \"0.0.0.0\" ) requirements.txt In order to install the Python modules required for our app, we need to create a file called requirements.txt and add the following line to that file: Flask==3.1.0 templates/index.html Create a directory called templates and create an index.html file in that directory with the following content in it: < html > < head > < style type = \"text/css\" > body { background : black ; color : white ; } div . container { max-width : 500 px ; margin : 100 px auto ; border : 20 px solid white ; padding : 10 px ; text-align : center ; } h4 { text-transform : uppercase ; } </ style > </ head > < body > < div class = \"container\" > < h4 > Cat Gif of the day </ h4 > < img src = \"{{url}}\" /> < p >< small > Courtesy: < a href = \"http://www.buzzfeed.com/copyranter/the-best-cat-gif-post-in-the-history-of-cat-gifs\" > Buzzfeed </ a ></ small ></ p > </ div > </ body > </ html > 2.3.2 Write a Dockerfile We want to create a Docker image with this web app. As mentioned above, all user images are based on a base image. Since our application is written in Python, we will build our own Python image based on Alpine . We'll do that using a Dockerfile. A Dockerfile is a text file that contains a list of commands that the Docker daemon calls while creating an image. The Dockerfile contains all the information that Docker needs to know to run the app \u2014 a base Docker image to run from, location of your project code, any dependencies it has, and what commands to run at start-up. It is a simple way to automate the image creation process. The best part is that the commands you write in a Dockerfile are almost identical to their equivalent Linux commands. This means you don't really have to learn new syntax to create your own Dockerfiles. 1 - Create a file called Dockerfile, and add content to it as described below. We'll start by specifying our base image, using the FROM keyword. We are using alpine:3.21.0, a lightweight Linux distribution that helps keep our container small and efficient: FROM alpine:3.21.0 2 - Next, we need to install Python 3, pip, and other system dependencies required for our application. The apk add command is used to install packages in Alpine Linux. We use --no-cache to prevent unnecessary image bloat. Add the following RUN command: RUN apk add --no-cache build-base libffi-dev openssl-dev py3-pip python3 3 - Now, we set the working directory inside the container. This ensures that all subsequent commands run within this directory: WORKDIR /usr/src/app 4 - To create an isolated Python environment, we set up a virtual environment inside our container. This helps prevent conflicts between system-wide and project-specific dependencies: RUN python3 -m venv venv 5 - To ensure that all commands within the container use the virtual environment by default, we modify the PATH environment variable: ENV PATH = \"/usr/src/app/venv/bin: $PATH \" 6 - Next, we copy the application's dependencies file (requirements.txt) into the container and install the necessary Python packages. We also upgrade pip to the latest version to ensure compatibility: COPY requirements.txt ./ RUN pip install --no-cache-dir --upgrade pip && pip install --no-cache-dir -r requirements.txt 7 - Copy the files you have created earlier into our image by using COPY command. COPY app.py ./ COPY templates/index.html ./templates/ 8 - Since our Flask application runs on port 5000, we specify that this port should be exposed. This does not automatically publish the port but serves as documentation and can be used by orchestration tools: EXPOSE 5000 9 - The last step is the command for running the application which is simply - python ./app.py . Use the CMD command to do that: CMD [ \"python\" , \"/usr/src/app/app.py\" ] The primary purpose of CMD is to tell the container which command it should run by default when it is started. 10 - Verify your Dockerfile. Our Dockerfile is now ready. This is how it looks: # our base image FROM alpine:3.21.0 # Install Python 3, pip, and system dependencies RUN apk add --no-cache build-base libffi-dev openssl-dev py3-pip python3 # Set the working directory WORKDIR /usr/src/app # Create and activate a virtual environment RUN python3 -m venv venv # Use the virtual environment for all commands ENV PATH = \"/usr/src/app/venv/bin: $PATH \" # Copy and install dependencies COPY requirements.txt ./ RUN pip install --no-cache-dir --upgrade pip && pip install --no-cache-dir -r requirements.txt # Copy application files COPY app.py ./ COPY templates/index.html ./templates/ # Expose the application port EXPOSE 5000 # Run the application inside the virtual environment CMD [ \"python\" , \"/usr/src/app/app.py\" ] 2.3.3 Build the image Now that you have your Dockerfile , you can build your image. The docker build command does the heavy-lifting of creating a docker image from a Dockerfile . When you run the docker build command given below, make sure to replace <YOUR_USERNAME> with your username. This username should be the same one you created when registering on Docker Cloud . If you haven't done that yet, please go ahead and create an account. The docker build command is quite simple - it takes an optional tag name with the -t flag, and the location of the directory containing the Dockerfile - the . indicates the current directory: docker build -t <YOUR_USERNAME>/myfirstapp . If you don't have the alpine:3.21.0 image, the client will first pull the image and then create your image. Therefore, your output on running the command will look different from mine. If everything went well, your image should be ready! Run docker images and see if your image ( <YOUR_USERNAME>/myfirstapp ) shows. 2.3.4 Run your image The next step in this section is to run the image and see if it actually works. docker run -p 8888 :5000 --name myfirstapp YOUR_USERNAME/myfirstapp * Serving Flask app 'app' * Debug mode: off WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead. * Running on all addresses ( 0 .0.0.0 ) * Running on http://127.0.0.1:5000 * Running on http://172.17.0.2:5000 Press CTRL+C to quit Head over to http://localhost:8888 and your app should be live. Note If you are using Docker Machine, you may need to open up another terminal and determine the container ip address using docker-machine ip default . Hit the Refresh button in the web browser to see a few more cat images. Check Show us your running flask-app ! 2.3.4 Dockerfile commands summary Here's a quick summary of the few basic commands we used in our Dockerfile. FROM starts the Dockerfile. It is a requirement that the Dockerfile must start with the FROM command. Images are created in layers, which means you can use another image as the base image for your own. The FROM command defines your base layer. As arguments, it takes the name of the image. Optionally, you can add the Docker Cloud username of the maintainer and image version, in the format username/imagename:version . RUN is used to build up the Image you're creating. For each RUN command, Docker will run the command then create a new layer of the image. This way you can roll back your image to previous states easily. The syntax for a RUN instruction is to place the full text of the shell command after the RUN (e.g., RUN mkdir /user/local/foo ). This will automatically run in a /bin/sh shell. You can define a different shell like this: RUN /bin/bash -c 'mkdir /user/local/foo ' COPY copies local files into the container. CMD defines the commands that will run on the Image at start-up. Unlike a RUN , this does not create a new layer for the Image, but simply runs the command. There can only be one CMD per a Dockerfile/Image. If you need to run multiple commands, the best way to do that is to have the CMD run a script. CMD requires that you tell it where to run the command, unlike RUN . So example CMD commands would be: CMD [ \"python\" , \"./app.py\" ] CMD [ \"/bin/bash\" , \"echo\" , \"Hello World\" ] EXPOSE creates a hint for users of an image which ports provide services. It is included in the information which can be retrieved via docker inspect <container-id> . Note The EXPOSE command does not actually make any ports accessible to the host! Instead, this requires publishing ports by means of the -p flag when using docker run . Note If you want to learn more about Dockerfiles, check out Best practices for writing Dockerfiles . (source: https://github.com/docker/labs/tree/master/beginner ) Now that you know how to run docker container and create Dockerfiles let\u2019s move on to the practical part.","title":"TD part 01 - Docker"},{"location":"ch1-discover-docker-td/#discover-docker","text":"Check Checkpoint: call us to check your results (don\u2019t stay blocked on a checkpoint if we are busy, we can check \u2154 checkpoints at the same time) Question Point to document/report Tip Interesting information","title":"Discover Docker"},{"location":"ch1-discover-docker-td/#setup","text":"","title":"Setup"},{"location":"ch1-discover-docker-td/#prerequisites","text":"There are no specific skills needed for this tutorial beyond a basic comfort with the command line and using a text editor. Prior experience in developing web applications will be helpful but is not required. As you proceed further along the tutorial, we'll make use of https://cloud.docker.com/.","title":"Prerequisites"},{"location":"ch1-discover-docker-td/#setting-up-your-computer","text":"Getting all the tooling setup on your computer can be a daunting task, but getting Docker up and running on your favorite OS has become very easy. The getting started guide on Docker has detailed instructions for setting up Docker on Mac , Linux and Windows If you're using Docker for Windows make sure you have shared your drive. Important note If you're using an older version of Windows or MacOS you may need to use Docker Machine instead. All commands work in either bash or Powershell on Windows Once you are done installing Docker, test your Docker installation by running the following: docker run hello-world Unable to find image 'hello-world:latest' locally latest: Pulling from library/hello-world 03f4658f8b78: Pull complete a3ed95caeb02: Pull complete Digest: sha256:8be990ef2aeb16dbcb9271ddfe2610fa6658d13f6dfb8bc72074cc1ca36966a7 Status: Downloaded newer image for hello-world:latest Hello from Docker. ... This message shows that your installation appears to be working correctly.","title":"Setting up your computer"},{"location":"ch1-discover-docker-td/#running-your-first-container","text":"Now that you have everything setup, it's time to get our hands dirty. In this section, you are going to run an Alpine Linux container (a lightweight linux distribution) on your system and get a taste of the docker run command. To get started, let's run the following in our terminal: docker pull alpine Note Depending on how you've installed docker on your system, you might see a permission denied error after running the above command. Try the commands from the Getting Started tutorial to verify your installation . If you're on Linux, you may need to prefix your docker commands with sudo . Alternatively you can create a docker group to get rid of this issue. The pull command fetches the alpine image from the Docker registry and saves it in our system. You can use the docker images command to see a list of all images on your system. docker images REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE alpine latest c51f86c28340 4 weeks ago 1 .109 MB hello-world latest 690ed74de00f 5 months ago 960 B","title":"Running your first container"},{"location":"ch1-discover-docker-td/#11-docker-run","text":"Great! Let's now run a Docker container based on this image. To do that you are going to use the docker run command. docker run alpine ls -l total 48 drwxr-xr-x 2 root root 4096 Mar 2 16:20 bin drwxr-xr-x 5 root root 360 Mar 18 09:47 dev drwxr-xr-x 13 root root 4096 Mar 18 09:47 etc drwxr-xr-x 2 root root 4096 Mar 2 16:20 home drwxr-xr-x 5 root root 4096 Mar 2 16:20 lib ...... ...... What happened? Behind the scenes, a lot of stuff happened. When you call run : 1. The Docker client contacts the Docker daemon. The Docker daemon checks local store if the image (alpine in this case) is available locally, and if not, downloads it from Docker Store. (Since we have issued docker pull alpine before, the download step is not necessary) The Docker daemon creates the container and then runs a command in that container. The Docker daemon streams the output of the command to the Docker client When you run docker run alpine , you provided a command ( ls -l ), so Docker started the command specified and you saw the listing. Let's try something more exciting. docker run alpine echo \"hello from alpine\" hello from alpine OK, that's some actual output. In this case, the Docker client dutifully ran the echo command in our alpine container and then exited it. If you've noticed, all of that happened pretty quickly. Imagine booting up a virtual machine, running a command and then killing it. Now you know why they say containers are fast! Try another command. docker run alpine /bin/sh Wait, nothing happened! Is that a bug? Well, no. These interactive shells will exit after running any scripted commands, unless they are run in an interactive terminal - so for this example to not exit, you need to docker run -it alpine /bin/sh . You are now inside the container shell and you can try out a few commands like ls -l , uname -a and others. Exit out of the container by giving the exit command. Ok, now it's time to see the docker ps command. The docker ps command shows you all containers that are currently running. docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES Since no containers are running, you see a blank line. Let's try a more useful variant: docker ps -a docker ps -a CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 36171a5da744 alpine \"/bin/sh\" 5 minutes ago Exited ( 0 ) 2 minutes ago fervent_newton a6a9d46d0b2f alpine \"echo 'hello from alp\" 6 minutes ago Exited ( 0 ) 6 minutes ago lonely_kilby ff0a5c3750b9 alpine \"ls -l\" 8 minutes ago Exited ( 0 ) 8 minutes ago elated_ramanujan c317d0a9e3d2 hello-world \"/hello\" 34 seconds ago Exited ( 0 ) 12 minutes ago stupefied_mcclintock What you see above is a list of all containers that you ran. Notice that the STATUS column shows that these containers exited a few minutes ago. You're probably wondering if there is a way to run more than just one command in a container. Let's try that now: docker run -it alpine /bin/sh / # ls bin dev etc home lib linuxrc media mnt proc root run sbin sys tmp usr var / # uname -a Linux 97916e8cb5dc 4.4.27-moby #1 SMP Wed Oct 26 14:01:48 UTC 2016 x86_64 Linux Running the run command with the -it flags attaches us to an interactive tty in the container. Now you can run as many commands in the container as you want. Take some time to run your favorite commands. Tip run -it is a very useful command to debug at the lowest level a container. That concludes a whirlwind tour of the docker run command which would most likely be the command you'll use most often. It makes sense to spend some time getting comfortable with it. To find out more about run , use docker run --help to see a list of all flags it supports. As you proceed further, we'll see a few more variants of docker run.","title":"1.1 Docker Run"},{"location":"ch1-discover-docker-td/#12-terminology","text":"In the last section, you saw a lot of Docker-specific jargon which might be confusing to some. So before you go further, let's clarify some terminology that is used frequently in the Docker ecosystem. Images - The file system and configuration of our application which are used to create containers. To find out more about a Docker image, run docker inspect alpine . In the demo above, you used the docker pull command to download the alpine image. When you executed the command docker run hello-world , it also did a docker pull behind the scenes to download the hello-world image. Containers - Running instances of Docker images \u2014 containers run the actual applications. A container includes an application and all of its dependencies. It shares the kernel with other containers, and runs as an isolated process in user space on the host OS. You created a container using docker run which you did using the alpine image that you downloaded. A list of running containers can be seen using the docker ps command. Docker daemon - The background service running on the host that manages building, running and distributing Docker containers. Docker client - The command line tool that allows the user to interact with the Docker daemon. Docker Store - A registry of Docker images, where you can find trusted and enterprise ready containers, plugins, and Docker editions. You'll be using this later in this tutorial.","title":"1.2 Terminology"},{"location":"ch1-discover-docker-td/#20-webapps-with-docker","text":"Great! So you have now looked at docker run , played with a Docker container and also got the hang of some terminology. Armed with all this knowledge, you are now ready to get to the real stuff \u2014 deploying web applications with Docker.","title":"2.0 Webapps with Docker"},{"location":"ch1-discover-docker-td/#21-run-a-static-website-in-a-container","text":"Note Code for this section is in this repo in the static-site directory Let's start by taking baby-steps. First, we'll use Docker to run a static website in a container. The website is based on an existing image. We'll pull a Docker image from Docker Store, run the container, and see how easy it is to set up a web server. The image that you are going to use is a single-page website that was already created for this demo and is available on the Docker Store as dockersamples/static-site . You can download and run the image directly in one go using docker run as follows. docker run -d dockersamples/static-site Note The current version of this image doesn't run without the -d flag. The -d flag enables detached mode, which detaches the running container from the terminal/shell and returns your prompt after the container starts. We are debugging the problem with this image but for now, use -d even for this first example. Tip -d is a very useful option. So, what happens when you run this command? Since the image doesn't exist on your Docker host, the Docker daemon first fetches it from the registry and then runs it as a container. Now that the server is running, do you see the website? What port is it running on? And more importantly, how do you access the container directly from our host machine? Actually, you probably won't be able to answer any of these questions yet! \u263a In this case, the client didn't tell the Docker Engine to publish any of the ports, so you need to re-run the docker run command to add this instruction. Let's re-run the command with some new flags to publish ports and pass your name to the container to customize the message displayed. We'll use the -d option again to run the container in detached mode. First, stop the container that you have just launched. In order to do this, we need the container ID. Since we ran the container in detached mode, we don't have to launch another terminal to do this. Run docker ps to view the running containers. docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES a7a0e504ca3e dockersamples/static-site \"/bin/sh -c 'cd /usr/\" 28 seconds ago Up 26 seconds 80 /tcp, 443 /tcp stupefied_mahavira Check out the CONTAINER ID column. You will need to use this CONTAINER ID value, a long sequence of characters, to identify the container you want to stop, and then to remove it. The example below provides the CONTAINER ID on our system; you should use the value that you see in your terminal. docker stop a7a0e504ca3e docker rm a7a0e504ca3e Note A cool feature is that you do not need to specify the entire CONTAINER ID . You can just specify a few starting characters and if it is unique among all the containers that you have launched, the Docker client will intelligently pick it up. Now, let's launch a container in detached mode as shown below: docker run --name static-site -e AUTHOR = \"Enter Your Name Here\" -d -P dockersamples/static-site e61d12292d69556eabe2a44c16cbd54486b2527e2ce4f95438e504afb7b02810 In the above command: -d will create a container with the process detached from our terminal -P will publish all the exposed container ports to random ports on the Docker host -e is how you pass environment variables to the container. --name allows you to specify a container name AUTHOR is the environment variable name and Your Name is the value that you can pass. Now you can see the ports by running the docker port command. docker port static-site 443 /tcp -> 0 .0.0.0:32772 80 /tcp -> 0 .0.0.0:32773 You can open your freshly created website on http://localhost:[YOUR_PORT_FOR 80/tcp] . For our example this is http://localhost:32773 . You can now open http://localhost:[YOUR_PORT_FOR 80/tcp] to see your site live! For our example, this is: http://192.168.99.100:32773 . You can also run a second webserver at the same time, specifying a custom host port mapping to the container's webserver. docker run --name static-site-2 -e AUTHOR = \"Enter Your Name Here\" -d -p 8888 :80 dockersamples/static-site To deploy this on a real server you would just need to install Docker, and run the above docker command (as in this case you can see the AUTHOR is Docker which we passed as an environment variable). Now that you've seen how to run a webserver inside a Docker container, how do you create your own Docker image? This is the question we'll explore in the next section. But first, let's stop and remove the containers since you won't be using them anymore. docker stop static-site docker rm static-site Let's use a shortcut to remove the second site: docker rm -f static-site-2 Tip rm -f is a very useful option Run docker ps to make sure the containers are gone. docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES","title":"2.1 Run a static website in a container"},{"location":"ch1-discover-docker-td/#22-docker-images","text":"In this section, let's dive deeper into what Docker images are. You will build your own image, use that image to run an application locally, and finally, push some of your own images to Docker Cloud. Docker images are the basis of containers. In the previous example, you pulled the dockersamples/static-site image from the. registry and asked the Docker client to run a container based on that image. To see the list of images that are available locally on your system, run the docker images command. docker images REPOSITORY TAG IMAGE ID CREATED SIZE dockersamples/static-site latest 92a386b6e686 2 hours ago 190 .5 MB nginx latest af4b3d7d5401 3 hours ago 190 .5 MB python 2 .7 1c32174fd534 14 hours ago 676 .8 MB postgres 9 .4 88d845ac7a88 14 hours ago 263 .6 MB containous/traefik latest 27b4e0c6b2fd 4 days ago 20 .75 MB node 0 .10 42426a5cba5f 6 days ago 633 .7 MB redis latest 4f5f397d4b7c 7 days ago 177 .5 MB mongo latest 467eb21035a8 7 days ago 309 .7 MB alpine 3 .3 70c557e50ed6 8 days ago 4 .794 MB java 7 21f6ce84e43c 8 days ago 587 .7 MB Above is a list of images that I've pulled from the registry and those I've created myself (we'll shortly see how). You will have a different list of images on your machine. The TAG refers to a particular snapshot of the image and the ID is the corresponding unique identifier for that image. For simplicity, you can think of an image akin to a git repository - images can be committed with changes and have multiple. versions. When you do not provide a specific version number, the client defaults to latest. For example you could pull a specific version of ubuntu image as follows: docker pull ubuntu:12.04 If you do not specify the version number of the image then, as mentioned, the Docker client will default to a version named latest . So for example, the docker pull command given below will pull an image named ubuntu:latest : docker pull ubuntu To get a new Docker image you can either get it from a registry (such as the Docker Store) or create your own. There are hundreds of thousands of images available on Docker Store . You can also search for images directly from the command line using docker search . An important distinction with regard to images is between base images and child images . Base images are images that have no parent images, usually images with an OS like ubuntu, alpine or debian. Child images are images that build on base images and add additional functionality. Another key concept is the idea of official images and user images. (Both of which can be base images or child images.) Official images are Docker sanctioned images. Docker, Inc. sponsors a dedicated team that is responsible for reviewing and publishing all Official Repositories content. This team works in collaboration with upstream software maintainers, security experts, and the broader Docker community. These are not prefixed by an organization or user name. In the list of images above, the python , node , alpine and nginx images are official (base) images. To find out more about them, check out the Official Images Documentation . User images are images created and shared by users like you. They build on base images and add additional functionality. Typically these are formatted as user/image-name . The user value in the image name is your Docker Store user or organization name.","title":"2.2 Docker Images"},{"location":"ch1-discover-docker-td/#23-create-your-first-image","text":"Now that you have a better understanding of images, it's time to create your own. Our main objective here is to create an image that sandboxes a small Flask application. The goal of this exercise is to create a Docker image which will run a Flask app. We'll do this by first pulling together the components for a random cat picture generator built with Python Flask, then dockerizing it by writing a Dockerfile . Finally, we'll build the image, and then run it.","title":"2.3 Create your first image"},{"location":"ch1-discover-docker-td/#231-create-a-python-flask-app-that-displays-random-cat-pix","text":"For the purposes of this workshop, we've created a fun little Python Flask app that displays a random cat .gif every time it is loaded - because, you know, who doesn't like cats? Start by creating a directory called flask-app where we'll create the following files: app.py requirements.txt templates/index.html Dockerfile Make sure to cd flask-app before you start creating the files, because you don't want to start adding a whole bunch of other random files to your image.","title":"2.3.1 Create a Python Flask app that displays random cat pix."},{"location":"ch1-discover-docker-td/#apppy","text":"Create the app.py with the following content: from flask import Flask , render_template import random app = Flask ( __name__ ) # list of cat images images = [ \"https://c.tenor.com/GTcT7HODLRgAAAAM/smiling-cat-creepy-cat.gif\" , \"https://media0.giphy.com/media/10dU7AN7xsi1I4/giphy.webp?cid=ecf05e47gk63rd81vzlot57qmebr7drtgf6a3khmzvjsdtu7&rid=giphy.webp&ct=g\" , \"https://media0.giphy.com/media/S6VGjvmFRu5Qk/giphy.webp?cid=ecf05e478yofpawrhffnnvb3sgjkos96vyfo5mtqhds35as6&rid=giphy.webp&ct=g\" , \"https://media3.giphy.com/media/JIX9t2j0ZTN9S/200w.webp?cid=ecf05e47gk63rd81vzlot57qmebr7drtgf6a3khmzvjsdtu7&rid=200w.webp&ct=g\" ] @app . route ( '/' ) def index (): url = random . choice ( images ) return render_template ( 'index.html' , url = url ) if __name__ == \"__main__\" : app . run ( host = \"0.0.0.0\" )","title":"app.py"},{"location":"ch1-discover-docker-td/#requirementstxt","text":"In order to install the Python modules required for our app, we need to create a file called requirements.txt and add the following line to that file: Flask==3.1.0","title":"requirements.txt"},{"location":"ch1-discover-docker-td/#templatesindexhtml","text":"Create a directory called templates and create an index.html file in that directory with the following content in it: < html > < head > < style type = \"text/css\" > body { background : black ; color : white ; } div . container { max-width : 500 px ; margin : 100 px auto ; border : 20 px solid white ; padding : 10 px ; text-align : center ; } h4 { text-transform : uppercase ; } </ style > </ head > < body > < div class = \"container\" > < h4 > Cat Gif of the day </ h4 > < img src = \"{{url}}\" /> < p >< small > Courtesy: < a href = \"http://www.buzzfeed.com/copyranter/the-best-cat-gif-post-in-the-history-of-cat-gifs\" > Buzzfeed </ a ></ small ></ p > </ div > </ body > </ html >","title":"templates/index.html"},{"location":"ch1-discover-docker-td/#232-write-a-dockerfile","text":"We want to create a Docker image with this web app. As mentioned above, all user images are based on a base image. Since our application is written in Python, we will build our own Python image based on Alpine . We'll do that using a Dockerfile. A Dockerfile is a text file that contains a list of commands that the Docker daemon calls while creating an image. The Dockerfile contains all the information that Docker needs to know to run the app \u2014 a base Docker image to run from, location of your project code, any dependencies it has, and what commands to run at start-up. It is a simple way to automate the image creation process. The best part is that the commands you write in a Dockerfile are almost identical to their equivalent Linux commands. This means you don't really have to learn new syntax to create your own Dockerfiles. 1 - Create a file called Dockerfile, and add content to it as described below. We'll start by specifying our base image, using the FROM keyword. We are using alpine:3.21.0, a lightweight Linux distribution that helps keep our container small and efficient: FROM alpine:3.21.0 2 - Next, we need to install Python 3, pip, and other system dependencies required for our application. The apk add command is used to install packages in Alpine Linux. We use --no-cache to prevent unnecessary image bloat. Add the following RUN command: RUN apk add --no-cache build-base libffi-dev openssl-dev py3-pip python3 3 - Now, we set the working directory inside the container. This ensures that all subsequent commands run within this directory: WORKDIR /usr/src/app 4 - To create an isolated Python environment, we set up a virtual environment inside our container. This helps prevent conflicts between system-wide and project-specific dependencies: RUN python3 -m venv venv 5 - To ensure that all commands within the container use the virtual environment by default, we modify the PATH environment variable: ENV PATH = \"/usr/src/app/venv/bin: $PATH \" 6 - Next, we copy the application's dependencies file (requirements.txt) into the container and install the necessary Python packages. We also upgrade pip to the latest version to ensure compatibility: COPY requirements.txt ./ RUN pip install --no-cache-dir --upgrade pip && pip install --no-cache-dir -r requirements.txt 7 - Copy the files you have created earlier into our image by using COPY command. COPY app.py ./ COPY templates/index.html ./templates/ 8 - Since our Flask application runs on port 5000, we specify that this port should be exposed. This does not automatically publish the port but serves as documentation and can be used by orchestration tools: EXPOSE 5000 9 - The last step is the command for running the application which is simply - python ./app.py . Use the CMD command to do that: CMD [ \"python\" , \"/usr/src/app/app.py\" ] The primary purpose of CMD is to tell the container which command it should run by default when it is started. 10 - Verify your Dockerfile. Our Dockerfile is now ready. This is how it looks: # our base image FROM alpine:3.21.0 # Install Python 3, pip, and system dependencies RUN apk add --no-cache build-base libffi-dev openssl-dev py3-pip python3 # Set the working directory WORKDIR /usr/src/app # Create and activate a virtual environment RUN python3 -m venv venv # Use the virtual environment for all commands ENV PATH = \"/usr/src/app/venv/bin: $PATH \" # Copy and install dependencies COPY requirements.txt ./ RUN pip install --no-cache-dir --upgrade pip && pip install --no-cache-dir -r requirements.txt # Copy application files COPY app.py ./ COPY templates/index.html ./templates/ # Expose the application port EXPOSE 5000 # Run the application inside the virtual environment CMD [ \"python\" , \"/usr/src/app/app.py\" ]","title":"2.3.2 Write a Dockerfile"},{"location":"ch1-discover-docker-td/#233-build-the-image","text":"Now that you have your Dockerfile , you can build your image. The docker build command does the heavy-lifting of creating a docker image from a Dockerfile . When you run the docker build command given below, make sure to replace <YOUR_USERNAME> with your username. This username should be the same one you created when registering on Docker Cloud . If you haven't done that yet, please go ahead and create an account. The docker build command is quite simple - it takes an optional tag name with the -t flag, and the location of the directory containing the Dockerfile - the . indicates the current directory: docker build -t <YOUR_USERNAME>/myfirstapp . If you don't have the alpine:3.21.0 image, the client will first pull the image and then create your image. Therefore, your output on running the command will look different from mine. If everything went well, your image should be ready! Run docker images and see if your image ( <YOUR_USERNAME>/myfirstapp ) shows.","title":"2.3.3 Build the image"},{"location":"ch1-discover-docker-td/#234-run-your-image","text":"The next step in this section is to run the image and see if it actually works. docker run -p 8888 :5000 --name myfirstapp YOUR_USERNAME/myfirstapp * Serving Flask app 'app' * Debug mode: off WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead. * Running on all addresses ( 0 .0.0.0 ) * Running on http://127.0.0.1:5000 * Running on http://172.17.0.2:5000 Press CTRL+C to quit Head over to http://localhost:8888 and your app should be live. Note If you are using Docker Machine, you may need to open up another terminal and determine the container ip address using docker-machine ip default . Hit the Refresh button in the web browser to see a few more cat images. Check Show us your running flask-app !","title":"2.3.4 Run your image"},{"location":"ch1-discover-docker-td/#234-dockerfile-commands-summary","text":"Here's a quick summary of the few basic commands we used in our Dockerfile. FROM starts the Dockerfile. It is a requirement that the Dockerfile must start with the FROM command. Images are created in layers, which means you can use another image as the base image for your own. The FROM command defines your base layer. As arguments, it takes the name of the image. Optionally, you can add the Docker Cloud username of the maintainer and image version, in the format username/imagename:version . RUN is used to build up the Image you're creating. For each RUN command, Docker will run the command then create a new layer of the image. This way you can roll back your image to previous states easily. The syntax for a RUN instruction is to place the full text of the shell command after the RUN (e.g., RUN mkdir /user/local/foo ). This will automatically run in a /bin/sh shell. You can define a different shell like this: RUN /bin/bash -c 'mkdir /user/local/foo ' COPY copies local files into the container. CMD defines the commands that will run on the Image at start-up. Unlike a RUN , this does not create a new layer for the Image, but simply runs the command. There can only be one CMD per a Dockerfile/Image. If you need to run multiple commands, the best way to do that is to have the CMD run a script. CMD requires that you tell it where to run the command, unlike RUN . So example CMD commands would be: CMD [ \"python\" , \"./app.py\" ] CMD [ \"/bin/bash\" , \"echo\" , \"Hello World\" ] EXPOSE creates a hint for users of an image which ports provide services. It is included in the information which can be retrieved via docker inspect <container-id> . Note The EXPOSE command does not actually make any ports accessible to the host! Instead, this requires publishing ports by means of the -p flag when using docker run . Note If you want to learn more about Dockerfiles, check out Best practices for writing Dockerfiles . (source: https://github.com/docker/labs/tree/master/beginner ) Now that you know how to run docker container and create Dockerfiles let\u2019s move on to the practical part.","title":"2.3.4 Dockerfile commands summary"},{"location":"ch1-discover-docker-tp/","text":"Discover Docker Check Checkpoint: call us to check your results (don\u2019t stay blocked on a checkpoint if we are busy, we can check \u2154 checkpoints at the same time). Question Point to document/report. Tip Interesting information. Goals Good practice Do not forget to document what you do along the steps, the documentation provided will be evaluated as your report. Create an appropriate file structure, 1 folder per image. Target application 3-tiers application: HTTP server Backend API Database For each of those applications, we will follow the same process: choose the appropriate docker base image, create and configure this image, put our application specifics inside and at some point have it running. Our final goal is to have a 3-tier web API running. Base images HTTP server Backend API Database Database Basics We will use the image: postgres:17.2-alpine. Let\u2019s have a simple postgres server running, here is what would be a minimal Dockerfile: FROM postgres:17.2-alpine ENV POSTGRES_DB = db \\ POSTGRES_USER = usr \\ POSTGRES_PASSWORD = pwd Build this image and start a container properly. Your Postgres DB should be up and running. Check that everything is running smoothly with the docker command of your choice. Don\u2019t forget to name your docker image and container. Tip If you have difficulties go back to part 2.3.3 Build the image and 2.3.4 Run your image on TD01 - Docker ( TD 1 Discover Docker ). Re-run your database with adminer . Don't forget --network app-network to enable adminer/database communication. We use -\u2013network instead of -\u2013link because the latter is deprecated. Tip Don't forget to create your network docker network create app-network Also, does it seem right to have passwords written in plain text in a file? You may rather define those environment parameters when running the image using the flag -e . Question 1-1 For which reason is it better to run the container with a flag -e to give the environment variables rather than put them directly in the Dockerfile? It would be nice to have our database structure initialized with the docker image as well as some initial data. Any sql scripts found in /docker-entrypoint-initdb.d will be executed in alphabetical order, therefore let\u2019s add a couple scripts to our image: Tip Don't forget to restart the adminer: docker run \\ -p \"8090:8080\" \\ --net = app-network \\ --name = adminer \\ -d \\ adminer Init database 01-CreateScheme.sql CREATE TABLE public . departments ( id SERIAL PRIMARY KEY , name VARCHAR ( 20 ) NOT NULL ); CREATE TABLE public . students ( id SERIAL PRIMARY KEY , department_id INT NOT NULL REFERENCES departments ( id ), first_name VARCHAR ( 20 ) NOT NULL , last_name VARCHAR ( 20 ) NOT NULL ); 02-InsertData.sql INSERT INTO departments ( name ) VALUES ( 'IRC' ); INSERT INTO departments ( name ) VALUES ( 'ETI' ); INSERT INTO departments ( name ) VALUES ( 'CGP' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 1 , 'Eli' , 'Copter' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 2 , 'Emma' , 'Carena' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 2 , 'Jack' , 'Uzzi' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 3 , 'Aude' , 'Javel' ); Rebuild your image and check that your scripts have been executed at startup and that the data is present in your container. Tip When we talk about /docker-entrypoint-initdb.d it means inside the container, so you have to copy your directory's content and the container\u2019s directory. Persist data You may have noticed that if your database container gets destroyed then all your data is reset, a database must persist data durably. Use volumes to persist data on the host disk. -v /my/own/datadir:/var/lib/postgresql/data Check that data survives when your container gets destroyed. Link Docker volumes Question 1-2 Why do we need a volume to be attached to our postgres container? Question 1-3 Document your database container essentials: commands and Dockerfile. Backend API Basics For starters, we will simply run a Java hello-world class in our containers, only after will we be running a jar. In both cases, choose the proper image keeping in mind that we only need a Java runtime . Here is a complex Java Hello World implementation: Main.java public class Main { public static void main ( String [] args ) { System . out . println ( \"Hello World!\" ); } } 1- Compile with your target Java: javac Main.java . 2- Write dockerfile. FROM # TODO: Choose a java JRE # TODO: Add the compiled java (aka bytecode, aka .class) # TODO: Run the Java with: \u201cjava Main\u201d command. 3- Now, to launch app you have to do the same thing that Basic step 1. Here you have a first glimpse of your backend application. In the next step we will simply enrich the build (using maven instead of a minimalistic javac) and execute a jar instead of a simple .class. \u2192 If it\u2019s a success you must see \u201cHello Word\u201d in your console. Multistage build In the previous section we were building Java code on our machine to have it running on a docker container. Wouldn\u2019t it be great to have Docker handle the build as well? You probably noticed that the default openjdk docker images contain... Well... a JDK! Create a multistage build using the Multistage . Your Dockerfile should look like this: FROM eclipse-temurin:21-jdk-alpine # Build Main.java with JDK # TODO : in next steps (not now) FROM eclipse-temurin:21-jre-alpine # Copy resource from previous stage COPY --from = 0 /usr/src/Main.class . # Run java code with the JRE # TODO : in next steps (not now) Don\u2019t fill the Dockerfile now, we will have to do it in the next steps. Backend simple api We will deploy a Springboot application providing a simple API with a single greeting endpoint. Create your Springboot application on: Spring Initializer . Use the following config: Project: Maven Language: Java 21 Spring Boot: 3.4.2 Packaging: Jar Dependencies: Spring Web Generate the project and give it a simple GreetingController class: package fr.takima.training.simpleapi.controller ; import org.springframework.web.bind.annotation.* ; import java.util.concurrent.atomic.AtomicLong ; @RestController public class GreetingController { private static final String template = \"Hello, %s!\" ; private final AtomicLong counter = new AtomicLong (); @GetMapping ( \"/\" ) public Greeting greeting ( @RequestParam ( value = \"name\" , defaultValue = \"World\" ) String name ) { return new Greeting ( counter . incrementAndGet (), String . format ( template , name )); } record Greeting ( long id , String content ) {} } You can now build and start your application, of course you will need maven and a jdk-21. How convenient would it be to have a virtual container to build and run our simplistic API? Oh wait, we have docker, here is how you could build and run your application with Docker: # Build stage FROM eclipse-temurin:21-jdk-alpine AS myapp-build ENV MYAPP_HOME = /opt/myapp WORKDIR $MYAPP_HOME RUN apk add --no-cache maven COPY pom.xml . COPY src ./src RUN mvn package -DskipTests # Run stage FROM eclipse-temurin:21-jre-alpine ENV MYAPP_HOME = /opt/myapp WORKDIR $MYAPP_HOME COPY --from = myapp-build $MYAPP_HOME /target/*.jar $MYAPP_HOME /myapp.jar ENTRYPOINT [ \"java\" , \"-jar\" , \"myapp.jar\" ] Question 1-4 Why do we need a multistage build? And explain each step of this dockerfile. Check A working Springboot application with a simple HelloWorld endpoint. Did you notice that maven downloads all libraries on every image build? You can contribute to saving the planet caching libraries when maven pom file has not been changed by running the goal: mvn dependency:go-offline . Backend API Let\u2019s now build and run the backend API connected to the database. You can get the zipped source code here: simple-api . You can replace only your src directory and the pom.xml file with the ones available in the repository. Adjust the configuration in simple-api/src/main/resources/application.yml (this is the application configuration). How to access the database container from your backend application? Use the deprecated --link or create a docker network . Once everything is properly bound, you should be able to access your application API, for example on: /departments/IRC/students . [ { \"id\" : 1 , \"firstname\" : \"Eli\" , \"lastname\" : \"Copter\" , \"department\" : { \"id\" : 1 , \"name\" : \"IRC\" } } ] Explore your API other endpoints, have a look at the controllers in the source code. Check A simple web API on top of your database. Http server Basics Choose an appropriate base image. Create a simple landing page: index.html and put it inside your container. It should be enough for now, start your container and check that everything is working as expected. Here are commands that you may want to try to do so: docker stats docker inspect docker logs Link Httpd Getting Started Configuration You are using the default apache configuration, and it will be enough for now, you use yours by copying it in your image. Use docker exec to retrieve this default configuration from your running container /usr/local/apache2/conf/httpd.conf . Note You can also use docker cp . Reverse proxy We will configure the http server as a simple reverse proxy server in front of our application, this server could be used to deliver a front-end application, to configure SSL or to handle load balancing. So this can be quite useful even though in our case we will keep things simple. Here is the documentation: Reverse Proxy . Add the following to the configuration, and you should be all set: <VirtualHost *:80> ProxyPreserveHost On ProxyPass / http://YOUR_BACKEND_LINK:8080/ ProxyPassReverse / http://YOUR_BACKEND_LINK:8080/ </VirtualHost> LoadModule proxy_module modules/mod_proxy.so LoadModule proxy_http_module modules/mod_proxy_http.so Question 1-5 Why do we need a reverse proxy? Check Checkpoint: a working application through a reverse proxy. Link application Docker-compose 1- Install docker-compose if the docker compose command does not work . You may have noticed that this can be quite painful to orchestrate manually the start, stop and rebuild of our containers. Thankfully, a useful tool called docker-compose comes in handy in those situations. 2- Let\u2019s create a docker-compose.yml file with the following structure to define and drive our containers: services : backend : build : #TODO networks : #TODO depends_on : #TODO database : build : #TODO networks : #TODO httpd : build : #TODO ports : #TODO networks : #TODO depends_on : #TODO networks : #TODO volumes : #TODO The docker-compose will handle the three containers for us. The file above is a basic example of structure, you need to add more parameters and think about the cleanest and most optimized approach like you would do in a company (for example: env variables, volumes, restart policies and processes segregation). Once your containers are orchestrated as services by docker-compose you should have a perfectly running application, make sure you can access your API on localhost . Note The ports of both your backend and database should not be opened to your host machine. Question 1-6 Why is docker-compose so important? Question 1-7 Document docker-compose most important commands. Question 1-8 Document your docker-compose file. Check A working 3-tier application running with docker-compose. Publish Your docker images are stored locally, let\u2019s publish them, so they can be used by other team members or on other machines. You will need a Docker Hub account. 1- Connect to your freshly created account with docker login . 2- Tag your image. For now, we have been only using the latest tag, now that we want to publish it, let\u2019s add some meaningful version information to our images. docker tag my-database USERNAME/my-database:1.0 3- Then push your image to dockerhub: docker push USERNAME/my-database:1.0 Dockerhub is not the only docker image registry, and you can also self-host your images (this is obviously the choice of most companies). Once you publish your images to dockerhub, you will see them in your account: having some documentation for your image would be quite useful if you want to use those later. Question 1-9 Document your publication commands and published images in dockerhub. Question 1-10 Why do we put our images into an online repo? \u00a9 Takima 2025","title":"TP part 01 - Docker"},{"location":"ch1-discover-docker-tp/#discover-docker","text":"Check Checkpoint: call us to check your results (don\u2019t stay blocked on a checkpoint if we are busy, we can check \u2154 checkpoints at the same time). Question Point to document/report. Tip Interesting information.","title":"Discover Docker"},{"location":"ch1-discover-docker-tp/#goals","text":"","title":"Goals"},{"location":"ch1-discover-docker-tp/#good-practice","text":"Do not forget to document what you do along the steps, the documentation provided will be evaluated as your report. Create an appropriate file structure, 1 folder per image.","title":"Good practice"},{"location":"ch1-discover-docker-tp/#target-application","text":"3-tiers application: HTTP server Backend API Database For each of those applications, we will follow the same process: choose the appropriate docker base image, create and configure this image, put our application specifics inside and at some point have it running. Our final goal is to have a 3-tier web API running.","title":"Target application"},{"location":"ch1-discover-docker-tp/#base-images","text":"HTTP server Backend API Database","title":"Base images"},{"location":"ch1-discover-docker-tp/#database","text":"","title":"Database"},{"location":"ch1-discover-docker-tp/#basics","text":"We will use the image: postgres:17.2-alpine. Let\u2019s have a simple postgres server running, here is what would be a minimal Dockerfile: FROM postgres:17.2-alpine ENV POSTGRES_DB = db \\ POSTGRES_USER = usr \\ POSTGRES_PASSWORD = pwd Build this image and start a container properly. Your Postgres DB should be up and running. Check that everything is running smoothly with the docker command of your choice. Don\u2019t forget to name your docker image and container. Tip If you have difficulties go back to part 2.3.3 Build the image and 2.3.4 Run your image on TD01 - Docker ( TD 1 Discover Docker ). Re-run your database with adminer . Don't forget --network app-network to enable adminer/database communication. We use -\u2013network instead of -\u2013link because the latter is deprecated. Tip Don't forget to create your network docker network create app-network Also, does it seem right to have passwords written in plain text in a file? You may rather define those environment parameters when running the image using the flag -e . Question 1-1 For which reason is it better to run the container with a flag -e to give the environment variables rather than put them directly in the Dockerfile? It would be nice to have our database structure initialized with the docker image as well as some initial data. Any sql scripts found in /docker-entrypoint-initdb.d will be executed in alphabetical order, therefore let\u2019s add a couple scripts to our image: Tip Don't forget to restart the adminer: docker run \\ -p \"8090:8080\" \\ --net = app-network \\ --name = adminer \\ -d \\ adminer","title":"Basics"},{"location":"ch1-discover-docker-tp/#init-database","text":"01-CreateScheme.sql CREATE TABLE public . departments ( id SERIAL PRIMARY KEY , name VARCHAR ( 20 ) NOT NULL ); CREATE TABLE public . students ( id SERIAL PRIMARY KEY , department_id INT NOT NULL REFERENCES departments ( id ), first_name VARCHAR ( 20 ) NOT NULL , last_name VARCHAR ( 20 ) NOT NULL ); 02-InsertData.sql INSERT INTO departments ( name ) VALUES ( 'IRC' ); INSERT INTO departments ( name ) VALUES ( 'ETI' ); INSERT INTO departments ( name ) VALUES ( 'CGP' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 1 , 'Eli' , 'Copter' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 2 , 'Emma' , 'Carena' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 2 , 'Jack' , 'Uzzi' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 3 , 'Aude' , 'Javel' ); Rebuild your image and check that your scripts have been executed at startup and that the data is present in your container. Tip When we talk about /docker-entrypoint-initdb.d it means inside the container, so you have to copy your directory's content and the container\u2019s directory.","title":"Init database"},{"location":"ch1-discover-docker-tp/#persist-data","text":"You may have noticed that if your database container gets destroyed then all your data is reset, a database must persist data durably. Use volumes to persist data on the host disk. -v /my/own/datadir:/var/lib/postgresql/data Check that data survives when your container gets destroyed. Link Docker volumes Question 1-2 Why do we need a volume to be attached to our postgres container? Question 1-3 Document your database container essentials: commands and Dockerfile.","title":"Persist data"},{"location":"ch1-discover-docker-tp/#backend-api","text":"","title":"Backend API"},{"location":"ch1-discover-docker-tp/#basics_1","text":"For starters, we will simply run a Java hello-world class in our containers, only after will we be running a jar. In both cases, choose the proper image keeping in mind that we only need a Java runtime . Here is a complex Java Hello World implementation: Main.java public class Main { public static void main ( String [] args ) { System . out . println ( \"Hello World!\" ); } } 1- Compile with your target Java: javac Main.java . 2- Write dockerfile. FROM # TODO: Choose a java JRE # TODO: Add the compiled java (aka bytecode, aka .class) # TODO: Run the Java with: \u201cjava Main\u201d command. 3- Now, to launch app you have to do the same thing that Basic step 1. Here you have a first glimpse of your backend application. In the next step we will simply enrich the build (using maven instead of a minimalistic javac) and execute a jar instead of a simple .class. \u2192 If it\u2019s a success you must see \u201cHello Word\u201d in your console.","title":"Basics"},{"location":"ch1-discover-docker-tp/#multistage-build","text":"In the previous section we were building Java code on our machine to have it running on a docker container. Wouldn\u2019t it be great to have Docker handle the build as well? You probably noticed that the default openjdk docker images contain... Well... a JDK! Create a multistage build using the Multistage . Your Dockerfile should look like this: FROM eclipse-temurin:21-jdk-alpine # Build Main.java with JDK # TODO : in next steps (not now) FROM eclipse-temurin:21-jre-alpine # Copy resource from previous stage COPY --from = 0 /usr/src/Main.class . # Run java code with the JRE # TODO : in next steps (not now) Don\u2019t fill the Dockerfile now, we will have to do it in the next steps.","title":"Multistage build"},{"location":"ch1-discover-docker-tp/#backend-simple-api","text":"We will deploy a Springboot application providing a simple API with a single greeting endpoint. Create your Springboot application on: Spring Initializer . Use the following config: Project: Maven Language: Java 21 Spring Boot: 3.4.2 Packaging: Jar Dependencies: Spring Web Generate the project and give it a simple GreetingController class: package fr.takima.training.simpleapi.controller ; import org.springframework.web.bind.annotation.* ; import java.util.concurrent.atomic.AtomicLong ; @RestController public class GreetingController { private static final String template = \"Hello, %s!\" ; private final AtomicLong counter = new AtomicLong (); @GetMapping ( \"/\" ) public Greeting greeting ( @RequestParam ( value = \"name\" , defaultValue = \"World\" ) String name ) { return new Greeting ( counter . incrementAndGet (), String . format ( template , name )); } record Greeting ( long id , String content ) {} } You can now build and start your application, of course you will need maven and a jdk-21. How convenient would it be to have a virtual container to build and run our simplistic API? Oh wait, we have docker, here is how you could build and run your application with Docker: # Build stage FROM eclipse-temurin:21-jdk-alpine AS myapp-build ENV MYAPP_HOME = /opt/myapp WORKDIR $MYAPP_HOME RUN apk add --no-cache maven COPY pom.xml . COPY src ./src RUN mvn package -DskipTests # Run stage FROM eclipse-temurin:21-jre-alpine ENV MYAPP_HOME = /opt/myapp WORKDIR $MYAPP_HOME COPY --from = myapp-build $MYAPP_HOME /target/*.jar $MYAPP_HOME /myapp.jar ENTRYPOINT [ \"java\" , \"-jar\" , \"myapp.jar\" ] Question 1-4 Why do we need a multistage build? And explain each step of this dockerfile. Check A working Springboot application with a simple HelloWorld endpoint. Did you notice that maven downloads all libraries on every image build? You can contribute to saving the planet caching libraries when maven pom file has not been changed by running the goal: mvn dependency:go-offline .","title":"Backend simple api"},{"location":"ch1-discover-docker-tp/#backend-api_1","text":"Let\u2019s now build and run the backend API connected to the database. You can get the zipped source code here: simple-api . You can replace only your src directory and the pom.xml file with the ones available in the repository. Adjust the configuration in simple-api/src/main/resources/application.yml (this is the application configuration). How to access the database container from your backend application? Use the deprecated --link or create a docker network . Once everything is properly bound, you should be able to access your application API, for example on: /departments/IRC/students . [ { \"id\" : 1 , \"firstname\" : \"Eli\" , \"lastname\" : \"Copter\" , \"department\" : { \"id\" : 1 , \"name\" : \"IRC\" } } ] Explore your API other endpoints, have a look at the controllers in the source code. Check A simple web API on top of your database.","title":"Backend API"},{"location":"ch1-discover-docker-tp/#http-server","text":"","title":"Http server"},{"location":"ch1-discover-docker-tp/#basics_2","text":"","title":"Basics"},{"location":"ch1-discover-docker-tp/#choose-an-appropriate-base-image","text":"Create a simple landing page: index.html and put it inside your container. It should be enough for now, start your container and check that everything is working as expected. Here are commands that you may want to try to do so: docker stats docker inspect docker logs Link Httpd Getting Started","title":"Choose an appropriate base image."},{"location":"ch1-discover-docker-tp/#configuration","text":"You are using the default apache configuration, and it will be enough for now, you use yours by copying it in your image. Use docker exec to retrieve this default configuration from your running container /usr/local/apache2/conf/httpd.conf . Note You can also use docker cp .","title":"Configuration"},{"location":"ch1-discover-docker-tp/#reverse-proxy","text":"We will configure the http server as a simple reverse proxy server in front of our application, this server could be used to deliver a front-end application, to configure SSL or to handle load balancing. So this can be quite useful even though in our case we will keep things simple. Here is the documentation: Reverse Proxy . Add the following to the configuration, and you should be all set: <VirtualHost *:80> ProxyPreserveHost On ProxyPass / http://YOUR_BACKEND_LINK:8080/ ProxyPassReverse / http://YOUR_BACKEND_LINK:8080/ </VirtualHost> LoadModule proxy_module modules/mod_proxy.so LoadModule proxy_http_module modules/mod_proxy_http.so Question 1-5 Why do we need a reverse proxy? Check Checkpoint: a working application through a reverse proxy.","title":"Reverse proxy"},{"location":"ch1-discover-docker-tp/#link-application","text":"","title":"Link application"},{"location":"ch1-discover-docker-tp/#docker-compose","text":"1- Install docker-compose if the docker compose command does not work . You may have noticed that this can be quite painful to orchestrate manually the start, stop and rebuild of our containers. Thankfully, a useful tool called docker-compose comes in handy in those situations. 2- Let\u2019s create a docker-compose.yml file with the following structure to define and drive our containers: services : backend : build : #TODO networks : #TODO depends_on : #TODO database : build : #TODO networks : #TODO httpd : build : #TODO ports : #TODO networks : #TODO depends_on : #TODO networks : #TODO volumes : #TODO The docker-compose will handle the three containers for us. The file above is a basic example of structure, you need to add more parameters and think about the cleanest and most optimized approach like you would do in a company (for example: env variables, volumes, restart policies and processes segregation). Once your containers are orchestrated as services by docker-compose you should have a perfectly running application, make sure you can access your API on localhost . Note The ports of both your backend and database should not be opened to your host machine. Question 1-6 Why is docker-compose so important? Question 1-7 Document docker-compose most important commands. Question 1-8 Document your docker-compose file. Check A working 3-tier application running with docker-compose.","title":"Docker-compose"},{"location":"ch1-discover-docker-tp/#publish","text":"Your docker images are stored locally, let\u2019s publish them, so they can be used by other team members or on other machines. You will need a Docker Hub account. 1- Connect to your freshly created account with docker login . 2- Tag your image. For now, we have been only using the latest tag, now that we want to publish it, let\u2019s add some meaningful version information to our images. docker tag my-database USERNAME/my-database:1.0 3- Then push your image to dockerhub: docker push USERNAME/my-database:1.0 Dockerhub is not the only docker image registry, and you can also self-host your images (this is obviously the choice of most companies). Once you publish your images to dockerhub, you will see them in your account: having some documentation for your image would be quite useful if you want to use those later. Question 1-9 Document your publication commands and published images in dockerhub. Question 1-10 Why do we put our images into an online repo? \u00a9 Takima 2025","title":"Publish"},{"location":"cheatsheet/","text":"Cheatsheet Docker & docker-compose","title":"Cheatsheet"},{"location":"cheatsheet/#cheatsheet","text":"","title":"Cheatsheet"},{"location":"cheatsheet/#docker-docker-compose","text":"","title":"Docker & docker-compose"}]}
\ No newline at end of file
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Devops in Action - Guide For each step you have a TD to discover the subject and a TP to put it into practice. The TPs follow each other and the goal is to make you start from a local application and get to an application delivered in production and accessible to all. For that we will give you each a server and a Java application. Part 1 - Docker session Docker TDs are available here Docker TPs are available here Docker slides are available here Part 2 - Github Action session Github Actions TDs are available here Github Actions TPs are available here Github Actions slides are availabe here Please read the indications carefully, most of the time what you need is in front of your eyes! \u00a9 Takima 2025","title":"Devops in Action - Guide"},{"location":"#devops-in-action-guide","text":"For each step you have a TD to discover the subject and a TP to put it into practice. The TPs follow each other and the goal is to make you start from a local application and get to an application delivered in production and accessible to all. For that we will give you each a server and a Java application. Part 1 - Docker session Docker TDs are available here Docker TPs are available here Docker slides are available here Part 2 - Github Action session Github Actions TDs are available here Github Actions TPs are available here Github Actions slides are availabe here Please read the indications carefully, most of the time what you need is in front of your eyes! \u00a9 Takima 2025","title":"Devops in Action - Guide"},{"location":"ch1-discover-docker-td/","text":"Discover Docker Check Checkpoint: call us to check your results (don\u2019t stay blocked on a checkpoint if we are busy, we can check \u2154 checkpoints at the same time) Question Point to document/report Tip Interesting information Setup Prerequisites There are no specific skills needed for this tutorial beyond a basic comfort with the command line and using a text editor. Prior experience in developing web applications will be helpful but is not required. As you proceed further along the tutorial, we'll make use of https://cloud.docker.com/. Setting up your computer Getting all the tooling setup on your computer can be a daunting task, but getting Docker up and running on your favorite OS has become very easy. The getting started guide on Docker has detailed instructions for setting up Docker on Mac , Linux and Windows If you're using Docker for Windows make sure you have shared your drive. Important note If you're using an older version of Windows or MacOS you may need to use Docker Machine instead. All commands work in either bash or Powershell on Windows Once you are done installing Docker, test your Docker installation by running the following: docker run hello-world Unable to find image 'hello-world:latest' locally latest: Pulling from library/hello-world 03f4658f8b78: Pull complete a3ed95caeb02: Pull complete Digest: sha256:8be990ef2aeb16dbcb9271ddfe2610fa6658d13f6dfb8bc72074cc1ca36966a7 Status: Downloaded newer image for hello-world:latest Hello from Docker. ... This message shows that your installation appears to be working correctly. Running your first container Now that you have everything setup, it's time to get our hands dirty. In this section, you are going to run an Alpine Linux container (a lightweight linux distribution) on your system and get a taste of the docker run command. To get started, let's run the following in our terminal: docker pull alpine Note Depending on how you've installed docker on your system, you might see a permission denied error after running the above command. Try the commands from the Getting Started tutorial to verify your installation . If you're on Linux, you may need to prefix your docker commands with sudo . Alternatively you can create a docker group to get rid of this issue. The pull command fetches the alpine image from the Docker registry and saves it in our system. You can use the docker images command to see a list of all images on your system. docker images REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE alpine latest c51f86c28340 4 weeks ago 1 .109 MB hello-world latest 690ed74de00f 5 months ago 960 B 1.1 Docker Run Great! Let's now run a Docker container based on this image. To do that you are going to use the docker run command. docker run alpine ls -l total 48 drwxr-xr-x 2 root root 4096 Mar 2 16:20 bin drwxr-xr-x 5 root root 360 Mar 18 09:47 dev drwxr-xr-x 13 root root 4096 Mar 18 09:47 etc drwxr-xr-x 2 root root 4096 Mar 2 16:20 home drwxr-xr-x 5 root root 4096 Mar 2 16:20 lib ...... ...... What happened? Behind the scenes, a lot of stuff happened. When you call run : 1. The Docker client contacts the Docker daemon. The Docker daemon checks local store if the image (alpine in this case) is available locally, and if not, downloads it from Docker Store. (Since we have issued docker pull alpine before, the download step is not necessary) The Docker daemon creates the container and then runs a command in that container. The Docker daemon streams the output of the command to the Docker client When you run docker run alpine , you provided a command ( ls -l ), so Docker started the command specified and you saw the listing. Let's try something more exciting. docker run alpine echo \"hello from alpine\" hello from alpine OK, that's some actual output. In this case, the Docker client dutifully ran the echo command in our alpine container and then exited it. If you've noticed, all of that happened pretty quickly. Imagine booting up a virtual machine, running a command and then killing it. Now you know why they say containers are fast! Try another command. docker run alpine /bin/sh Wait, nothing happened! Is that a bug? Well, no. These interactive shells will exit after running any scripted commands, unless they are run in an interactive terminal - so for this example to not exit, you need to docker run -it alpine /bin/sh . You are now inside the container shell and you can try out a few commands like ls -l , uname -a and others. Exit out of the container by giving the exit command. Ok, now it's time to see the docker ps command. The docker ps command shows you all containers that are currently running. docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES Since no containers are running, you see a blank line. Let's try a more useful variant: docker ps -a docker ps -a CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 36171a5da744 alpine \"/bin/sh\" 5 minutes ago Exited ( 0 ) 2 minutes ago fervent_newton a6a9d46d0b2f alpine \"echo 'hello from alp\" 6 minutes ago Exited ( 0 ) 6 minutes ago lonely_kilby ff0a5c3750b9 alpine \"ls -l\" 8 minutes ago Exited ( 0 ) 8 minutes ago elated_ramanujan c317d0a9e3d2 hello-world \"/hello\" 34 seconds ago Exited ( 0 ) 12 minutes ago stupefied_mcclintock What you see above is a list of all containers that you ran. Notice that the STATUS column shows that these containers exited a few minutes ago. You're probably wondering if there is a way to run more than just one command in a container. Let's try that now: docker run -it alpine /bin/sh / # ls bin dev etc home lib linuxrc media mnt proc root run sbin sys tmp usr var / # uname -a Linux 97916e8cb5dc 4.4.27-moby #1 SMP Wed Oct 26 14:01:48 UTC 2016 x86_64 Linux Running the run command with the -it flags attaches us to an interactive tty in the container. Now you can run as many commands in the container as you want. Take some time to run your favorite commands. Tip run -it is a very useful command to debug at the lowest level a container. That concludes a whirlwind tour of the docker run command which would most likely be the command you'll use most often. It makes sense to spend some time getting comfortable with it. To find out more about run , use docker run --help to see a list of all flags it supports. As you proceed further, we'll see a few more variants of docker run. 1.2 Terminology In the last section, you saw a lot of Docker-specific jargon which might be confusing to some. So before you go further, let's clarify some terminology that is used frequently in the Docker ecosystem. Images - The file system and configuration of our application which are used to create containers. To find out more about a Docker image, run docker inspect alpine . In the demo above, you used the docker pull command to download the alpine image. When you executed the command docker run hello-world , it also did a docker pull behind the scenes to download the hello-world image. Containers - Running instances of Docker images \u2014 containers run the actual applications. A container includes an application and all of its dependencies. It shares the kernel with other containers, and runs as an isolated process in user space on the host OS. You created a container using docker run which you did using the alpine image that you downloaded. A list of running containers can be seen using the docker ps command. Docker daemon - The background service running on the host that manages building, running and distributing Docker containers. Docker client - The command line tool that allows the user to interact with the Docker daemon. Docker Store - A registry of Docker images, where you can find trusted and enterprise ready containers, plugins, and Docker editions. You'll be using this later in this tutorial. 2.0 Webapps with Docker Great! So you have now looked at docker run , played with a Docker container and also got the hang of some terminology. Armed with all this knowledge, you are now ready to get to the real stuff \u2014 deploying web applications with Docker. 2.1 Run a static website in a container Note Code for this section is in this repo in the static-site directory Let's start by taking baby-steps. First, we'll use Docker to run a static website in a container. The website is based on an existing image. We'll pull a Docker image from Docker Store, run the container, and see how easy it is to set up a web server. The image that you are going to use is a single-page website that was already created for this demo and is available on the Docker Store as dockersamples/static-site . You can download and run the image directly in one go using docker run as follows. docker run -d dockersamples/static-site Note The current version of this image doesn't run without the -d flag. The -d flag enables detached mode, which detaches the running container from the terminal/shell and returns your prompt after the container starts. We are debugging the problem with this image but for now, use -d even for this first example. Tip -d is a very useful option. So, what happens when you run this command? Since the image doesn't exist on your Docker host, the Docker daemon first fetches it from the registry and then runs it as a container. Now that the server is running, do you see the website? What port is it running on? And more importantly, how do you access the container directly from our host machine? Actually, you probably won't be able to answer any of these questions yet! \u263a In this case, the client didn't tell the Docker Engine to publish any of the ports, so you need to re-run the docker run command to add this instruction. Let's re-run the command with some new flags to publish ports and pass your name to the container to customize the message displayed. We'll use the -d option again to run the container in detached mode. First, stop the container that you have just launched. In order to do this, we need the container ID. Since we ran the container in detached mode, we don't have to launch another terminal to do this. Run docker ps to view the running containers. docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES a7a0e504ca3e dockersamples/static-site \"/bin/sh -c 'cd /usr/\" 28 seconds ago Up 26 seconds 80 /tcp, 443 /tcp stupefied_mahavira Check out the CONTAINER ID column. You will need to use this CONTAINER ID value, a long sequence of characters, to identify the container you want to stop, and then to remove it. The example below provides the CONTAINER ID on our system; you should use the value that you see in your terminal. docker stop a7a0e504ca3e docker rm a7a0e504ca3e Note A cool feature is that you do not need to specify the entire CONTAINER ID . You can just specify a few starting characters and if it is unique among all the containers that you have launched, the Docker client will intelligently pick it up. Now, let's launch a container in detached mode as shown below: docker run --name static-site -e AUTHOR = \"Enter Your Name Here\" -d -P dockersamples/static-site e61d12292d69556eabe2a44c16cbd54486b2527e2ce4f95438e504afb7b02810 In the above command: -d will create a container with the process detached from our terminal -P will publish all the exposed container ports to random ports on the Docker host -e is how you pass environment variables to the container. --name allows you to specify a container name AUTHOR is the environment variable name and Your Name is the value that you can pass. Now you can see the ports by running the docker port command. docker port static-site 443 /tcp -> 0 .0.0.0:32772 80 /tcp -> 0 .0.0.0:32773 You can open your freshly created website on http://localhost:[YOUR_PORT_FOR 80/tcp] . For our example this is http://localhost:32773 . You can now open http://localhost:[YOUR_PORT_FOR 80/tcp] to see your site live! For our example, this is: http://192.168.99.100:32773 . You can also run a second webserver at the same time, specifying a custom host port mapping to the container's webserver. docker run --name static-site-2 -e AUTHOR = \"Enter Your Name Here\" -d -p 8888 :80 dockersamples/static-site To deploy this on a real server you would just need to install Docker, and run the above docker command (as in this case you can see the AUTHOR is Docker which we passed as an environment variable). Now that you've seen how to run a webserver inside a Docker container, how do you create your own Docker image? This is the question we'll explore in the next section. But first, let's stop and remove the containers since you won't be using them anymore. docker stop static-site docker rm static-site Let's use a shortcut to remove the second site: docker rm -f static-site-2 Tip rm -f is a very useful option Run docker ps to make sure the containers are gone. docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 2.2 Docker Images In this section, let's dive deeper into what Docker images are. You will build your own image, use that image to run an application locally, and finally, push some of your own images to Docker Cloud. Docker images are the basis of containers. In the previous example, you pulled the dockersamples/static-site image from the. registry and asked the Docker client to run a container based on that image. To see the list of images that are available locally on your system, run the docker images command. docker images REPOSITORY TAG IMAGE ID CREATED SIZE dockersamples/static-site latest 92a386b6e686 2 hours ago 190 .5 MB nginx latest af4b3d7d5401 3 hours ago 190 .5 MB python 2 .7 1c32174fd534 14 hours ago 676 .8 MB postgres 9 .4 88d845ac7a88 14 hours ago 263 .6 MB containous/traefik latest 27b4e0c6b2fd 4 days ago 20 .75 MB node 0 .10 42426a5cba5f 6 days ago 633 .7 MB redis latest 4f5f397d4b7c 7 days ago 177 .5 MB mongo latest 467eb21035a8 7 days ago 309 .7 MB alpine 3 .3 70c557e50ed6 8 days ago 4 .794 MB java 7 21f6ce84e43c 8 days ago 587 .7 MB Above is a list of images that I've pulled from the registry and those I've created myself (we'll shortly see how). You will have a different list of images on your machine. The TAG refers to a particular snapshot of the image and the ID is the corresponding unique identifier for that image. For simplicity, you can think of an image akin to a git repository - images can be committed with changes and have multiple. versions. When you do not provide a specific version number, the client defaults to latest. For example you could pull a specific version of ubuntu image as follows: docker pull ubuntu:12.04 If you do not specify the version number of the image then, as mentioned, the Docker client will default to a version named latest . So for example, the docker pull command given below will pull an image named ubuntu:latest : docker pull ubuntu To get a new Docker image you can either get it from a registry (such as the Docker Store) or create your own. There are hundreds of thousands of images available on Docker Store . You can also search for images directly from the command line using docker search . An important distinction with regard to images is between base images and child images . Base images are images that have no parent images, usually images with an OS like ubuntu, alpine or debian. Child images are images that build on base images and add additional functionality. Another key concept is the idea of official images and user images. (Both of which can be base images or child images.) Official images are Docker sanctioned images. Docker, Inc. sponsors a dedicated team that is responsible for reviewing and publishing all Official Repositories content. This team works in collaboration with upstream software maintainers, security experts, and the broader Docker community. These are not prefixed by an organization or user name. In the list of images above, the python , node , alpine and nginx images are official (base) images. To find out more about them, check out the Official Images Documentation . User images are images created and shared by users like you. They build on base images and add additional functionality. Typically these are formatted as user/image-name . The user value in the image name is your Docker Store user or organization name. 2.3 Create your first image Now that you have a better understanding of images, it's time to create your own. Our main objective here is to create an image that sandboxes a small Flask application. The goal of this exercise is to create a Docker image which will run a Flask app. We'll do this by first pulling together the components for a random cat picture generator built with Python Flask, then dockerizing it by writing a Dockerfile . Finally, we'll build the image, and then run it. 2.3.1 Create a Python Flask app that displays random cat pix. For the purposes of this workshop, we've created a fun little Python Flask app that displays a random cat .gif every time it is loaded - because, you know, who doesn't like cats? Start by creating a directory called flask-app where we'll create the following files: app.py requirements.txt templates/index.html Dockerfile Make sure to cd flask-app before you start creating the files, because you don't want to start adding a whole bunch of other random files to your image. app.py Create the app.py with the following content: from flask import Flask , render_template import random app = Flask ( __name__ ) # list of cat images images = [ \"https://c.tenor.com/GTcT7HODLRgAAAAM/smiling-cat-creepy-cat.gif\" , \"https://media0.giphy.com/media/10dU7AN7xsi1I4/giphy.webp?cid=ecf05e47gk63rd81vzlot57qmebr7drtgf6a3khmzvjsdtu7&rid=giphy.webp&ct=g\" , \"https://media0.giphy.com/media/S6VGjvmFRu5Qk/giphy.webp?cid=ecf05e478yofpawrhffnnvb3sgjkos96vyfo5mtqhds35as6&rid=giphy.webp&ct=g\" , \"https://media3.giphy.com/media/JIX9t2j0ZTN9S/200w.webp?cid=ecf05e47gk63rd81vzlot57qmebr7drtgf6a3khmzvjsdtu7&rid=200w.webp&ct=g\" ] @app . route ( '/' ) def index (): url = random . choice ( images ) return render_template ( 'index.html' , url = url ) if __name__ == \"__main__\" : app . run ( host = \"0.0.0.0\" ) requirements.txt In order to install the Python modules required for our app, we need to create a file called requirements.txt and add the following line to that file: Flask==3.1.0 templates/index.html Create a directory called templates and create an index.html file in that directory with the following content in it: < html > < head > < style type = \"text/css\" > body { background : black ; color : white ; } div . container { max-width : 500 px ; margin : 100 px auto ; border : 20 px solid white ; padding : 10 px ; text-align : center ; } h4 { text-transform : uppercase ; } </ style > </ head > < body > < div class = \"container\" > < h4 > Cat Gif of the day </ h4 > < img src = \"{{url}}\" /> < p >< small > Courtesy: < a href = \"http://www.buzzfeed.com/copyranter/the-best-cat-gif-post-in-the-history-of-cat-gifs\" > Buzzfeed </ a ></ small ></ p > </ div > </ body > </ html > 2.3.2 Write a Dockerfile We want to create a Docker image with this web app. As mentioned above, all user images are based on a base image. Since our application is written in Python, we will build our own Python image based on Alpine . We'll do that using a Dockerfile. A Dockerfile is a text file that contains a list of commands that the Docker daemon calls while creating an image. The Dockerfile contains all the information that Docker needs to know to run the app \u2014 a base Docker image to run from, location of your project code, any dependencies it has, and what commands to run at start-up. It is a simple way to automate the image creation process. The best part is that the commands you write in a Dockerfile are almost identical to their equivalent Linux commands. This means you don't really have to learn new syntax to create your own Dockerfiles. 1 - Create a file called Dockerfile, and add content to it as described below. We'll start by specifying our base image, using the FROM keyword. We are using alpine:3.21.0, a lightweight Linux distribution that helps keep our container small and efficient: FROM alpine:3.21.0 2 - Next, we need to install Python 3, pip, and other system dependencies required for our application. The apk add command is used to install packages in Alpine Linux. We use --no-cache to prevent unnecessary image bloat. Add the following RUN command: RUN apk add --no-cache build-base libffi-dev openssl-dev py3-pip python3 3 - Now, we set the working directory inside the container. This ensures that all subsequent commands run within this directory: WORKDIR /usr/src/app 4 - To create an isolated Python environment, we set up a virtual environment inside our container. This helps prevent conflicts between system-wide and project-specific dependencies: RUN python3 -m venv venv 5 - To ensure that all commands within the container use the virtual environment by default, we modify the PATH environment variable: ENV PATH = \"/usr/src/app/venv/bin: $PATH \" 6 - Next, we copy the application's dependencies file (requirements.txt) into the container and install the necessary Python packages. We also upgrade pip to the latest version to ensure compatibility: COPY requirements.txt ./ RUN pip install --no-cache-dir --upgrade pip && pip install --no-cache-dir -r requirements.txt 7 - Copy the files you have created earlier into our image by using COPY command. COPY app.py ./ COPY templates/index.html ./templates/ 8 - Since our Flask application runs on port 5000, we specify that this port should be exposed. This does not automatically publish the port but serves as documentation and can be used by orchestration tools: EXPOSE 5000 9 - The last step is the command for running the application which is simply - python ./app.py . Use the CMD command to do that: CMD [ \"python\" , \"/usr/src/app/app.py\" ] The primary purpose of CMD is to tell the container which command it should run by default when it is started. 10 - Verify your Dockerfile. Our Dockerfile is now ready. This is how it looks: # our base image FROM alpine:3.21.0 # Install Python 3, pip, and system dependencies RUN apk add --no-cache build-base libffi-dev openssl-dev py3-pip python3 # Set the working directory WORKDIR /usr/src/app # Create and activate a virtual environment RUN python3 -m venv venv # Use the virtual environment for all commands ENV PATH = \"/usr/src/app/venv/bin: $PATH \" # Copy and install dependencies COPY requirements.txt ./ RUN pip install --no-cache-dir --upgrade pip && pip install --no-cache-dir -r requirements.txt # Copy application files COPY app.py ./ COPY templates/index.html ./templates/ # Expose the application port EXPOSE 5000 # Run the application inside the virtual environment CMD [ \"python\" , \"/usr/src/app/app.py\" ] 2.3.3 Build the image Now that you have your Dockerfile , you can build your image. The docker build command does the heavy-lifting of creating a docker image from a Dockerfile . When you run the docker build command given below, make sure to replace <YOUR_USERNAME> with your username. This username should be the same one you created when registering on Docker Cloud . If you haven't done that yet, please go ahead and create an account. The docker build command is quite simple - it takes an optional tag name with the -t flag, and the location of the directory containing the Dockerfile - the . indicates the current directory: docker build -t <YOUR_USERNAME>/myfirstapp . If you don't have the alpine:3.21.0 image, the client will first pull the image and then create your image. Therefore, your output on running the command will look different from mine. If everything went well, your image should be ready! Run docker images and see if your image ( <YOUR_USERNAME>/myfirstapp ) shows. 2.3.4 Run your image The next step in this section is to run the image and see if it actually works. docker run -p 8888 :5000 --name myfirstapp YOUR_USERNAME/myfirstapp * Serving Flask app 'app' * Debug mode: off WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead. * Running on all addresses ( 0 .0.0.0 ) * Running on http://127.0.0.1:5000 * Running on http://172.17.0.2:5000 Press CTRL+C to quit Head over to http://localhost:8888 and your app should be live. Note If you are using Docker Machine, you may need to open up another terminal and determine the container ip address using docker-machine ip default . Hit the Refresh button in the web browser to see a few more cat images. Check Show us your running flask-app ! 2.3.4 Dockerfile commands summary Here's a quick summary of the few basic commands we used in our Dockerfile. FROM starts the Dockerfile. It is a requirement that the Dockerfile must start with the FROM command. Images are created in layers, which means you can use another image as the base image for your own. The FROM command defines your base layer. As arguments, it takes the name of the image. Optionally, you can add the Docker Cloud username of the maintainer and image version, in the format username/imagename:version . RUN is used to build up the Image you're creating. For each RUN command, Docker will run the command then create a new layer of the image. This way you can roll back your image to previous states easily. The syntax for a RUN instruction is to place the full text of the shell command after the RUN (e.g., RUN mkdir /user/local/foo ). This will automatically run in a /bin/sh shell. You can define a different shell like this: RUN /bin/bash -c 'mkdir /user/local/foo ' COPY copies local files into the container. CMD defines the commands that will run on the Image at start-up. Unlike a RUN , this does not create a new layer for the Image, but simply runs the command. There can only be one CMD per a Dockerfile/Image. If you need to run multiple commands, the best way to do that is to have the CMD run a script. CMD requires that you tell it where to run the command, unlike RUN . So example CMD commands would be: CMD [ \"python\" , \"./app.py\" ] CMD [ \"/bin/bash\" , \"echo\" , \"Hello World\" ] EXPOSE creates a hint for users of an image which ports provide services. It is included in the information which can be retrieved via docker inspect <container-id> . Note The EXPOSE command does not actually make any ports accessible to the host! Instead, this requires publishing ports by means of the -p flag when using docker run . Note If you want to learn more about Dockerfiles, check out Best practices for writing Dockerfiles . (source: https://github.com/docker/labs/tree/master/beginner ) Now that you know how to run docker container and create Dockerfiles let\u2019s move on to the practical part.","title":"TD part 01 - Docker"},{"location":"ch1-discover-docker-td/#discover-docker","text":"Check Checkpoint: call us to check your results (don\u2019t stay blocked on a checkpoint if we are busy, we can check \u2154 checkpoints at the same time) Question Point to document/report Tip Interesting information","title":"Discover Docker"},{"location":"ch1-discover-docker-td/#setup","text":"","title":"Setup"},{"location":"ch1-discover-docker-td/#prerequisites","text":"There are no specific skills needed for this tutorial beyond a basic comfort with the command line and using a text editor. Prior experience in developing web applications will be helpful but is not required. As you proceed further along the tutorial, we'll make use of https://cloud.docker.com/.","title":"Prerequisites"},{"location":"ch1-discover-docker-td/#setting-up-your-computer","text":"Getting all the tooling setup on your computer can be a daunting task, but getting Docker up and running on your favorite OS has become very easy. The getting started guide on Docker has detailed instructions for setting up Docker on Mac , Linux and Windows If you're using Docker for Windows make sure you have shared your drive. Important note If you're using an older version of Windows or MacOS you may need to use Docker Machine instead. All commands work in either bash or Powershell on Windows Once you are done installing Docker, test your Docker installation by running the following: docker run hello-world Unable to find image 'hello-world:latest' locally latest: Pulling from library/hello-world 03f4658f8b78: Pull complete a3ed95caeb02: Pull complete Digest: sha256:8be990ef2aeb16dbcb9271ddfe2610fa6658d13f6dfb8bc72074cc1ca36966a7 Status: Downloaded newer image for hello-world:latest Hello from Docker. ... This message shows that your installation appears to be working correctly.","title":"Setting up your computer"},{"location":"ch1-discover-docker-td/#running-your-first-container","text":"Now that you have everything setup, it's time to get our hands dirty. In this section, you are going to run an Alpine Linux container (a lightweight linux distribution) on your system and get a taste of the docker run command. To get started, let's run the following in our terminal: docker pull alpine Note Depending on how you've installed docker on your system, you might see a permission denied error after running the above command. Try the commands from the Getting Started tutorial to verify your installation . If you're on Linux, you may need to prefix your docker commands with sudo . Alternatively you can create a docker group to get rid of this issue. The pull command fetches the alpine image from the Docker registry and saves it in our system. You can use the docker images command to see a list of all images on your system. docker images REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE alpine latest c51f86c28340 4 weeks ago 1 .109 MB hello-world latest 690ed74de00f 5 months ago 960 B","title":"Running your first container"},{"location":"ch1-discover-docker-td/#11-docker-run","text":"Great! Let's now run a Docker container based on this image. To do that you are going to use the docker run command. docker run alpine ls -l total 48 drwxr-xr-x 2 root root 4096 Mar 2 16:20 bin drwxr-xr-x 5 root root 360 Mar 18 09:47 dev drwxr-xr-x 13 root root 4096 Mar 18 09:47 etc drwxr-xr-x 2 root root 4096 Mar 2 16:20 home drwxr-xr-x 5 root root 4096 Mar 2 16:20 lib ...... ...... What happened? Behind the scenes, a lot of stuff happened. When you call run : 1. The Docker client contacts the Docker daemon. The Docker daemon checks local store if the image (alpine in this case) is available locally, and if not, downloads it from Docker Store. (Since we have issued docker pull alpine before, the download step is not necessary) The Docker daemon creates the container and then runs a command in that container. The Docker daemon streams the output of the command to the Docker client When you run docker run alpine , you provided a command ( ls -l ), so Docker started the command specified and you saw the listing. Let's try something more exciting. docker run alpine echo \"hello from alpine\" hello from alpine OK, that's some actual output. In this case, the Docker client dutifully ran the echo command in our alpine container and then exited it. If you've noticed, all of that happened pretty quickly. Imagine booting up a virtual machine, running a command and then killing it. Now you know why they say containers are fast! Try another command. docker run alpine /bin/sh Wait, nothing happened! Is that a bug? Well, no. These interactive shells will exit after running any scripted commands, unless they are run in an interactive terminal - so for this example to not exit, you need to docker run -it alpine /bin/sh . You are now inside the container shell and you can try out a few commands like ls -l , uname -a and others. Exit out of the container by giving the exit command. Ok, now it's time to see the docker ps command. The docker ps command shows you all containers that are currently running. docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES Since no containers are running, you see a blank line. Let's try a more useful variant: docker ps -a docker ps -a CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 36171a5da744 alpine \"/bin/sh\" 5 minutes ago Exited ( 0 ) 2 minutes ago fervent_newton a6a9d46d0b2f alpine \"echo 'hello from alp\" 6 minutes ago Exited ( 0 ) 6 minutes ago lonely_kilby ff0a5c3750b9 alpine \"ls -l\" 8 minutes ago Exited ( 0 ) 8 minutes ago elated_ramanujan c317d0a9e3d2 hello-world \"/hello\" 34 seconds ago Exited ( 0 ) 12 minutes ago stupefied_mcclintock What you see above is a list of all containers that you ran. Notice that the STATUS column shows that these containers exited a few minutes ago. You're probably wondering if there is a way to run more than just one command in a container. Let's try that now: docker run -it alpine /bin/sh / # ls bin dev etc home lib linuxrc media mnt proc root run sbin sys tmp usr var / # uname -a Linux 97916e8cb5dc 4.4.27-moby #1 SMP Wed Oct 26 14:01:48 UTC 2016 x86_64 Linux Running the run command with the -it flags attaches us to an interactive tty in the container. Now you can run as many commands in the container as you want. Take some time to run your favorite commands. Tip run -it is a very useful command to debug at the lowest level a container. That concludes a whirlwind tour of the docker run command which would most likely be the command you'll use most often. It makes sense to spend some time getting comfortable with it. To find out more about run , use docker run --help to see a list of all flags it supports. As you proceed further, we'll see a few more variants of docker run.","title":"1.1 Docker Run"},{"location":"ch1-discover-docker-td/#12-terminology","text":"In the last section, you saw a lot of Docker-specific jargon which might be confusing to some. So before you go further, let's clarify some terminology that is used frequently in the Docker ecosystem. Images - The file system and configuration of our application which are used to create containers. To find out more about a Docker image, run docker inspect alpine . In the demo above, you used the docker pull command to download the alpine image. When you executed the command docker run hello-world , it also did a docker pull behind the scenes to download the hello-world image. Containers - Running instances of Docker images \u2014 containers run the actual applications. A container includes an application and all of its dependencies. It shares the kernel with other containers, and runs as an isolated process in user space on the host OS. You created a container using docker run which you did using the alpine image that you downloaded. A list of running containers can be seen using the docker ps command. Docker daemon - The background service running on the host that manages building, running and distributing Docker containers. Docker client - The command line tool that allows the user to interact with the Docker daemon. Docker Store - A registry of Docker images, where you can find trusted and enterprise ready containers, plugins, and Docker editions. You'll be using this later in this tutorial.","title":"1.2 Terminology"},{"location":"ch1-discover-docker-td/#20-webapps-with-docker","text":"Great! So you have now looked at docker run , played with a Docker container and also got the hang of some terminology. Armed with all this knowledge, you are now ready to get to the real stuff \u2014 deploying web applications with Docker.","title":"2.0 Webapps with Docker"},{"location":"ch1-discover-docker-td/#21-run-a-static-website-in-a-container","text":"Note Code for this section is in this repo in the static-site directory Let's start by taking baby-steps. First, we'll use Docker to run a static website in a container. The website is based on an existing image. We'll pull a Docker image from Docker Store, run the container, and see how easy it is to set up a web server. The image that you are going to use is a single-page website that was already created for this demo and is available on the Docker Store as dockersamples/static-site . You can download and run the image directly in one go using docker run as follows. docker run -d dockersamples/static-site Note The current version of this image doesn't run without the -d flag. The -d flag enables detached mode, which detaches the running container from the terminal/shell and returns your prompt after the container starts. We are debugging the problem with this image but for now, use -d even for this first example. Tip -d is a very useful option. So, what happens when you run this command? Since the image doesn't exist on your Docker host, the Docker daemon first fetches it from the registry and then runs it as a container. Now that the server is running, do you see the website? What port is it running on? And more importantly, how do you access the container directly from our host machine? Actually, you probably won't be able to answer any of these questions yet! \u263a In this case, the client didn't tell the Docker Engine to publish any of the ports, so you need to re-run the docker run command to add this instruction. Let's re-run the command with some new flags to publish ports and pass your name to the container to customize the message displayed. We'll use the -d option again to run the container in detached mode. First, stop the container that you have just launched. In order to do this, we need the container ID. Since we ran the container in detached mode, we don't have to launch another terminal to do this. Run docker ps to view the running containers. docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES a7a0e504ca3e dockersamples/static-site \"/bin/sh -c 'cd /usr/\" 28 seconds ago Up 26 seconds 80 /tcp, 443 /tcp stupefied_mahavira Check out the CONTAINER ID column. You will need to use this CONTAINER ID value, a long sequence of characters, to identify the container you want to stop, and then to remove it. The example below provides the CONTAINER ID on our system; you should use the value that you see in your terminal. docker stop a7a0e504ca3e docker rm a7a0e504ca3e Note A cool feature is that you do not need to specify the entire CONTAINER ID . You can just specify a few starting characters and if it is unique among all the containers that you have launched, the Docker client will intelligently pick it up. Now, let's launch a container in detached mode as shown below: docker run --name static-site -e AUTHOR = \"Enter Your Name Here\" -d -P dockersamples/static-site e61d12292d69556eabe2a44c16cbd54486b2527e2ce4f95438e504afb7b02810 In the above command: -d will create a container with the process detached from our terminal -P will publish all the exposed container ports to random ports on the Docker host -e is how you pass environment variables to the container. --name allows you to specify a container name AUTHOR is the environment variable name and Your Name is the value that you can pass. Now you can see the ports by running the docker port command. docker port static-site 443 /tcp -> 0 .0.0.0:32772 80 /tcp -> 0 .0.0.0:32773 You can open your freshly created website on http://localhost:[YOUR_PORT_FOR 80/tcp] . For our example this is http://localhost:32773 . You can now open http://localhost:[YOUR_PORT_FOR 80/tcp] to see your site live! For our example, this is: http://192.168.99.100:32773 . You can also run a second webserver at the same time, specifying a custom host port mapping to the container's webserver. docker run --name static-site-2 -e AUTHOR = \"Enter Your Name Here\" -d -p 8888 :80 dockersamples/static-site To deploy this on a real server you would just need to install Docker, and run the above docker command (as in this case you can see the AUTHOR is Docker which we passed as an environment variable). Now that you've seen how to run a webserver inside a Docker container, how do you create your own Docker image? This is the question we'll explore in the next section. But first, let's stop and remove the containers since you won't be using them anymore. docker stop static-site docker rm static-site Let's use a shortcut to remove the second site: docker rm -f static-site-2 Tip rm -f is a very useful option Run docker ps to make sure the containers are gone. docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES","title":"2.1 Run a static website in a container"},{"location":"ch1-discover-docker-td/#22-docker-images","text":"In this section, let's dive deeper into what Docker images are. You will build your own image, use that image to run an application locally, and finally, push some of your own images to Docker Cloud. Docker images are the basis of containers. In the previous example, you pulled the dockersamples/static-site image from the. registry and asked the Docker client to run a container based on that image. To see the list of images that are available locally on your system, run the docker images command. docker images REPOSITORY TAG IMAGE ID CREATED SIZE dockersamples/static-site latest 92a386b6e686 2 hours ago 190 .5 MB nginx latest af4b3d7d5401 3 hours ago 190 .5 MB python 2 .7 1c32174fd534 14 hours ago 676 .8 MB postgres 9 .4 88d845ac7a88 14 hours ago 263 .6 MB containous/traefik latest 27b4e0c6b2fd 4 days ago 20 .75 MB node 0 .10 42426a5cba5f 6 days ago 633 .7 MB redis latest 4f5f397d4b7c 7 days ago 177 .5 MB mongo latest 467eb21035a8 7 days ago 309 .7 MB alpine 3 .3 70c557e50ed6 8 days ago 4 .794 MB java 7 21f6ce84e43c 8 days ago 587 .7 MB Above is a list of images that I've pulled from the registry and those I've created myself (we'll shortly see how). You will have a different list of images on your machine. The TAG refers to a particular snapshot of the image and the ID is the corresponding unique identifier for that image. For simplicity, you can think of an image akin to a git repository - images can be committed with changes and have multiple. versions. When you do not provide a specific version number, the client defaults to latest. For example you could pull a specific version of ubuntu image as follows: docker pull ubuntu:12.04 If you do not specify the version number of the image then, as mentioned, the Docker client will default to a version named latest . So for example, the docker pull command given below will pull an image named ubuntu:latest : docker pull ubuntu To get a new Docker image you can either get it from a registry (such as the Docker Store) or create your own. There are hundreds of thousands of images available on Docker Store . You can also search for images directly from the command line using docker search . An important distinction with regard to images is between base images and child images . Base images are images that have no parent images, usually images with an OS like ubuntu, alpine or debian. Child images are images that build on base images and add additional functionality. Another key concept is the idea of official images and user images. (Both of which can be base images or child images.) Official images are Docker sanctioned images. Docker, Inc. sponsors a dedicated team that is responsible for reviewing and publishing all Official Repositories content. This team works in collaboration with upstream software maintainers, security experts, and the broader Docker community. These are not prefixed by an organization or user name. In the list of images above, the python , node , alpine and nginx images are official (base) images. To find out more about them, check out the Official Images Documentation . User images are images created and shared by users like you. They build on base images and add additional functionality. Typically these are formatted as user/image-name . The user value in the image name is your Docker Store user or organization name.","title":"2.2 Docker Images"},{"location":"ch1-discover-docker-td/#23-create-your-first-image","text":"Now that you have a better understanding of images, it's time to create your own. Our main objective here is to create an image that sandboxes a small Flask application. The goal of this exercise is to create a Docker image which will run a Flask app. We'll do this by first pulling together the components for a random cat picture generator built with Python Flask, then dockerizing it by writing a Dockerfile . Finally, we'll build the image, and then run it.","title":"2.3 Create your first image"},{"location":"ch1-discover-docker-td/#231-create-a-python-flask-app-that-displays-random-cat-pix","text":"For the purposes of this workshop, we've created a fun little Python Flask app that displays a random cat .gif every time it is loaded - because, you know, who doesn't like cats? Start by creating a directory called flask-app where we'll create the following files: app.py requirements.txt templates/index.html Dockerfile Make sure to cd flask-app before you start creating the files, because you don't want to start adding a whole bunch of other random files to your image.","title":"2.3.1 Create a Python Flask app that displays random cat pix."},{"location":"ch1-discover-docker-td/#apppy","text":"Create the app.py with the following content: from flask import Flask , render_template import random app = Flask ( __name__ ) # list of cat images images = [ \"https://c.tenor.com/GTcT7HODLRgAAAAM/smiling-cat-creepy-cat.gif\" , \"https://media0.giphy.com/media/10dU7AN7xsi1I4/giphy.webp?cid=ecf05e47gk63rd81vzlot57qmebr7drtgf6a3khmzvjsdtu7&rid=giphy.webp&ct=g\" , \"https://media0.giphy.com/media/S6VGjvmFRu5Qk/giphy.webp?cid=ecf05e478yofpawrhffnnvb3sgjkos96vyfo5mtqhds35as6&rid=giphy.webp&ct=g\" , \"https://media3.giphy.com/media/JIX9t2j0ZTN9S/200w.webp?cid=ecf05e47gk63rd81vzlot57qmebr7drtgf6a3khmzvjsdtu7&rid=200w.webp&ct=g\" ] @app . route ( '/' ) def index (): url = random . choice ( images ) return render_template ( 'index.html' , url = url ) if __name__ == \"__main__\" : app . run ( host = \"0.0.0.0\" )","title":"app.py"},{"location":"ch1-discover-docker-td/#requirementstxt","text":"In order to install the Python modules required for our app, we need to create a file called requirements.txt and add the following line to that file: Flask==3.1.0","title":"requirements.txt"},{"location":"ch1-discover-docker-td/#templatesindexhtml","text":"Create a directory called templates and create an index.html file in that directory with the following content in it: < html > < head > < style type = \"text/css\" > body { background : black ; color : white ; } div . container { max-width : 500 px ; margin : 100 px auto ; border : 20 px solid white ; padding : 10 px ; text-align : center ; } h4 { text-transform : uppercase ; } </ style > </ head > < body > < div class = \"container\" > < h4 > Cat Gif of the day </ h4 > < img src = \"{{url}}\" /> < p >< small > Courtesy: < a href = \"http://www.buzzfeed.com/copyranter/the-best-cat-gif-post-in-the-history-of-cat-gifs\" > Buzzfeed </ a ></ small ></ p > </ div > </ body > </ html >","title":"templates/index.html"},{"location":"ch1-discover-docker-td/#232-write-a-dockerfile","text":"We want to create a Docker image with this web app. As mentioned above, all user images are based on a base image. Since our application is written in Python, we will build our own Python image based on Alpine . We'll do that using a Dockerfile. A Dockerfile is a text file that contains a list of commands that the Docker daemon calls while creating an image. The Dockerfile contains all the information that Docker needs to know to run the app \u2014 a base Docker image to run from, location of your project code, any dependencies it has, and what commands to run at start-up. It is a simple way to automate the image creation process. The best part is that the commands you write in a Dockerfile are almost identical to their equivalent Linux commands. This means you don't really have to learn new syntax to create your own Dockerfiles. 1 - Create a file called Dockerfile, and add content to it as described below. We'll start by specifying our base image, using the FROM keyword. We are using alpine:3.21.0, a lightweight Linux distribution that helps keep our container small and efficient: FROM alpine:3.21.0 2 - Next, we need to install Python 3, pip, and other system dependencies required for our application. The apk add command is used to install packages in Alpine Linux. We use --no-cache to prevent unnecessary image bloat. Add the following RUN command: RUN apk add --no-cache build-base libffi-dev openssl-dev py3-pip python3 3 - Now, we set the working directory inside the container. This ensures that all subsequent commands run within this directory: WORKDIR /usr/src/app 4 - To create an isolated Python environment, we set up a virtual environment inside our container. This helps prevent conflicts between system-wide and project-specific dependencies: RUN python3 -m venv venv 5 - To ensure that all commands within the container use the virtual environment by default, we modify the PATH environment variable: ENV PATH = \"/usr/src/app/venv/bin: $PATH \" 6 - Next, we copy the application's dependencies file (requirements.txt) into the container and install the necessary Python packages. We also upgrade pip to the latest version to ensure compatibility: COPY requirements.txt ./ RUN pip install --no-cache-dir --upgrade pip && pip install --no-cache-dir -r requirements.txt 7 - Copy the files you have created earlier into our image by using COPY command. COPY app.py ./ COPY templates/index.html ./templates/ 8 - Since our Flask application runs on port 5000, we specify that this port should be exposed. This does not automatically publish the port but serves as documentation and can be used by orchestration tools: EXPOSE 5000 9 - The last step is the command for running the application which is simply - python ./app.py . Use the CMD command to do that: CMD [ \"python\" , \"/usr/src/app/app.py\" ] The primary purpose of CMD is to tell the container which command it should run by default when it is started. 10 - Verify your Dockerfile. Our Dockerfile is now ready. This is how it looks: # our base image FROM alpine:3.21.0 # Install Python 3, pip, and system dependencies RUN apk add --no-cache build-base libffi-dev openssl-dev py3-pip python3 # Set the working directory WORKDIR /usr/src/app # Create and activate a virtual environment RUN python3 -m venv venv # Use the virtual environment for all commands ENV PATH = \"/usr/src/app/venv/bin: $PATH \" # Copy and install dependencies COPY requirements.txt ./ RUN pip install --no-cache-dir --upgrade pip && pip install --no-cache-dir -r requirements.txt # Copy application files COPY app.py ./ COPY templates/index.html ./templates/ # Expose the application port EXPOSE 5000 # Run the application inside the virtual environment CMD [ \"python\" , \"/usr/src/app/app.py\" ]","title":"2.3.2 Write a Dockerfile"},{"location":"ch1-discover-docker-td/#233-build-the-image","text":"Now that you have your Dockerfile , you can build your image. The docker build command does the heavy-lifting of creating a docker image from a Dockerfile . When you run the docker build command given below, make sure to replace <YOUR_USERNAME> with your username. This username should be the same one you created when registering on Docker Cloud . If you haven't done that yet, please go ahead and create an account. The docker build command is quite simple - it takes an optional tag name with the -t flag, and the location of the directory containing the Dockerfile - the . indicates the current directory: docker build -t <YOUR_USERNAME>/myfirstapp . If you don't have the alpine:3.21.0 image, the client will first pull the image and then create your image. Therefore, your output on running the command will look different from mine. If everything went well, your image should be ready! Run docker images and see if your image ( <YOUR_USERNAME>/myfirstapp ) shows.","title":"2.3.3 Build the image"},{"location":"ch1-discover-docker-td/#234-run-your-image","text":"The next step in this section is to run the image and see if it actually works. docker run -p 8888 :5000 --name myfirstapp YOUR_USERNAME/myfirstapp * Serving Flask app 'app' * Debug mode: off WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead. * Running on all addresses ( 0 .0.0.0 ) * Running on http://127.0.0.1:5000 * Running on http://172.17.0.2:5000 Press CTRL+C to quit Head over to http://localhost:8888 and your app should be live. Note If you are using Docker Machine, you may need to open up another terminal and determine the container ip address using docker-machine ip default . Hit the Refresh button in the web browser to see a few more cat images. Check Show us your running flask-app !","title":"2.3.4 Run your image"},{"location":"ch1-discover-docker-td/#234-dockerfile-commands-summary","text":"Here's a quick summary of the few basic commands we used in our Dockerfile. FROM starts the Dockerfile. It is a requirement that the Dockerfile must start with the FROM command. Images are created in layers, which means you can use another image as the base image for your own. The FROM command defines your base layer. As arguments, it takes the name of the image. Optionally, you can add the Docker Cloud username of the maintainer and image version, in the format username/imagename:version . RUN is used to build up the Image you're creating. For each RUN command, Docker will run the command then create a new layer of the image. This way you can roll back your image to previous states easily. The syntax for a RUN instruction is to place the full text of the shell command after the RUN (e.g., RUN mkdir /user/local/foo ). This will automatically run in a /bin/sh shell. You can define a different shell like this: RUN /bin/bash -c 'mkdir /user/local/foo ' COPY copies local files into the container. CMD defines the commands that will run on the Image at start-up. Unlike a RUN , this does not create a new layer for the Image, but simply runs the command. There can only be one CMD per a Dockerfile/Image. If you need to run multiple commands, the best way to do that is to have the CMD run a script. CMD requires that you tell it where to run the command, unlike RUN . So example CMD commands would be: CMD [ \"python\" , \"./app.py\" ] CMD [ \"/bin/bash\" , \"echo\" , \"Hello World\" ] EXPOSE creates a hint for users of an image which ports provide services. It is included in the information which can be retrieved via docker inspect <container-id> . Note The EXPOSE command does not actually make any ports accessible to the host! Instead, this requires publishing ports by means of the -p flag when using docker run . Note If you want to learn more about Dockerfiles, check out Best practices for writing Dockerfiles . (source: https://github.com/docker/labs/tree/master/beginner ) Now that you know how to run docker container and create Dockerfiles let\u2019s move on to the practical part.","title":"2.3.4 Dockerfile commands summary"},{"location":"ch1-discover-docker-tp/","text":"Discover Docker Check Checkpoint: call us to check your results (don\u2019t stay blocked on a checkpoint if we are busy, we can check \u2154 checkpoints at the same time). Question Point to document/report. Tip Interesting information. Goals Good practice Do not forget to document what you do along the steps, the documentation provided will be evaluated as your report. Create an appropriate file structure, 1 folder per image. Target application 3-tiers application: HTTP server Backend API Database For each of those applications, we will follow the same process: choose the appropriate docker base image, create and configure this image, put our application specifics inside and at some point have it running. Our final goal is to have a 3-tier web API running. Base images HTTP server Backend API Database Database Basics We will use the image: postgres:17.2-alpine. Let\u2019s have a simple postgres server running, here is what would be a minimal Dockerfile: FROM postgres:17.2-alpine ENV POSTGRES_DB = db \\ POSTGRES_USER = usr \\ POSTGRES_PASSWORD = pwd Build this image and start a container properly. Your Postgres DB should be up and running. Check that everything is running smoothly with the docker command of your choice. Don\u2019t forget to name your docker image and container. Tip If you have difficulties go back to part 2.3.3 Build the image and 2.3.4 Run your image on TD01 - Docker ( TD 1 Discover Docker ). Re-run your database with adminer . Don't forget --network app-network to enable adminer/database communication. We use -\u2013network instead of -\u2013link because the latter is deprecated. Tip Don't forget to create your network docker network create app-network Also, does it seem right to have passwords written in plain text in a file? You may rather define those environment parameters when running the image using the flag -e . Question 1-1 For which reason is it better to run the container with a flag -e to give the environment variables rather than put them directly in the Dockerfile? It would be nice to have our database structure initialized with the docker image as well as some initial data. Any sql scripts found in /docker-entrypoint-initdb.d will be executed in alphabetical order, therefore let\u2019s add a couple scripts to our image: Tip Don't forget to restart the adminer: docker run \\ -p \"8090:8080\" \\ --net = app-network \\ --name = adminer \\ -d \\ adminer Init database 01-CreateScheme.sql CREATE TABLE public . departments ( id SERIAL PRIMARY KEY , name VARCHAR ( 20 ) NOT NULL ); CREATE TABLE public . students ( id SERIAL PRIMARY KEY , department_id INT NOT NULL REFERENCES departments ( id ), first_name VARCHAR ( 20 ) NOT NULL , last_name VARCHAR ( 20 ) NOT NULL ); 02-InsertData.sql INSERT INTO departments ( name ) VALUES ( 'IRC' ); INSERT INTO departments ( name ) VALUES ( 'ETI' ); INSERT INTO departments ( name ) VALUES ( 'CGP' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 1 , 'Eli' , 'Copter' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 2 , 'Emma' , 'Carena' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 2 , 'Jack' , 'Uzzi' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 3 , 'Aude' , 'Javel' ); Rebuild your image and check that your scripts have been executed at startup and that the data is present in your container. Tip When we talk about /docker-entrypoint-initdb.d it means inside the container, so you have to copy your directory's content and the container\u2019s directory. Persist data You may have noticed that if your database container gets destroyed then all your data is reset, a database must persist data durably. Use volumes to persist data on the host disk. -v /my/own/datadir:/var/lib/postgresql/data Check that data survives when your container gets destroyed. Link Docker volumes Question 1-2 Why do we need a volume to be attached to our postgres container? Question 1-3 Document your database container essentials: commands and Dockerfile. Backend API Basics For starters, we will simply run a Java hello-world class in our containers, only after will we be running a jar. In both cases, choose the proper image keeping in mind that we only need a Java runtime . Here is a complex Java Hello World implementation: Main.java public class Main { public static void main ( String [] args ) { System . out . println ( \"Hello World!\" ); } } 1- Compile with your target Java: javac Main.java . 2- Write dockerfile. FROM # TODO: Choose a java JRE # TODO: Add the compiled java (aka bytecode, aka .class) # TODO: Run the Java with: \u201cjava Main\u201d command. 3- Now, to launch app you have to do the same thing that Basic step 1. Here you have a first glimpse of your backend application. In the next step we will simply enrich the build (using maven instead of a minimalistic javac) and execute a jar instead of a simple .class. \u2192 If it\u2019s a success you must see \u201cHello Word\u201d in your console. Multistage build In the previous section we were building Java code on our machine to have it running on a docker container. Wouldn\u2019t it be great to have Docker handle the build as well? You probably noticed that the default openjdk docker images contain... Well... a JDK! Create a multistage build using the Multistage . Your Dockerfile should look like this: FROM eclipse-temurin:21-jdk-alpine # Build Main.java with JDK # TODO : in next steps (not now) FROM eclipse-temurin:21-jre-alpine # Copy resource from previous stage COPY --from = 0 /usr/src/Main.class . # Run java code with the JRE # TODO : in next steps (not now) Don\u2019t fill the Dockerfile now, we will have to do it in the next steps. Backend simple api We will deploy a Springboot application providing a simple API with a single greeting endpoint. Create your Springboot application on: Spring Initializer . Use the following config: Project: Maven Language: Java 21 Spring Boot: 3.4.2 Packaging: Jar Dependencies: Spring Web Generate the project and give it a simple GreetingController class: package fr.takima.training.simpleapi.controller ; import org.springframework.web.bind.annotation.* ; import java.util.concurrent.atomic.AtomicLong ; @RestController public class GreetingController { private static final String template = \"Hello, %s!\" ; private final AtomicLong counter = new AtomicLong (); @GetMapping ( \"/\" ) public Greeting greeting ( @RequestParam ( value = \"name\" , defaultValue = \"World\" ) String name ) { return new Greeting ( counter . incrementAndGet (), String . format ( template , name )); } record Greeting ( long id , String content ) {} } You can now build and start your application, of course you will need maven and a jdk-21. How convenient would it be to have a virtual container to build and run our simplistic API? Oh wait, we have docker, here is how you could build and run your application with Docker: # Build stage FROM eclipse-temurin:21-jdk-alpine AS myapp-build ENV MYAPP_HOME = /opt/myapp WORKDIR $MYAPP_HOME RUN apk add --no-cache maven COPY pom.xml . COPY src ./src RUN mvn package -DskipTests # Run stage FROM eclipse-temurin:21-jre-alpine ENV MYAPP_HOME = /opt/myapp WORKDIR $MYAPP_HOME COPY --from = myapp-build $MYAPP_HOME /target/*.jar $MYAPP_HOME /myapp.jar ENTRYPOINT [ \"java\" , \"-jar\" , \"myapp.jar\" ] Question 1-4 Why do we need a multistage build? And explain each step of this dockerfile. Check A working Springboot application with a simple HelloWorld endpoint. Did you notice that maven downloads all libraries on every image build? You can contribute to saving the planet caching libraries when maven pom file has not been changed by running the goal: mvn dependency:go-offline . Backend API Let\u2019s now build and run the backend API connected to the database. You can get the zipped source code here: simple-api . You can replace only your src directory and the pom.xml file with the ones available in the repository. Adjust the configuration in simple-api/src/main/resources/application.yml (this is the application configuration). How to access the database container from your backend application? Use the deprecated --link or create a docker network . Once everything is properly bound, you should be able to access your application API, for example on: /departments/IRC/students . [ { \"id\" : 1 , \"firstname\" : \"Eli\" , \"lastname\" : \"Copter\" , \"department\" : { \"id\" : 1 , \"name\" : \"IRC\" } } ] Explore your API other endpoints, have a look at the controllers in the source code. Check A simple web API on top of your database. Http server Basics Choose an appropriate base image. Create a simple landing page: index.html and put it inside your container. It should be enough for now, start your container and check that everything is working as expected. Here are commands that you may want to try to do so: docker stats docker inspect docker logs Link Httpd Getting Started Configuration You are using the default apache configuration, and it will be enough for now, you use yours by copying it in your image. Use docker exec to retrieve this default configuration from your running container /usr/local/apache2/conf/httpd.conf . Note You can also use docker cp . Reverse proxy We will configure the http server as a simple reverse proxy server in front of our application, this server could be used to deliver a front-end application, to configure SSL or to handle load balancing. So this can be quite useful even though in our case we will keep things simple. Here is the documentation: Reverse Proxy . Add the following to the configuration, and you should be all set: <VirtualHost *:80> ProxyPreserveHost On ProxyPass / http://YOUR_BACKEND_LINK:8080/ ProxyPassReverse / http://YOUR_BACKEND_LINK:8080/ </VirtualHost> LoadModule proxy_module modules/mod_proxy.so LoadModule proxy_http_module modules/mod_proxy_http.so Question 1-5 Why do we need a reverse proxy? Check Checkpoint: a working application through a reverse proxy. Link application Docker-compose 1- Install docker-compose if the docker compose command does not work . You may have noticed that this can be quite painful to orchestrate manually the start, stop and rebuild of our containers. Thankfully, a useful tool called docker-compose comes in handy in those situations. 2- Let\u2019s create a docker-compose.yml file with the following structure to define and drive our containers: services : backend : build : #TODO networks : #TODO depends_on : #TODO database : build : #TODO networks : #TODO httpd : build : #TODO ports : #TODO networks : #TODO depends_on : #TODO networks : #TODO volumes : #TODO The docker-compose will handle the three containers for us. The file above is a basic example of structure, you need to add more parameters and think about the cleanest and most optimized approach like you would do in a company (for example: env variables, volumes, restart policies and processes segregation). Once your containers are orchestrated as services by docker-compose you should have a perfectly running application, make sure you can access your API on localhost . Note The ports of both your backend and database should not be opened to your host machine. Question 1-6 Why is docker-compose so important? Question 1-7 Document docker-compose most important commands. Question 1-8 Document your docker-compose file. Check A working 3-tier application running with docker-compose. Publish Your docker images are stored locally, let\u2019s publish them, so they can be used by other team members or on other machines. You will need a Docker Hub account. 1- Connect to your freshly created account with docker login . 2- Tag your image. For now, we have been only using the latest tag, now that we want to publish it, let\u2019s add some meaningful version information to our images. docker tag my-database USERNAME/my-database:1.0 3- Then push your image to dockerhub: docker push USERNAME/my-database:1.0 Dockerhub is not the only docker image registry, and you can also self-host your images (this is obviously the choice of most companies). Once you publish your images to dockerhub, you will see them in your account: having some documentation for your image would be quite useful if you want to use those later. Question 1-9 Document your publication commands and published images in dockerhub. Question 1-10 Why do we put our images into an online repo? \u00a9 Takima 2025","title":"TP part 01 - Docker"},{"location":"ch1-discover-docker-tp/#discover-docker","text":"Check Checkpoint: call us to check your results (don\u2019t stay blocked on a checkpoint if we are busy, we can check \u2154 checkpoints at the same time). Question Point to document/report. Tip Interesting information.","title":"Discover Docker"},{"location":"ch1-discover-docker-tp/#goals","text":"","title":"Goals"},{"location":"ch1-discover-docker-tp/#good-practice","text":"Do not forget to document what you do along the steps, the documentation provided will be evaluated as your report. Create an appropriate file structure, 1 folder per image.","title":"Good practice"},{"location":"ch1-discover-docker-tp/#target-application","text":"3-tiers application: HTTP server Backend API Database For each of those applications, we will follow the same process: choose the appropriate docker base image, create and configure this image, put our application specifics inside and at some point have it running. Our final goal is to have a 3-tier web API running.","title":"Target application"},{"location":"ch1-discover-docker-tp/#base-images","text":"HTTP server Backend API Database","title":"Base images"},{"location":"ch1-discover-docker-tp/#database","text":"","title":"Database"},{"location":"ch1-discover-docker-tp/#basics","text":"We will use the image: postgres:17.2-alpine. Let\u2019s have a simple postgres server running, here is what would be a minimal Dockerfile: FROM postgres:17.2-alpine ENV POSTGRES_DB = db \\ POSTGRES_USER = usr \\ POSTGRES_PASSWORD = pwd Build this image and start a container properly. Your Postgres DB should be up and running. Check that everything is running smoothly with the docker command of your choice. Don\u2019t forget to name your docker image and container. Tip If you have difficulties go back to part 2.3.3 Build the image and 2.3.4 Run your image on TD01 - Docker ( TD 1 Discover Docker ). Re-run your database with adminer . Don't forget --network app-network to enable adminer/database communication. We use -\u2013network instead of -\u2013link because the latter is deprecated. Tip Don't forget to create your network docker network create app-network Also, does it seem right to have passwords written in plain text in a file? You may rather define those environment parameters when running the image using the flag -e . Question 1-1 For which reason is it better to run the container with a flag -e to give the environment variables rather than put them directly in the Dockerfile? It would be nice to have our database structure initialized with the docker image as well as some initial data. Any sql scripts found in /docker-entrypoint-initdb.d will be executed in alphabetical order, therefore let\u2019s add a couple scripts to our image: Tip Don't forget to restart the adminer: docker run \\ -p \"8090:8080\" \\ --net = app-network \\ --name = adminer \\ -d \\ adminer","title":"Basics"},{"location":"ch1-discover-docker-tp/#init-database","text":"01-CreateScheme.sql CREATE TABLE public . departments ( id SERIAL PRIMARY KEY , name VARCHAR ( 20 ) NOT NULL ); CREATE TABLE public . students ( id SERIAL PRIMARY KEY , department_id INT NOT NULL REFERENCES departments ( id ), first_name VARCHAR ( 20 ) NOT NULL , last_name VARCHAR ( 20 ) NOT NULL ); 02-InsertData.sql INSERT INTO departments ( name ) VALUES ( 'IRC' ); INSERT INTO departments ( name ) VALUES ( 'ETI' ); INSERT INTO departments ( name ) VALUES ( 'CGP' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 1 , 'Eli' , 'Copter' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 2 , 'Emma' , 'Carena' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 2 , 'Jack' , 'Uzzi' ); INSERT INTO students ( department_id , first_name , last_name ) VALUES ( 3 , 'Aude' , 'Javel' ); Rebuild your image and check that your scripts have been executed at startup and that the data is present in your container. Tip When we talk about /docker-entrypoint-initdb.d it means inside the container, so you have to copy your directory's content and the container\u2019s directory.","title":"Init database"},{"location":"ch1-discover-docker-tp/#persist-data","text":"You may have noticed that if your database container gets destroyed then all your data is reset, a database must persist data durably. Use volumes to persist data on the host disk. -v /my/own/datadir:/var/lib/postgresql/data Check that data survives when your container gets destroyed. Link Docker volumes Question 1-2 Why do we need a volume to be attached to our postgres container? Question 1-3 Document your database container essentials: commands and Dockerfile.","title":"Persist data"},{"location":"ch1-discover-docker-tp/#backend-api","text":"","title":"Backend API"},{"location":"ch1-discover-docker-tp/#basics_1","text":"For starters, we will simply run a Java hello-world class in our containers, only after will we be running a jar. In both cases, choose the proper image keeping in mind that we only need a Java runtime . Here is a complex Java Hello World implementation: Main.java public class Main { public static void main ( String [] args ) { System . out . println ( \"Hello World!\" ); } } 1- Compile with your target Java: javac Main.java . 2- Write dockerfile. FROM # TODO: Choose a java JRE # TODO: Add the compiled java (aka bytecode, aka .class) # TODO: Run the Java with: \u201cjava Main\u201d command. 3- Now, to launch app you have to do the same thing that Basic step 1. Here you have a first glimpse of your backend application. In the next step we will simply enrich the build (using maven instead of a minimalistic javac) and execute a jar instead of a simple .class. \u2192 If it\u2019s a success you must see \u201cHello Word\u201d in your console.","title":"Basics"},{"location":"ch1-discover-docker-tp/#multistage-build","text":"In the previous section we were building Java code on our machine to have it running on a docker container. Wouldn\u2019t it be great to have Docker handle the build as well? You probably noticed that the default openjdk docker images contain... Well... a JDK! Create a multistage build using the Multistage . Your Dockerfile should look like this: FROM eclipse-temurin:21-jdk-alpine # Build Main.java with JDK # TODO : in next steps (not now) FROM eclipse-temurin:21-jre-alpine # Copy resource from previous stage COPY --from = 0 /usr/src/Main.class . # Run java code with the JRE # TODO : in next steps (not now) Don\u2019t fill the Dockerfile now, we will have to do it in the next steps.","title":"Multistage build"},{"location":"ch1-discover-docker-tp/#backend-simple-api","text":"We will deploy a Springboot application providing a simple API with a single greeting endpoint. Create your Springboot application on: Spring Initializer . Use the following config: Project: Maven Language: Java 21 Spring Boot: 3.4.2 Packaging: Jar Dependencies: Spring Web Generate the project and give it a simple GreetingController class: package fr.takima.training.simpleapi.controller ; import org.springframework.web.bind.annotation.* ; import java.util.concurrent.atomic.AtomicLong ; @RestController public class GreetingController { private static final String template = \"Hello, %s!\" ; private final AtomicLong counter = new AtomicLong (); @GetMapping ( \"/\" ) public Greeting greeting ( @RequestParam ( value = \"name\" , defaultValue = \"World\" ) String name ) { return new Greeting ( counter . incrementAndGet (), String . format ( template , name )); } record Greeting ( long id , String content ) {} } You can now build and start your application, of course you will need maven and a jdk-21. How convenient would it be to have a virtual container to build and run our simplistic API? Oh wait, we have docker, here is how you could build and run your application with Docker: # Build stage FROM eclipse-temurin:21-jdk-alpine AS myapp-build ENV MYAPP_HOME = /opt/myapp WORKDIR $MYAPP_HOME RUN apk add --no-cache maven COPY pom.xml . COPY src ./src RUN mvn package -DskipTests # Run stage FROM eclipse-temurin:21-jre-alpine ENV MYAPP_HOME = /opt/myapp WORKDIR $MYAPP_HOME COPY --from = myapp-build $MYAPP_HOME /target/*.jar $MYAPP_HOME /myapp.jar ENTRYPOINT [ \"java\" , \"-jar\" , \"myapp.jar\" ] Question 1-4 Why do we need a multistage build? And explain each step of this dockerfile. Check A working Springboot application with a simple HelloWorld endpoint. Did you notice that maven downloads all libraries on every image build? You can contribute to saving the planet caching libraries when maven pom file has not been changed by running the goal: mvn dependency:go-offline .","title":"Backend simple api"},{"location":"ch1-discover-docker-tp/#backend-api_1","text":"Let\u2019s now build and run the backend API connected to the database. You can get the zipped source code here: simple-api . You can replace only your src directory and the pom.xml file with the ones available in the repository. Adjust the configuration in simple-api/src/main/resources/application.yml (this is the application configuration). How to access the database container from your backend application? Use the deprecated --link or create a docker network . Once everything is properly bound, you should be able to access your application API, for example on: /departments/IRC/students . [ { \"id\" : 1 , \"firstname\" : \"Eli\" , \"lastname\" : \"Copter\" , \"department\" : { \"id\" : 1 , \"name\" : \"IRC\" } } ] Explore your API other endpoints, have a look at the controllers in the source code. Check A simple web API on top of your database.","title":"Backend API"},{"location":"ch1-discover-docker-tp/#http-server","text":"","title":"Http server"},{"location":"ch1-discover-docker-tp/#basics_2","text":"","title":"Basics"},{"location":"ch1-discover-docker-tp/#choose-an-appropriate-base-image","text":"Create a simple landing page: index.html and put it inside your container. It should be enough for now, start your container and check that everything is working as expected. Here are commands that you may want to try to do so: docker stats docker inspect docker logs Link Httpd Getting Started","title":"Choose an appropriate base image."},{"location":"ch1-discover-docker-tp/#configuration","text":"You are using the default apache configuration, and it will be enough for now, you use yours by copying it in your image. Use docker exec to retrieve this default configuration from your running container /usr/local/apache2/conf/httpd.conf . Note You can also use docker cp .","title":"Configuration"},{"location":"ch1-discover-docker-tp/#reverse-proxy","text":"We will configure the http server as a simple reverse proxy server in front of our application, this server could be used to deliver a front-end application, to configure SSL or to handle load balancing. So this can be quite useful even though in our case we will keep things simple. Here is the documentation: Reverse Proxy . Add the following to the configuration, and you should be all set: <VirtualHost *:80> ProxyPreserveHost On ProxyPass / http://YOUR_BACKEND_LINK:8080/ ProxyPassReverse / http://YOUR_BACKEND_LINK:8080/ </VirtualHost> LoadModule proxy_module modules/mod_proxy.so LoadModule proxy_http_module modules/mod_proxy_http.so Question 1-5 Why do we need a reverse proxy? Check Checkpoint: a working application through a reverse proxy.","title":"Reverse proxy"},{"location":"ch1-discover-docker-tp/#link-application","text":"","title":"Link application"},{"location":"ch1-discover-docker-tp/#docker-compose","text":"1- Install docker-compose if the docker compose command does not work . You may have noticed that this can be quite painful to orchestrate manually the start, stop and rebuild of our containers. Thankfully, a useful tool called docker-compose comes in handy in those situations. 2- Let\u2019s create a docker-compose.yml file with the following structure to define and drive our containers: services : backend : build : #TODO networks : #TODO depends_on : #TODO database : build : #TODO networks : #TODO httpd : build : #TODO ports : #TODO networks : #TODO depends_on : #TODO networks : #TODO volumes : #TODO The docker-compose will handle the three containers for us. The file above is a basic example of structure, you need to add more parameters and think about the cleanest and most optimized approach like you would do in a company (for example: env variables, volumes, restart policies and processes segregation). Once your containers are orchestrated as services by docker-compose you should have a perfectly running application, make sure you can access your API on localhost . Note The ports of both your backend and database should not be opened to your host machine. Question 1-6 Why is docker-compose so important? Question 1-7 Document docker-compose most important commands. Question 1-8 Document your docker-compose file. Check A working 3-tier application running with docker-compose.","title":"Docker-compose"},{"location":"ch1-discover-docker-tp/#publish","text":"Your docker images are stored locally, let\u2019s publish them, so they can be used by other team members or on other machines. You will need a Docker Hub account. 1- Connect to your freshly created account with docker login . 2- Tag your image. For now, we have been only using the latest tag, now that we want to publish it, let\u2019s add some meaningful version information to our images. docker tag my-database USERNAME/my-database:1.0 3- Then push your image to dockerhub: docker push USERNAME/my-database:1.0 Dockerhub is not the only docker image registry, and you can also self-host your images (this is obviously the choice of most companies). Once you publish your images to dockerhub, you will see them in your account: having some documentation for your image would be quite useful if you want to use those later. Question 1-9 Document your publication commands and published images in dockerhub. Question 1-10 Why do we put our images into an online repo? \u00a9 Takima 2025","title":"Publish"},{"location":"ch2-discover-github-actions-td/","text":"Discover Github Note Checkpoint: call us to check your results (don\u2019t stay blocked on a checkpoint if we are busy, we can check \u2154 checkpoints at the same time) Question Point to document/report Tip Interesting information Setup Prerequisites Even if it seems pretty usual to use Git in the development world, not every project is managed with this tool. The main goal here is to have you create and set up a Github account before using it for further purposes. Git will be required as well as it is a must have. You might want to start with Sign up to Github First step is (if not already done) to sign up to Github with your school mail address and fill the required information. We recommend you to use an individual free plan for the next steps of this project. You can eventually fill the last page but it\u2019s not really important. Select \u201cComplete setup\u201d. There you are, your (probably not first) Github account is set up. Yay ! Now, let\u2019s move on to the next step ! Project forking and publishing For this part, we are going to fork the project that will be used for the rest of the lesson (I mean, till the end of the week). Now you own the project under your Github workspace, you can basically do whatever you want on this project. However we recommend not to modify the whole java and maven content if you still want this project to compile. First of all, make sure the git CLI is installed on your computer and then clone the project on your computer to be able to modify it locally. Securing Github access There are actually two different ways of cloning and publishing a project. By default, Github will propose you to clone by HTTPS link. Copy to clipboard, then open a new terminal and enter : $ git clone <project_url_with_https> Git will probably ask you to authenticate in order to be able to clone the repository. It will ask you the same thing every time you want to publish your work on a branch. This might be painful and you don\u2019t want to do this. The second option is \u201cuse SSH\u201d and the link starts with \u201cgit@github.com:\u2026\u201d, but there is a prerequisite to use this solution, you\u2019ll need to create an SSH key and have it added to your account. Fine, then tape: $ ssh-keygen -t rsa -b 4096 -f ~/.ssh/ { theNameOfYourKeyPair } It will ask you to enter and confirm a passphrase, this is for security purposes but we will let it empty for this course. Well done, you\u2019ve generated a new RSA key pair of 4096 bits size. If you do \u201cls ~/.ssh\u201d you\u2019ll see new files inside your folder, one is named theNameOfYourKeyPair and the other one theNameOfYourKeyPair.pub. The first one is your private key to NEVER communicate to anyone and the second one is you public key. Let\u2019s take a look to this last one, enter \u201ccat ~/.ssh/theNameOfYourKeyPair.pub\u201d: Something like this will appear on you terminal, this is the content of your public key that you will communicate to Github. Copy the whole content and past it to you Github account under \u201cSettings\u201d and \u201cSSH and GPG keys\u201d. Click on New SSH key and paste the content of your public key. Give it a name and validate the operation. Now try to clone the repository again with the git@ prefix. It will ask you to select a key pair to perform the action. Take the one you\u2019ve just indicated to Github and press enter. Now you are able to clone and publish work on your Github repository without entering a password every time, I hope you enjoy this. Let\u2019s publish Open the project inside your favorite IDE (I hope it\u2019s IntelliJ) and open the file README.md. Modify this file entering, for example \u201cThis project is now mine\u201d. Save it and check that Git has correctly seen you changes $ git status You\u2019ll see you file colored in red. This means that Git has seen you\u2019ve made some modifications to this file, but it will not take them into account once you will publish them. Then ask git to add them to your work. $ git add . Actually, we did not ask him to add our file, but to add any modification made to any file inside our working directory. Now if you enter \u201cgit status\u201d again you\u2019ll see that your file is colored in green. You work will be taken into account, hopefully. Let\u2019s commit this work: $ git commit -m \u201cThe message of your commit\u201d Now if you try to \u201cgit status\u201d again you\u2019ll see that your workspace is \u201cclean\u201d. Git created a new reference with all the changes you\u2019ve made. If you go on and enter: $ git log You\u2019ll see the message of you last commit on top of the references. However you cannot see the changes on the Github website because we did not publish yet our work. Let\u2019s do it ! $ git push origin master This command literally means \u201cI want to publish my work on the distant/remote branch master\u201d. And now you can see that your work is published online ! Big up guys ! Configure your repository Git is one of the most useful tool you\u2019ll find in your developer life. Almost everybody uses it and most of the time you\u2019ll have to work with other people on project using Github. However you\u2019ll find many people that use it wrongly, and many people that will create things you don\u2019t want to merge in you production branch. Let\u2019s secure a bit our labor to prevent any fool to throw it away. Go back to your project on the Github webpage and click on settings. Go to Branches and you\u2019ll see that your default branch is master. Fine, it means that every time you connect on your repository, this branch will be displayed. Just under this indication, you\u2019ll see a Branch protection rule. Try to add one. You\u2019ll see a bunch of options, most of them are very useful working in team (especially asking for pull request and review before merging inside master branch). You can also select options to block push force (when someone does push -f) because it doesn\u2019t take care of Git warning messages that usually prevent you from pushing. As you are working alone on this project we will only add the name \u201cmaster\u201d to the naming pattern and let the rest as it is. It will only prevent you from doing bad things on you master branch. Finally, be aware that all the work you do on Github is public by default. Therefore you should or you must NEVER publish any password on your repository. Thankfully you can turn your repository to private from the options and there are Environment Variables that you can set and secure (I mean encrypt) inside your Github repository under Secrets. Git basic commands Clone a project $ git clone <url_of_the_project> Fetch distant modifications without merging them into your branch $ git fetch -p Fetch distant modifications and merge them into you branch $ git pull Add your changes to the workspace $ git add . Commit your changes $ git commit -m \u201cYour message\u201d Publish your changes $ git push origin <name_of_the_remote_branch>","title":"TD part 02 - Github Actions"},{"location":"ch2-discover-github-actions-td/#discover-github","text":"Note Checkpoint: call us to check your results (don\u2019t stay blocked on a checkpoint if we are busy, we can check \u2154 checkpoints at the same time) Question Point to document/report Tip Interesting information","title":"Discover Github"},{"location":"ch2-discover-github-actions-td/#setup","text":"","title":"Setup"},{"location":"ch2-discover-github-actions-td/#prerequisites","text":"Even if it seems pretty usual to use Git in the development world, not every project is managed with this tool. The main goal here is to have you create and set up a Github account before using it for further purposes. Git will be required as well as it is a must have. You might want to start with","title":"Prerequisites"},{"location":"ch2-discover-github-actions-td/#sign-up-to-github","text":"First step is (if not already done) to sign up to Github with your school mail address and fill the required information. We recommend you to use an individual free plan for the next steps of this project. You can eventually fill the last page but it\u2019s not really important. Select \u201cComplete setup\u201d. There you are, your (probably not first) Github account is set up. Yay ! Now, let\u2019s move on to the next step !","title":"Sign up to Github"},{"location":"ch2-discover-github-actions-td/#project-forking-and-publishing","text":"For this part, we are going to fork the project that will be used for the rest of the lesson (I mean, till the end of the week). Now you own the project under your Github workspace, you can basically do whatever you want on this project. However we recommend not to modify the whole java and maven content if you still want this project to compile. First of all, make sure the git CLI is installed on your computer and then clone the project on your computer to be able to modify it locally.","title":"Project forking and publishing"},{"location":"ch2-discover-github-actions-td/#securing-github-access","text":"There are actually two different ways of cloning and publishing a project. By default, Github will propose you to clone by HTTPS link. Copy to clipboard, then open a new terminal and enter : $ git clone <project_url_with_https> Git will probably ask you to authenticate in order to be able to clone the repository. It will ask you the same thing every time you want to publish your work on a branch. This might be painful and you don\u2019t want to do this. The second option is \u201cuse SSH\u201d and the link starts with \u201cgit@github.com:\u2026\u201d, but there is a prerequisite to use this solution, you\u2019ll need to create an SSH key and have it added to your account. Fine, then tape: $ ssh-keygen -t rsa -b 4096 -f ~/.ssh/ { theNameOfYourKeyPair } It will ask you to enter and confirm a passphrase, this is for security purposes but we will let it empty for this course. Well done, you\u2019ve generated a new RSA key pair of 4096 bits size. If you do \u201cls ~/.ssh\u201d you\u2019ll see new files inside your folder, one is named theNameOfYourKeyPair and the other one theNameOfYourKeyPair.pub. The first one is your private key to NEVER communicate to anyone and the second one is you public key. Let\u2019s take a look to this last one, enter \u201ccat ~/.ssh/theNameOfYourKeyPair.pub\u201d: Something like this will appear on you terminal, this is the content of your public key that you will communicate to Github. Copy the whole content and past it to you Github account under \u201cSettings\u201d and \u201cSSH and GPG keys\u201d. Click on New SSH key and paste the content of your public key. Give it a name and validate the operation. Now try to clone the repository again with the git@ prefix. It will ask you to select a key pair to perform the action. Take the one you\u2019ve just indicated to Github and press enter. Now you are able to clone and publish work on your Github repository without entering a password every time, I hope you enjoy this.","title":"Securing Github access"},{"location":"ch2-discover-github-actions-td/#lets-publish","text":"Open the project inside your favorite IDE (I hope it\u2019s IntelliJ) and open the file README.md. Modify this file entering, for example \u201cThis project is now mine\u201d. Save it and check that Git has correctly seen you changes $ git status You\u2019ll see you file colored in red. This means that Git has seen you\u2019ve made some modifications to this file, but it will not take them into account once you will publish them. Then ask git to add them to your work. $ git add . Actually, we did not ask him to add our file, but to add any modification made to any file inside our working directory. Now if you enter \u201cgit status\u201d again you\u2019ll see that your file is colored in green. You work will be taken into account, hopefully. Let\u2019s commit this work: $ git commit -m \u201cThe message of your commit\u201d Now if you try to \u201cgit status\u201d again you\u2019ll see that your workspace is \u201cclean\u201d. Git created a new reference with all the changes you\u2019ve made. If you go on and enter: $ git log You\u2019ll see the message of you last commit on top of the references. However you cannot see the changes on the Github website because we did not publish yet our work. Let\u2019s do it ! $ git push origin master This command literally means \u201cI want to publish my work on the distant/remote branch master\u201d. And now you can see that your work is published online ! Big up guys !","title":"Let\u2019s publish"},{"location":"ch2-discover-github-actions-td/#configure-your-repository","text":"Git is one of the most useful tool you\u2019ll find in your developer life. Almost everybody uses it and most of the time you\u2019ll have to work with other people on project using Github. However you\u2019ll find many people that use it wrongly, and many people that will create things you don\u2019t want to merge in you production branch. Let\u2019s secure a bit our labor to prevent any fool to throw it away. Go back to your project on the Github webpage and click on settings. Go to Branches and you\u2019ll see that your default branch is master. Fine, it means that every time you connect on your repository, this branch will be displayed. Just under this indication, you\u2019ll see a Branch protection rule. Try to add one. You\u2019ll see a bunch of options, most of them are very useful working in team (especially asking for pull request and review before merging inside master branch). You can also select options to block push force (when someone does push -f) because it doesn\u2019t take care of Git warning messages that usually prevent you from pushing. As you are working alone on this project we will only add the name \u201cmaster\u201d to the naming pattern and let the rest as it is. It will only prevent you from doing bad things on you master branch. Finally, be aware that all the work you do on Github is public by default. Therefore you should or you must NEVER publish any password on your repository. Thankfully you can turn your repository to private from the options and there are Environment Variables that you can set and secure (I mean encrypt) inside your Github repository under Secrets.","title":"Configure your repository"},{"location":"ch2-discover-github-actions-td/#git-basic-commands","text":"Clone a project $ git clone <url_of_the_project> Fetch distant modifications without merging them into your branch $ git fetch -p Fetch distant modifications and merge them into you branch $ git pull Add your changes to the workspace $ git add . Commit your changes $ git commit -m \u201cYour message\u201d Publish your changes $ git push origin <name_of_the_remote_branch>","title":"Git basic commands"},{"location":"ch2-discover-github-actions-tp/","text":"Discover Github Action Check Checkpoint: call us to check your results (don\u2019t stay blocked on a checkpoint if we are busy, we can check \u2154 checkpoints at the same time) Question Point to document/report Tip Interesting information Goals Good Practice Do not forget to document what you do along the steps. Create an appropriate file structure, 1 folder per image. Target Application Complete pipeline workflow for testing and delivering your software application. We are going to use different useful tools to build your application, test it automatically, and check the code quality at the same time. Link GitHub Actions Setup GitHub Actions The first tool we are going to use is GitHub Actions . GitHub Actions is an online service that allows you to build pipelines to test your application. Keep in mind that GitHub Actions is not the only one on the market to build integration pipelines. Historically many companies were using Jenkins (and still a lot continue to do it), it is way less accessible than GitHub Actions but much more configurable. You will also hear about Gitlab CI and Bitbucket Pipelines during your work life. First steps into the CI World Note Use your repository from the end of the Docker TP Most of the CI services use a yaml file (except Jenkins that uses a\u2026 Groovy file\u2026) to describe the expected steps to be done over the pipeline execution. Go on and create your first main.yml file into your project\u2019s root directory. Build and test your Application For those who are not familiar with Maven and Java project structures, here is the command for building and running your tests: mvn clean verify You need to launch this command from your pom.xml directory, or specify the path to it with --file /path/to/pom.xml argument. Note What is it supposed to do? This command will actually clear your previous builds inside your cache (otherwise your can have unexpected behavior because maven did not build again each part of your application), then it will freshly build each module inside your application, and finally it will run both Unit Tests and Integration Tests (sometime called Component Tests as well). Note Unit tests? Component tests? Integration tests require a database to verify you correctly inserted or retrieved data from it. Fortunately for you, we\u2019ve already taken care of this! But you still need to understand how it works under the hood. Take a look at your application file tree. Let\u2019s take a look at the pom.xml that is inside the simple-api , you will find some very helpful dependencies for your testing. <dependencies> <dependency> <groupId> org.testcontainers </groupId> <artifactId> testcontainers </artifactId> <version> ${testcontainers.version} </version> <scope> test </scope> </dependency> <dependency> <groupId> org.testcontainers </groupId> <artifactId> jdbc </artifactId> <version> ${testcontainers.version} </version> <scope> test </scope> </dependency> <dependency> <groupId> org.testcontainers </groupId> <artifactId> postgresql </artifactId> <version> ${testcontainers.version} </version> <scope> test </scope> </dependency> </dependencies> As you can see, there are a bunch of testcontainers dependencies inside the pom. Question 2-1 What are testcontainers? They simply are java libraries that allow you to run a bunch of docker containers while testing. Here we use the postgresql container to attach to our application while testing. If you run the command mvn clean verify you\u2019ll be able to see the following: As you can see, a docker container has been launched while your tests were running, pretty convenient, isn\u2019t it? Finally, you\u2019ll see your test results. Now, it is up to you! Create your first CI, asking to build and test your application every time someone commits and pushes code on the repository. First you create a .github/workflows directory in your repository on GitHub. Put your main.yml inside workflows. The main.yml holds the architecture of your pipeline. Each job will represent a step of what you want to do. Each job will be run in parallel unless a link is specified. Here is what your main.yml should look like: name : CI devops 2025 on : #to begin you want to launch this job in main and develop push : branches : #TODO pull_request : jobs : test-backend : runs-on : ubuntu-24.04 steps : #checkout your github code using actions/checkout@v4 - uses : actions/checkout@v4 #do the same with another action (actions/setup-java@v4) that enable to setup jdk 21 - name : Set up JDK 21 #TODO #finally build your app with the latest command - name : Build and test with Maven run : #TODO It\u2019s your turn, fill the #TODOs! To see the result you must follow the next steps: And if it\u2019s GREEN you win! Check First CI with backend test ! Question 2-2 Document your Github Actions configurations. First steps into the CD World Here we are going to configure the Continuous Delivery of our project. Therefore, the main goal will be to create and save a docker image containing our application on the Docker Hub every time there is a commit on a main branch. As you probably already noticed, you need to log in to docker hub to perform any publication. However, you don\u2019t want to publish your credentials on a public repository (it is not even a good practise to do it on a private repository). Fortunately, GitHub allows you to create secured environment variables. 1- Add your docker hub credentials to the environment variables in GitHub Actions (and let them secured). Note Secured Variables, why? Now that you added them, you can freely declare them and use them inside your GitHub Actions pipeline. 2- Build your docker images inside your GitHub Actions pipeline. Maybe the template Build a docker image can help you! For now, we only need to build the images # define job to build and publish docker image build-and-push-docker-image : needs : test-backend # run only when code is compiling and tests are passing runs-on : ubuntu-24.04 # steps to perform in job steps : - name : Checkout code uses : actions/checkout@v4 - name : Build image and push backend uses : docker/build-push-action@v6 with : # relative path to the place where source code with Dockerfile is located context : # Note: tags has to be all lower-case tags : ${{secrets.DOCKERHUB_USERNAME}}/tp-devops-simple-api:latest - name : Build image and push database # DO the same for database - name : Build image and push httpd # DO the same for httpd Note Why did we put needs: build-and-test-backend on this job? Maybe try without this and you will see! OK your images are built but not yet published on dockerhub . 3- Publish your docker images when there is a commit on the main branch. Don\u2019t forget to do a docker login and to put your credentials on secrets! - name : Login to DockerHub run : echo \"${{ secrets.DOCKERHUB_TOKEN }}\" | docker login --username ${{ secrets.DOCKERHUB_USERNAME }} --password-stdin And after modify job Build image and push backend to add a push action: - name : Build image and push backend uses : docker/build-push-action@v6 with : # relative path to the place where source code with Dockerfile is located context : # Note: tags has to be all lower-case tags : ${{secrets.DOCKERHUB_USERNAME}}/tp-devops-simple-api:latest # build on feature branches, push only on main branch push : ${{ github.ref == 'refs/heads/main' }} Do the same for other containers. Question 2-3 For what purpose do we need to push docker images? Now you should be able to find your docker images on your docker repository. Check Working CI & Docker images pushed to your repository. Setup Quality Gate What is quality about? Quality is here to make sure your code will be maintainable and determine every unsecured block. It helps you produce better and tested features, and it will also prevent having dirty code pushed inside your main branch. For this purpose, we are going to use SonarCloud , a cloud solution that makes analysis and reports of your code. This is a useful tool that everyone should use in order to learn java best practices. Register to SonarCloud Create your free-tier account on SonarCloud . SonarCloud will propose you to set up your GitHub Actions pipeline from the GitHub Actions , but forget about that, there is a much better way to save the SonarCloud provided and provide it into your main.yml . 1- You must create an organization. 2- And keep the project key and the organization key you will need it later. 3- You need to add this script to your main.yml for launch sonar at each commit. Set up your pipeline to use SonarCloud analysis while testing. For that, you need to add a new step after Build and test with Maven and change sonar organization and project key. mvn -B verify sonar:sonar -Dsonar.projectKey = <your-project-key> -Dsonar.organization = <your-organization> -Dsonar.host.url = https://sonarcloud.io -Dsonar.login = ${ { secrets.SONAR_TOKEN } } --file ./simple-api/pom.xml If you did your configuration correctly, you should be able to see the SonarCloud analysis report online: Check Working quality gate. Question 2-4 Document your quality gate configuration. Well done buddies, you\u2019ve created your very first Quality Gate! Yay! Going further: Split pipelines In this step you have to separate your jobs into different workflows so that they respect 2 things: test-backend must be launched on develop and master branch and build-and-push-docker-image on master only. The job that pushes the docker api image must be launched only if test-backend is passed. Tip You can use on: workflow_run to trigger a workflow when another workflow is passed. \u00a9 Takima 2025","title":"TP part 02 - Github Actions"},{"location":"ch2-discover-github-actions-tp/#discover-github-action","text":"Check Checkpoint: call us to check your results (don\u2019t stay blocked on a checkpoint if we are busy, we can check \u2154 checkpoints at the same time) Question Point to document/report Tip Interesting information","title":"Discover Github Action"},{"location":"ch2-discover-github-actions-tp/#goals","text":"","title":"Goals"},{"location":"ch2-discover-github-actions-tp/#good-practice","text":"Do not forget to document what you do along the steps. Create an appropriate file structure, 1 folder per image.","title":"Good Practice"},{"location":"ch2-discover-github-actions-tp/#target-application","text":"Complete pipeline workflow for testing and delivering your software application. We are going to use different useful tools to build your application, test it automatically, and check the code quality at the same time. Link GitHub Actions","title":"Target Application"},{"location":"ch2-discover-github-actions-tp/#setup-github-actions","text":"The first tool we are going to use is GitHub Actions . GitHub Actions is an online service that allows you to build pipelines to test your application. Keep in mind that GitHub Actions is not the only one on the market to build integration pipelines. Historically many companies were using Jenkins (and still a lot continue to do it), it is way less accessible than GitHub Actions but much more configurable. You will also hear about Gitlab CI and Bitbucket Pipelines during your work life.","title":"Setup GitHub Actions"},{"location":"ch2-discover-github-actions-tp/#first-steps-into-the-ci-world","text":"Note Use your repository from the end of the Docker TP Most of the CI services use a yaml file (except Jenkins that uses a\u2026 Groovy file\u2026) to describe the expected steps to be done over the pipeline execution. Go on and create your first main.yml file into your project\u2019s root directory.","title":"First steps into the CI World"},{"location":"ch2-discover-github-actions-tp/#build-and-test-your-application","text":"For those who are not familiar with Maven and Java project structures, here is the command for building and running your tests: mvn clean verify You need to launch this command from your pom.xml directory, or specify the path to it with --file /path/to/pom.xml argument. Note What is it supposed to do? This command will actually clear your previous builds inside your cache (otherwise your can have unexpected behavior because maven did not build again each part of your application), then it will freshly build each module inside your application, and finally it will run both Unit Tests and Integration Tests (sometime called Component Tests as well). Note Unit tests? Component tests? Integration tests require a database to verify you correctly inserted or retrieved data from it. Fortunately for you, we\u2019ve already taken care of this! But you still need to understand how it works under the hood. Take a look at your application file tree. Let\u2019s take a look at the pom.xml that is inside the simple-api , you will find some very helpful dependencies for your testing. <dependencies> <dependency> <groupId> org.testcontainers </groupId> <artifactId> testcontainers </artifactId> <version> ${testcontainers.version} </version> <scope> test </scope> </dependency> <dependency> <groupId> org.testcontainers </groupId> <artifactId> jdbc </artifactId> <version> ${testcontainers.version} </version> <scope> test </scope> </dependency> <dependency> <groupId> org.testcontainers </groupId> <artifactId> postgresql </artifactId> <version> ${testcontainers.version} </version> <scope> test </scope> </dependency> </dependencies> As you can see, there are a bunch of testcontainers dependencies inside the pom. Question 2-1 What are testcontainers? They simply are java libraries that allow you to run a bunch of docker containers while testing. Here we use the postgresql container to attach to our application while testing. If you run the command mvn clean verify you\u2019ll be able to see the following: As you can see, a docker container has been launched while your tests were running, pretty convenient, isn\u2019t it? Finally, you\u2019ll see your test results. Now, it is up to you! Create your first CI, asking to build and test your application every time someone commits and pushes code on the repository. First you create a .github/workflows directory in your repository on GitHub. Put your main.yml inside workflows. The main.yml holds the architecture of your pipeline. Each job will represent a step of what you want to do. Each job will be run in parallel unless a link is specified. Here is what your main.yml should look like: name : CI devops 2025 on : #to begin you want to launch this job in main and develop push : branches : #TODO pull_request : jobs : test-backend : runs-on : ubuntu-24.04 steps : #checkout your github code using actions/checkout@v4 - uses : actions/checkout@v4 #do the same with another action (actions/setup-java@v4) that enable to setup jdk 21 - name : Set up JDK 21 #TODO #finally build your app with the latest command - name : Build and test with Maven run : #TODO It\u2019s your turn, fill the #TODOs! To see the result you must follow the next steps: And if it\u2019s GREEN you win! Check First CI with backend test ! Question 2-2 Document your Github Actions configurations.","title":"Build and test your Application"},{"location":"ch2-discover-github-actions-tp/#first-steps-into-the-cd-world","text":"Here we are going to configure the Continuous Delivery of our project. Therefore, the main goal will be to create and save a docker image containing our application on the Docker Hub every time there is a commit on a main branch. As you probably already noticed, you need to log in to docker hub to perform any publication. However, you don\u2019t want to publish your credentials on a public repository (it is not even a good practise to do it on a private repository). Fortunately, GitHub allows you to create secured environment variables. 1- Add your docker hub credentials to the environment variables in GitHub Actions (and let them secured). Note Secured Variables, why? Now that you added them, you can freely declare them and use them inside your GitHub Actions pipeline. 2- Build your docker images inside your GitHub Actions pipeline. Maybe the template Build a docker image can help you! For now, we only need to build the images # define job to build and publish docker image build-and-push-docker-image : needs : test-backend # run only when code is compiling and tests are passing runs-on : ubuntu-24.04 # steps to perform in job steps : - name : Checkout code uses : actions/checkout@v4 - name : Build image and push backend uses : docker/build-push-action@v6 with : # relative path to the place where source code with Dockerfile is located context : # Note: tags has to be all lower-case tags : ${{secrets.DOCKERHUB_USERNAME}}/tp-devops-simple-api:latest - name : Build image and push database # DO the same for database - name : Build image and push httpd # DO the same for httpd Note Why did we put needs: build-and-test-backend on this job? Maybe try without this and you will see! OK your images are built but not yet published on dockerhub . 3- Publish your docker images when there is a commit on the main branch. Don\u2019t forget to do a docker login and to put your credentials on secrets! - name : Login to DockerHub run : echo \"${{ secrets.DOCKERHUB_TOKEN }}\" | docker login --username ${{ secrets.DOCKERHUB_USERNAME }} --password-stdin And after modify job Build image and push backend to add a push action: - name : Build image and push backend uses : docker/build-push-action@v6 with : # relative path to the place where source code with Dockerfile is located context : # Note: tags has to be all lower-case tags : ${{secrets.DOCKERHUB_USERNAME}}/tp-devops-simple-api:latest # build on feature branches, push only on main branch push : ${{ github.ref == 'refs/heads/main' }} Do the same for other containers. Question 2-3 For what purpose do we need to push docker images? Now you should be able to find your docker images on your docker repository. Check Working CI & Docker images pushed to your repository.","title":"First steps into the CD World"},{"location":"ch2-discover-github-actions-tp/#setup-quality-gate","text":"","title":"Setup Quality Gate"},{"location":"ch2-discover-github-actions-tp/#what-is-quality-about","text":"Quality is here to make sure your code will be maintainable and determine every unsecured block. It helps you produce better and tested features, and it will also prevent having dirty code pushed inside your main branch. For this purpose, we are going to use SonarCloud , a cloud solution that makes analysis and reports of your code. This is a useful tool that everyone should use in order to learn java best practices.","title":"What is quality about?"},{"location":"ch2-discover-github-actions-tp/#register-to-sonarcloud","text":"Create your free-tier account on SonarCloud . SonarCloud will propose you to set up your GitHub Actions pipeline from the GitHub Actions , but forget about that, there is a much better way to save the SonarCloud provided and provide it into your main.yml . 1- You must create an organization. 2- And keep the project key and the organization key you will need it later. 3- You need to add this script to your main.yml for launch sonar at each commit. Set up your pipeline to use SonarCloud analysis while testing. For that, you need to add a new step after Build and test with Maven and change sonar organization and project key. mvn -B verify sonar:sonar -Dsonar.projectKey = <your-project-key> -Dsonar.organization = <your-organization> -Dsonar.host.url = https://sonarcloud.io -Dsonar.login = ${ { secrets.SONAR_TOKEN } } --file ./simple-api/pom.xml If you did your configuration correctly, you should be able to see the SonarCloud analysis report online: Check Working quality gate. Question 2-4 Document your quality gate configuration. Well done buddies, you\u2019ve created your very first Quality Gate! Yay!","title":"Register to SonarCloud"},{"location":"ch2-discover-github-actions-tp/#going-further-split-pipelines","text":"In this step you have to separate your jobs into different workflows so that they respect 2 things: test-backend must be launched on develop and master branch and build-and-push-docker-image on master only. The job that pushes the docker api image must be launched only if test-backend is passed. Tip You can use on: workflow_run to trigger a workflow when another workflow is passed. \u00a9 Takima 2025","title":"Going further: Split pipelines"},{"location":"cheatsheet/","text":"Cheatsheet Docker & docker-compose","title":"Cheatsheet"},{"location":"cheatsheet/#cheatsheet","text":"","title":"Cheatsheet"},{"location":"cheatsheet/#docker-docker-compose","text":"","title":"Docker & docker-compose"}]}
\ No newline at end of file
diff --git a/public/sitemap.xml b/public/sitemap.xml
index 2e5dcb98d41e463032f52295497003001bae9f01..34b4b86166fa85f56ca99793f7f965f771e94a73 100644
--- a/public/sitemap.xml
+++ b/public/sitemap.xml
@@ -20,4 +20,14 @@
<lastmod>2025-04-30</lastmod>
<changefreq>daily</changefreq>
</url>
+ <url>
+ <loc>None</loc>
+ <lastmod>2025-04-30</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+ <url>
+ <loc>None</loc>
+ <lastmod>2025-04-30</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
</urlset>
\ No newline at end of file
diff --git a/public/sitemap.xml.gz b/public/sitemap.xml.gz
index f31192459a9d0852cdd616fadc1b3694a6c5201c..214b1330c6d8c6831f4ae2dbc08f16e93915a269 100644
Binary files a/public/sitemap.xml.gz and b/public/sitemap.xml.gz differ