Update documentation

nokia · Jan 13, 2025 · 4b868ea · 4b868ea
1 parent 27e3bc5
commit 4b868ea
Show file tree

Hide file tree

Showing 16 changed files with 29 additions and 385 deletions.
diff --git a/docs/404.html b/docs/404.html
@@ -793,27 +793,6 @@
 
 
 
-    <li class="md-nav__item">
-      <a href="/release-notes/1.1.2/" class="md-nav__link">
-
-
-  <span class="md-ellipsis">
-    1.1.2
-  </span>
-
-
-      </a>
-    </li>
-
-
-
-
-
-
-
-
-
-
     <li class="md-nav__item">
       <a href="/release-notes/1.1.1/" class="md-nav__link">
 

diff --git a/docs/documentation/CRDs/cluster-issuer/index.html b/docs/documentation/CRDs/cluster-issuer/index.html
@@ -881,27 +881,6 @@
 
 
 
-    <li class="md-nav__item">
-      <a href="../../../release-notes/1.1.2/" class="md-nav__link">
-
-
-  <span class="md-ellipsis">
-    1.1.2
-  </span>
-
-
-      </a>
-    </li>
-
-
-
-
-
-
-
-
-
-
     <li class="md-nav__item">
       <a href="../../../release-notes/1.1.1/" class="md-nav__link">
 

diff --git a/docs/documentation/CRDs/issuer/index.html b/docs/documentation/CRDs/issuer/index.html
@@ -881,27 +881,6 @@
 
 
 
-    <li class="md-nav__item">
-      <a href="../../../release-notes/1.1.2/" class="md-nav__link">
-
-
-  <span class="md-ellipsis">
-    1.1.2
-  </span>
-
-
-      </a>
-    </li>
-
-
-
-
-
-
-
-
-
-
     <li class="md-nav__item">
       <a href="../../../release-notes/1.1.1/" class="md-nav__link">
 

diff --git a/docs/documentation/certificates/certificates/index.html b/docs/documentation/certificates/certificates/index.html
@@ -833,27 +833,6 @@
 
 
 
-    <li class="md-nav__item">
-      <a href="../../../release-notes/1.1.2/" class="md-nav__link">
-
-
-  <span class="md-ellipsis">
-    1.1.2
-  </span>
-
-
-      </a>
-    </li>
-
-
-
-
-
-
-
-
-
-
     <li class="md-nav__item">
       <a href="../../../release-notes/1.1.1/" class="md-nav__link">
 

diff --git a/docs/documentation/configuration/index.html b/docs/documentation/configuration/index.html
@@ -888,27 +888,6 @@
 
 
 
-    <li class="md-nav__item">
-      <a href="../../release-notes/1.1.2/" class="md-nav__link">
-
-
-  <span class="md-ellipsis">
-    1.1.2
-  </span>
-
-
-      </a>
-    </li>
-
-
-
-
-
-
-
-
-
-
     <li class="md-nav__item">
       <a href="../../release-notes/1.1.1/" class="md-nav__link">
 

diff --git a/docs/documentation/installation/index.html b/docs/documentation/installation/index.html
@@ -888,27 +888,6 @@
 
 
 
-    <li class="md-nav__item">
-      <a href="../../release-notes/1.1.2/" class="md-nav__link">
-
-
-  <span class="md-ellipsis">
-    1.1.2
-  </span>
-
-
-      </a>
-    </li>
-
-
-
-
-
-
-
-
-
-
     <li class="md-nav__item">
       <a href="../../release-notes/1.1.1/" class="md-nav__link">
 
@@ -1069,7 +1048,7 @@ <h1 id="installation">Installation</h1>
 <h2 id="prerequisites">Prerequisites</h2>
 <p>Prerequisites for using ncm-issuer:</p>
 <ul>
-<li><a href="https://www.nokia.com/networks/products/pki-authority-with-netguard-certificate-manager/">NCM</a> release 21 or later,</li>
+<li><a href="https://www.nokia.com/networks/products/pki-authority-with-netguard-certificate-manager/">NCM</a> release 23 or later,</li>
 <li><a href="https://kubernetes.io">Kubernetes</a> version 1.24 - 1.29,</li>
 <li><a href="https://cert-manager.io/">cert-manager</a> version 1.0.0 or later,</li>
 <li><a href="https://docs.docker.com/engine/install/">Docker</a> version 20.10.0 or later,</li>

