From 162b97ed0c672b6cdc42578eeddf455cde553b53 Mon Sep 17 00:00:00 2001
From: Yoni Bettan <yonibettan@gmail.com>
Date: Mon, 27 Jun 2022 17:09:53 +0300
Subject: [PATCH] Adding documentation for pre-building driver-containers.
 (#85)

KMMO is mounting /lib/modules/$(KVER) from the node to the driver-container
in order to use potential in-tree dependencies, therefore, some adjustment
are needed for the driver-container so KMMO don't override the *.ko files of
the user.

MGMT-10194

Signed-off-by: Yoni Bettan <yonibettan@gmail.com>
---
 docs/mkdocs/driver_containers.md              |  12 ++
 docs/site/404.html                            |   3 +
 docs/site/developer/index.html                |   5 +-
 .../developer/reconciliation_loops/index.html |   3 +
 docs/site/developer/use_cases/index.html      |   3 +
 docs/site/driver_containers/index.html        | 165 ++++++++++++++++++
 docs/site/index.html                          |   7 +-
 docs/site/sitemap.xml                         |  13 +-
 docs/site/sitemap.xml.gz                      | Bin 199 -> 199 bytes
 9 files changed, 204 insertions(+), 7 deletions(-)
 create mode 100644 docs/mkdocs/driver_containers.md
 create mode 100644 docs/site/driver_containers/index.html

diff --git a/docs/mkdocs/driver_containers.md b/docs/mkdocs/driver_containers.md
new file mode 100644
index 000000000..81ff688b3
--- /dev/null
+++ b/docs/mkdocs/driver_containers.md
@@ -0,0 +1,12 @@
+# How to build driver-containers to be used by KMMO
+
+### Pre-build driver-containers
+
+When a `Module` CR is applied to the cluster, KMMO will create a DaemonSet to run the driver-container specified in it.
+
+In order for driver-containers that depend on in-tree kernel-modules to work, KMMO is mounting `/lib/modules/${KVER}` from the node to the container, which means that it will override all files located in `/lib/modules/${KVER}` inside the driver-container.
+
+Therefore, when building a driver-container that is going to be used by KMMO, there are few things that needs to be done in the driver-container:
+* Put the `*.ko` files in `/opt/lib/modules/${KVER}` instead of `/lib/modules/${KVER}`
+* Link `/lib/modules/${KVER}` inside `/opt/lib/modules/$(KVER)/system` in case the driver-container depend on in-tree kernel-modules
+* Run `depmod -b /opt` in order to generate the dependency file correctly
diff --git a/docs/site/404.html b/docs/site/404.html
index 7d8c2c9e0..2145fc077 100644
--- a/docs/site/404.html
+++ b/docs/site/404.html
@@ -36,6 +36,9 @@
                             <li class="navitem">
                                 <a href="/." class="nav-link">Home</a>
                             </li>
+                            <li class="navitem">
+                                <a href="/driver_containers/" class="nav-link">How to build driver-containers to be used by KMMO</a>
+                            </li>
                             <li class="dropdown">
                                 <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Developer <b class="caret"></b></a>
                                 <ul class="dropdown-menu">
diff --git a/docs/site/developer/index.html b/docs/site/developer/index.html
index 6a5245c75..b4441f6a9 100644
--- a/docs/site/developer/index.html
+++ b/docs/site/developer/index.html
@@ -36,6 +36,9 @@
                             <li class="navitem">
                                 <a href=".." class="nav-link">Home</a>
                             </li>
+                            <li class="navitem">
+                                <a href="../driver_containers/" class="nav-link">How to build driver-containers to be used by KMMO</a>
+                            </li>
                             <li class="dropdown active">
                                 <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Developer <b class="caret"></b></a>
                                 <ul class="dropdown-menu">
@@ -57,7 +60,7 @@
 
                     <ul class="nav navbar-nav ml-auto">
                             <li class="nav-item">
-                                <a rel="prev" href=".." class="nav-link">
+                                <a rel="prev" href="../driver_containers/" class="nav-link">
                                     <i class="fa fa-arrow-left"></i> Previous
                                 </a>
                             </li>
diff --git a/docs/site/developer/reconciliation_loops/index.html b/docs/site/developer/reconciliation_loops/index.html
index f66dfd39f..82a9c3412 100644
--- a/docs/site/developer/reconciliation_loops/index.html
+++ b/docs/site/developer/reconciliation_loops/index.html
@@ -36,6 +36,9 @@
                             <li class="navitem">
                                 <a href="../.." class="nav-link">Home</a>
                             </li>
+                            <li class="navitem">
+                                <a href="../../driver_containers/" class="nav-link">How to build driver-containers to be used by KMMO</a>
+                            </li>
                             <li class="dropdown active">
                                 <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Developer <b class="caret"></b></a>
                                 <ul class="dropdown-menu">
diff --git a/docs/site/developer/use_cases/index.html b/docs/site/developer/use_cases/index.html
index 07ba7bac3..4ae9a10ff 100644
--- a/docs/site/developer/use_cases/index.html
+++ b/docs/site/developer/use_cases/index.html
@@ -36,6 +36,9 @@
                             <li class="navitem">
                                 <a href="../.." class="nav-link">Home</a>
                             </li>
+                            <li class="navitem">
+                                <a href="../../driver_containers/" class="nav-link">How to build driver-containers to be used by KMMO</a>
+                            </li>
                             <li class="dropdown active">
                                 <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Developer <b class="caret"></b></a>
                                 <ul class="dropdown-menu">
diff --git a/docs/site/driver_containers/index.html b/docs/site/driver_containers/index.html
new file mode 100644
index 000000000..3f99731a5
--- /dev/null
+++ b/docs/site/driver_containers/index.html
@@ -0,0 +1,165 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        
+        
+        
+        <link rel="shortcut icon" href="../img/favicon.ico">
+        <title>How to build driver-containers to be used by KMMO - Out-Of-Tree operator</title>
+        <link href="../css/bootstrap.min.css" rel="stylesheet">
+        <link href="../css/font-awesome.min.css" rel="stylesheet">
+        <link href="../css/base.css" rel="stylesheet">
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css">
+
+        <script src="../js/jquery-1.10.2.min.js" defer></script>
+        <script src="../js/bootstrap.min.js" defer></script>
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
+        <script>hljs.initHighlightingOnLoad();</script> 
+    </head>
+
+    <body>
+        <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
+            <div class="container">
+                <a class="navbar-brand" href="..">Out-Of-Tree operator</a>
+                <!-- Expander button -->
+                <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
+                    <span class="navbar-toggler-icon"></span>
+                </button>
+
+                <!-- Expanded navigation -->
+                <div id="navbar-collapse" class="navbar-collapse collapse">
+                        <!-- Main navigation -->
+                        <ul class="nav navbar-nav">
+                            <li class="navitem">
+                                <a href=".." class="nav-link">Home</a>
+                            </li>
+                            <li class="navitem active">
+                                <a href="./" class="nav-link">How to build driver-containers to be used by KMMO</a>
+                            </li>
+                            <li class="dropdown">
+                                <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Developer <b class="caret"></b></a>
+                                <ul class="dropdown-menu">
+                                    
+<li>
+    <a href="../developer/" class="dropdown-item">Design notes</a>
+</li>
+                                    
+<li>
+    <a href="../developer/reconciliation_loops/" class="dropdown-item">Reconciliation loop</a>
+</li>
+                                    
+<li>
+    <a href="../developer/use_cases/" class="dropdown-item">Use cases</a>
+</li>
+                                </ul>
+                            </li>
+                        </ul>
+
+                    <ul class="nav navbar-nav ml-auto">
+                            <li class="nav-item">
+                                <a rel="prev" href=".." class="nav-link">
+                                    <i class="fa fa-arrow-left"></i> Previous
+                                </a>
+                            </li>
+                            <li class="nav-item">
+                                <a rel="next" href="../developer/" class="nav-link">
+                                    Next <i class="fa fa-arrow-right"></i>
+                                </a>
+                            </li>
+                            <li class="nav-item">
+                                <a href="https://github.com/qbarrand/oot-operator/edit/main/docs/driver_containers.md" class="nav-link"><i class="fa fa-github"></i> Edit on GitHub</a>
+                            </li>
+                    </ul>
+                </div>
+            </div>
+        </div>
+
+        <div class="container">
+            <div class="row">
+                    <div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
+    <div class="navbar-header">
+        <button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
+            <span class="fa fa-angle-down"></span>
+        </button>
+    </div>
+
+    
+    <div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
+        <ul class="nav flex-column">
+            
+            <li class="nav-item" data-level="1"><a href="#how-to-build-driver-containers-to-be-used-by-kmmo" class="nav-link">How to build driver-containers to be used by KMMO</a>
+              <ul class="nav flex-column">
+              </ul>
+            </li>
+        </ul>
+    </div>
+</div></div>
+                    <div class="col-md-9" role="main">
+
+<h1 id="how-to-build-driver-containers-to-be-used-by-kmmo">How to build driver-containers to be used by KMMO</h1>
+<h3 id="pre-build-driver-containers">Pre-build driver-containers</h3>
+<p>When a <code>Module</code> CR is applied to the cluster, KMMO will create a DaemonSet to run the driver-container specified in it.</p>
+<p>In order for driver-containers that depend on in-tree kernel-modules to work, KMMO is mounting <code>/lib/modules/${KVER}</code> from the node to the container, which means that it will override all files located in <code>/lib/modules/${KVER}</code> inside the driver-container.</p>
+<p>Therefore, when building a driver-container that is going to be used by KMMO, there are few things that needs to be done in the driver-container:
+* Put the <code>*.ko</code> files in <code>/opt/lib/modules/${KVER}</code> instead of <code>/lib/modules/${KVER}</code>
+* Link <code>/lib/modules/${KVER}</code> inside <code>/opt/lib/modules/$(KVER)/system</code> in case the driver-container depend on in-tree kernel-modules
+* Run <code>depmod -b /opt</code> in order to generate the dependency file correctly</p></div>
+            </div>
+        </div>
+
+        <footer class="col-md-12">
+            <hr>
+            <p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
+        </footer>
+        <script>
+            var base_url = "..",
+                shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
+        </script>
+        <script src="../js/base.js" defer></script>
+
+        <div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
+    <div class="modal-dialog">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
+                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
+            </div>
+            <div class="modal-body">
+              <table class="table">
+                <thead>
+                  <tr>
+                    <th style="width: 20%;">Keys</th>
+                    <th>Action</th>
+                  </tr>
+                </thead>
+                <tbody>
+                  <tr>
+                    <td class="help shortcut"><kbd>?</kbd></td>
+                    <td>Open this help</td>
+                  </tr>
+                  <tr>
+                    <td class="next shortcut"><kbd>n</kbd></td>
+                    <td>Next page</td>
+                  </tr>
+                  <tr>
+                    <td class="prev shortcut"><kbd>p</kbd></td>
+                    <td>Previous page</td>
+                  </tr>
+                  <tr>
+                    <td class="search shortcut"><kbd>s</kbd></td>
+                    <td>Search</td>
+                  </tr>
+                </tbody>
+              </table>
+            </div>
+            <div class="modal-footer">
+            </div>
+        </div>
+    </div>
+</div>
+
+    </body>
+</html>
diff --git a/docs/site/index.html b/docs/site/index.html
index c889ac459..2f782a5b6 100644
--- a/docs/site/index.html
+++ b/docs/site/index.html
@@ -36,6 +36,9 @@
                             <li class="navitem active">
                                 <a href="." class="nav-link">Home</a>
                             </li>
+                            <li class="navitem">
+                                <a href="driver_containers/" class="nav-link">How to build driver-containers to be used by KMMO</a>
+                            </li>
                             <li class="dropdown">
                                 <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Developer <b class="caret"></b></a>
                                 <ul class="dropdown-menu">
@@ -62,7 +65,7 @@
                                 </a>
                             </li>
                             <li class="nav-item">
-                                <a rel="next" href="developer/" class="nav-link">
+                                <a rel="next" href="driver_containers/" class="nav-link">
                                     Next <i class="fa fa-arrow-right"></i>
                                 </a>
                             </li>
@@ -170,5 +173,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.3.0
-Build Date UTC : 2022-04-13 11:41:08.787831+00:00
+Build Date UTC : 2022-06-27 12:28:48.290439+00:00
 -->
diff --git a/docs/site/sitemap.xml b/docs/site/sitemap.xml
index 20e5599a2..b18229871 100644
--- a/docs/site/sitemap.xml
+++ b/docs/site/sitemap.xml
@@ -2,22 +2,27 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>None</loc>
-         <lastmod>2022-04-13</lastmod>
+         <lastmod>2022-06-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-04-13</lastmod>
+         <lastmod>2022-06-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-04-13</lastmod>
+         <lastmod>2022-06-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-04-13</lastmod>
+         <lastmod>2022-06-27</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>None</loc>
+         <lastmod>2022-06-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
\ No newline at end of file
diff --git a/docs/site/sitemap.xml.gz b/docs/site/sitemap.xml.gz
index b12ffaecef07743c3e377923f6c518a20714cc3a..094e90b7722d88d44b65f9c36b41c0d1a2f21b6d 100644
GIT binary patch
literal 199
zcmV;&06702iwFpSqPb!M|8r?{Wo=<_E_iKh0PT`Z4#FT1h4(!LVP6JW_!mldE?wyX
z2*sA9g$ii(_R^o2-a%(GZ{EDjw;5i(x)wdP560O7ZwSRmTjeTa>jGadr+kk~k@1Ib
zgN`VLZ76UPV}Aq~hJgeVbtn5koUb9MCJg}=6DT=gk)c%Mfmuz(Tc^a?S<PWo>xB%l
zbCqC}v7Bymwo8%4Tg6l(ZLM!!-$f-&`{uB6W+Hr%fB0{~r<UGTd;kRcFpb^<007a5
BSjqqZ

literal 199
zcmV;&06702iwFqRwpL;S|8r?{Wo=<_E_iKh0PT`J62c%5g?mrI(1#__LLEXnODjD9
zLoi{6Km;^;d&$o@If0ei?Ay0*_G^|^ug;*S@<BUW;+#;7l$Ea5wkh%Ta?19&;v4qx
zCa8!~*oG3fG4@A*VHilzQFWpZ#Q6q-Y|{{6F@cf;<{Ol1JTR-Nm~oPyomC7*wO)u2
zJ6H397DYyPS-wq?#aqQ>D{P}~Ufp>uw0SdFIWrNy$Upq&@TsMb;U57O-*jOD0081E
BTz~)o