diff --git a/docs/documentation/metrics/enable-metrics/index.html b/docs/documentation/metrics/enable-metrics/index.html
@@ -890,27 +890,6 @@
 
 
 
-    <li class="md-nav__item">
-      <a href="../../../release-notes/1.1.2/" class="md-nav__link">
-
-
-  <span class="md-ellipsis">
-    1.1.2
-  </span>
-
-
-      </a>
-    </li>
-
-
-
-
-
-
-
-
-
-
     <li class="md-nav__item">
       <a href="../../../release-notes/1.1.1/" class="md-nav__link">
 

diff --git a/docs/documentation/troubleshooting/index.html b/docs/documentation/troubleshooting/index.html
@@ -888,27 +888,6 @@
 
 
 
-    <li class="md-nav__item">
-      <a href="../../release-notes/1.1.2/" class="md-nav__link">
-
-
-  <span class="md-ellipsis">
-    1.1.2
-  </span>
-
-
-      </a>
-    </li>
-
-
-
-
-
-
-
-
-
-
     <li class="md-nav__item">
       <a href="../../release-notes/1.1.1/" class="md-nav__link">
 

diff --git a/docs/documentation/tutorials/first-certificate/index.html b/docs/documentation/tutorials/first-certificate/index.html
@@ -881,27 +881,6 @@
 
 
 
-    <li class="md-nav__item">
-      <a href="../../../release-notes/1.1.2/" class="md-nav__link">
-
-
-  <span class="md-ellipsis">
-    1.1.2
-  </span>
-
-
-      </a>
-    </li>
-
-
-
-
-
-
-
-
-
-
     <li class="md-nav__item">
       <a href="../../../release-notes/1.1.1/" class="md-nav__link">
 
@@ -1090,26 +1069,28 @@ <h2 id="signing-certificate">Signing certificate</h2>
 </span><span id="__span-2-5"><a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="s">  name: example-ncm-certificate</span>
 </span><span id="__span-2-6"><a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="s">  namespace: example-ncm-ns</span>
 </span><span id="__span-2-7"><a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="s">spec:</span>
-</span><span id="__span-2-8"><a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="s">  commonName: example-ncm-certificate-nokia-ncm.local</span>
-</span><span id="__span-2-9"><a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="s">  dnsNames:</span>
-</span><span id="__span-2-10"><a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="s">  - example-ncm-certificate-nokia-ncm.local</span>
-</span><span id="__span-2-11"><a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a><span class="s">  subject:</span>
-</span><span id="__span-2-12"><a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a><span class="s">    countries:</span>
-</span><span id="__span-2-13"><a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a><span class="s">    - PL</span>
-</span><span id="__span-2-14"><a id="__codelineno-2-14" name="__codelineno-2-14" href="#__codelineno-2-14"></a><span class="s">    organizationalUnits:</span>
-</span><span id="__span-2-15"><a id="__codelineno-2-15" name="__codelineno-2-15" href="#__codelineno-2-15"></a><span class="s">    - Security</span>
-</span><span id="__span-2-16"><a id="__codelineno-2-16" name="__codelineno-2-16" href="#__codelineno-2-16"></a><span class="s">    organizations:</span>
-</span><span id="__span-2-17"><a id="__codelineno-2-17" name="__codelineno-2-17" href="#__codelineno-2-17"></a><span class="s">    - Nokia</span>
-</span><span id="__span-2-18"><a id="__codelineno-2-18" name="__codelineno-2-18" href="#__codelineno-2-18"></a><span class="s">  usages:</span>
-</span><span id="__span-2-19"><a id="__codelineno-2-19" name="__codelineno-2-19" href="#__codelineno-2-19"></a><span class="s">  - server auth</span>
-</span><span id="__span-2-20"><a id="__codelineno-2-20" name="__codelineno-2-20" href="#__codelineno-2-20"></a><span class="s">  - data encipherment</span>
-</span><span id="__span-2-21"><a id="__codelineno-2-21" name="__codelineno-2-21" href="#__codelineno-2-21"></a><span class="s">  secretName: example-ncm-certificate-nokia-ncm-tls</span>
-</span><span id="__span-2-22"><a id="__codelineno-2-22" name="__codelineno-2-22" href="#__codelineno-2-22"></a><span class="s">  issuerRef:</span>
-</span><span id="__span-2-23"><a id="__codelineno-2-23" name="__codelineno-2-23" href="#__codelineno-2-23"></a><span class="s">    group: certmanager.ncm.nokia.com</span>
-</span><span id="__span-2-24"><a id="__codelineno-2-24" name="__codelineno-2-24" href="#__codelineno-2-24"></a><span class="s">    kind: Issuer</span>
-</span><span id="__span-2-25"><a id="__codelineno-2-25" name="__codelineno-2-25" href="#__codelineno-2-25"></a><span class="s">    name: example-ncm-issuer</span>
-</span><span id="__span-2-26"><a id="__codelineno-2-26" name="__codelineno-2-26" href="#__codelineno-2-26"></a><span class="s">EOF</span>
+</span><span id="__span-2-8"><a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="s">  duration: 4382h</span>
+</span><span id="__span-2-9"><a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="s">  commonName: example-ncm-certificate-nokia-ncm.local</span>
+</span><span id="__span-2-10"><a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="s">  dnsNames:</span>
+</span><span id="__span-2-11"><a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a><span class="s">  - example-ncm-certificate-nokia-ncm.local</span>
+</span><span id="__span-2-12"><a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a><span class="s">  subject:</span>
+</span><span id="__span-2-13"><a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a><span class="s">    countries:</span>
+</span><span id="__span-2-14"><a id="__codelineno-2-14" name="__codelineno-2-14" href="#__codelineno-2-14"></a><span class="s">    - PL</span>
+</span><span id="__span-2-15"><a id="__codelineno-2-15" name="__codelineno-2-15" href="#__codelineno-2-15"></a><span class="s">    organizationalUnits:</span>
+</span><span id="__span-2-16"><a id="__codelineno-2-16" name="__codelineno-2-16" href="#__codelineno-2-16"></a><span class="s">    - Security</span>
+</span><span id="__span-2-17"><a id="__codelineno-2-17" name="__codelineno-2-17" href="#__codelineno-2-17"></a><span class="s">    organizations:</span>
+</span><span id="__span-2-18"><a id="__codelineno-2-18" name="__codelineno-2-18" href="#__codelineno-2-18"></a><span class="s">    - Nokia</span>
+</span><span id="__span-2-19"><a id="__codelineno-2-19" name="__codelineno-2-19" href="#__codelineno-2-19"></a><span class="s">  usages:</span>
+</span><span id="__span-2-20"><a id="__codelineno-2-20" name="__codelineno-2-20" href="#__codelineno-2-20"></a><span class="s">  - server auth</span>
+</span><span id="__span-2-21"><a id="__codelineno-2-21" name="__codelineno-2-21" href="#__codelineno-2-21"></a><span class="s">  - data encipherment</span>
+</span><span id="__span-2-22"><a id="__codelineno-2-22" name="__codelineno-2-22" href="#__codelineno-2-22"></a><span class="s">  secretName: example-ncm-certificate-nokia-ncm-tls</span>
+</span><span id="__span-2-23"><a id="__codelineno-2-23" name="__codelineno-2-23" href="#__codelineno-2-23"></a><span class="s">  issuerRef:</span>
+</span><span id="__span-2-24"><a id="__codelineno-2-24" name="__codelineno-2-24" href="#__codelineno-2-24"></a><span class="s">    group: certmanager.ncm.nokia.com</span>
+</span><span id="__span-2-25"><a id="__codelineno-2-25" name="__codelineno-2-25" href="#__codelineno-2-25"></a><span class="s">    kind: Issuer</span>
+</span><span id="__span-2-26"><a id="__codelineno-2-26" name="__codelineno-2-26" href="#__codelineno-2-26"></a><span class="s">    name: example-ncm-issuer</span>
+</span><span id="__span-2-27"><a id="__codelineno-2-27" name="__codelineno-2-27" href="#__codelineno-2-27"></a><span class="s">EOF</span>
 </span></code></pre></div>
+<p>NOTE: Duration parameter is ignored, unless NCM release &gt;= <code>24.11</code> (with REST API &gt;= <code>1.13</code>) is used and CA's <code>set-validity-period</code> policy module's <code>Overwrite Old</code> parameter is set to false</p>
 <p>Then we can check the status of our newly issued certificate:</p>
 <div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>kubectl<span class="w"> </span>get<span class="w"> </span>certificates<span class="w"> </span>-n<span class="w"> </span>example-ncm-ns
 </span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>

diff --git a/docs/index.html b/docs/index.html
@@ -873,10 +873,6 @@
 
 
 
-
-
-
-
 
 
 
@@ -1066,18 +1062,16 @@ <h1 id="ncm-issuer">ncm-issuer</h1>
 <h2 id="what-is-ncm-issuer">What is ncm-issuer?</h2>
 <p>ncm-issuer is a <a href="https://kubernetes.io">Kubernetes</a> controller (external <a href="https://cert-manager.io/">cert-manager</a> issuer) that allows to integrate with
 <a href="https://www.nokia.com/networks/products/pki-authority-with-netguard-certificate-manager/">Nokia NetGuard Certificate Manager (NCM)</a>
-PKI system to sign certificate requests. The integration with NCM makes it easy to obtain non-selfsigned certificates for
+PKI system to sign certificate requests. The integration with NCM makes it easy to obtain non self-signed certificates for
 applications and to ensure that they are valid and up to date.</p>
 <h2 id="how-to-get-started">How to get started?</h2>
 <p>Simply click the documentation tab in the navigation panel. All the steps required to install the ncm-issuer are
 described there, along with a tutorial on how to issue your first certificate. If you feel that something is missing 
 in the documentation, please report it to one of the maintainers, and it will definitely be added soon!</p>
 <h2 id="maintainers">Maintainers</h2>
 <blockquote>
-<p><a href="mailto:dawid.machoczek@nokia.com"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 19c0-3.31 2.69-6 6-6 1.1 0 2.12.3 3 .81V6a2 2 0 0 0-2-2H4c-1.11 0-2 .89-2 2v12a2 2 0 0 0 2 2h9.09c-.05-.33-.09-.66-.09-1M4 8V6l8 5 8-5v2l-8 5zm16 14v-2h-4v-2h4v-2l3 3z"/></svg></span></a>
-Dawid Machoczek (<a href="https://github.com/raczu/">@raczu</a>)</p>
-<p><a href="mailto:adam.korba@nokia.com"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 19c0-3.31 2.69-6 6-6 1.1 0 2.12.3 3 .81V6a2 2 0 0 0-2-2H4c-1.11 0-2 .89-2 2v12a2 2 0 0 0 2 2h9.09c-.05-.33-.09-.66-.09-1M4 8V6l8 5 8-5v2l-8 5zm16 14v-2h-4v-2h4v-2l3 3z"/></svg></span></a>
-Adam Korba (<a href="https://github.com/BbqGamer/">@BbqGamer</a>)</p>
+<p><a href="mailto:misiektoja-github@rm-rf.ninja"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 19c0-3.31 2.69-6 6-6 1.1 0 2.12.3 3 .81V6a2 2 0 0 0-2-2H4c-1.11 0-2 .89-2 2v12a2 2 0 0 0 2 2h9.09c-.05-.33-.09-.66-.09-1M4 8V6l8 5 8-5v2l-8 5zm16 14v-2h-4v-2h4v-2l3 3z"/></svg></span></a>
+Michal Szymanski (<a href="https://github.com/misiektoja/">@misiektoja</a>)</p>
 </blockquote>
 <h2 id="license">License</h2>
 <p>This project is licensed under the terms of <strong>Apache 2.0 License</strong> and available on
@@ -1187,4 +1181,4 @@ <h2 id="license">License</h2>
 
 
   </body>
-</html>
+</html>
diff --git a/docs/release-notes/1.0.1/index.html b/docs/release-notes/1.0.1/index.html
@@ -807,27 +807,6 @@
 
 
 
-    <li class="md-nav__item">
-      <a href="../1.1.2/" class="md-nav__link">
-
-
-  <span class="md-ellipsis">
-    1.1.2
-  </span>
-
-
-      </a>
-    </li>
-
-
-
-
-
-
-
-
-
-
     <li class="md-nav__item">
       <a href="../1.1.1/" class="md-nav__link">