docs: update documentation for 1.24.1 and 1.23.5 releases (#236)

Signed-off-by: Gabriele Bartolini <[email protected]> Signed-off-by: Jaime Silvela <[email protected]> Co-authored-by: Jaime Silvela <[email protected]>
cloudnative-pg · Oct 16, 2024 · e804407 · e804407
1 parent 9bf4c08
commit e804407
Show file tree

Hide file tree

Showing 237 changed files with 1,622 additions and 4,920 deletions.
diff --git a/assets/documentation/1.23/404.html b/assets/documentation/1.23/404.html
@@ -229,10 +229,6 @@
                 <li class="toctree-l1"><a class="reference internal" href="/benchmarking/">Benchmarking</a>
                 </li>
               </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="/commercial_support/">Commercial support</a>
-                </li>
-              </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="/faq/">Frequently Asked Questions (FAQ)</a>
                 </li>

diff --git a/assets/documentation/1.23/appendixes/object_stores/index.html b/assets/documentation/1.23/appendixes/object_stores/index.html
@@ -236,10 +236,6 @@
                 <li class="toctree-l1"><a class="reference internal" href="../../benchmarking/">Benchmarking</a>
                 </li>
               </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../../commercial_support/">Commercial support</a>
-                </li>
-              </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../../faq/">Frequently Asked Questions (FAQ)</a>
                 </li>
@@ -262,7 +258,7 @@
               </ul>
               <p class="caption"><span class="caption-text">Appendixes</span></p>
               <ul class="current">
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">Appendix A - Common object stores for backups</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Appendix A - Common object stores for backups</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#aws-s3">AWS S3</a>
         <ul>

diff --git a/assets/documentation/1.23/applications/index.html b/assets/documentation/1.23/applications/index.html
@@ -169,7 +169,7 @@
                 </li>
               </ul>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="./">Connecting from an application</a>
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">Connecting from an application</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#dns-resolution">DNS resolution</a>
     </li>
@@ -244,10 +244,6 @@
                 <li class="toctree-l1"><a class="reference internal" href="../benchmarking/">Benchmarking</a>
                 </li>
               </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../commercial_support/">Commercial support</a>
-                </li>
-              </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../faq/">Frequently Asked Questions (FAQ)</a>
                 </li>

diff --git a/assets/documentation/1.23/architecture/index.html b/assets/documentation/1.23/architecture/index.html
@@ -53,7 +53,7 @@
                 </li>
               </ul>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="./">Architecture</a>
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">Architecture</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#synchronizing-the-state">Synchronizing the state</a>
     </li>
@@ -258,10 +258,6 @@
                 <li class="toctree-l1"><a class="reference internal" href="../benchmarking/">Benchmarking</a>
                 </li>
               </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../commercial_support/">Commercial support</a>
-                </li>
-              </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../faq/">Frequently Asked Questions (FAQ)</a>
                 </li>

diff --git a/assets/documentation/1.23/backup/index.html b/assets/documentation/1.23/backup/index.html
@@ -105,7 +105,7 @@
                 </li>
               </ul>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="./">Backup</a>
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">Backup</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#wal-archive">WAL archive</a>
     </li>
@@ -250,10 +250,6 @@
                 <li class="toctree-l1"><a class="reference internal" href="../benchmarking/">Benchmarking</a>
                 </li>
               </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../commercial_support/">Commercial support</a>
-                </li>
-              </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../faq/">Frequently Asked Questions (FAQ)</a>
                 </li>

diff --git a/assets/documentation/1.23/backup_barmanobjectstore/index.html b/assets/documentation/1.23/backup_barmanobjectstore/index.html
@@ -109,7 +109,7 @@
                 </li>
               </ul>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="./">Backup on object stores</a>
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">Backup on object stores</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#common-object-stores">Common object stores</a>
     </li>
@@ -248,10 +248,6 @@
                 <li class="toctree-l1"><a class="reference internal" href="../benchmarking/">Benchmarking</a>
                 </li>
               </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../commercial_support/">Commercial support</a>
-                </li>
-              </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../faq/">Frequently Asked Questions (FAQ)</a>
                 </li>

diff --git a/assets/documentation/1.23/backup_recovery/index.html b/assets/documentation/1.23/backup_recovery/index.html
@@ -236,10 +236,6 @@
                 <li class="toctree-l1"><a class="reference internal" href="../benchmarking/">Benchmarking</a>
                 </li>
               </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../commercial_support/">Commercial support</a>
-                </li>
-              </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../faq/">Frequently Asked Questions (FAQ)</a>
                 </li>

diff --git a/assets/documentation/1.23/backup_volumesnapshot/index.html b/assets/documentation/1.23/backup_volumesnapshot/index.html
@@ -117,7 +117,7 @@
                 </li>
               </ul>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="./">Backup on volume snapshots</a>
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">Backup on volume snapshots</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#about-standard-volume-snapshots">About standard Volume Snapshots</a>
     </li>
@@ -254,10 +254,6 @@
                 <li class="toctree-l1"><a class="reference internal" href="../benchmarking/">Benchmarking</a>
                 </li>
               </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../commercial_support/">Commercial support</a>
-                </li>
-              </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../faq/">Frequently Asked Questions (FAQ)</a>
                 </li>

diff --git a/assets/documentation/1.23/before_you_start/index.html b/assets/documentation/1.23/before_you_start/index.html
@@ -45,7 +45,7 @@
                 </li>
               </ul>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="./">Before You Start</a>
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">Before You Start</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#kubernetes-terminology">Kubernetes terminology</a>
     </li>
@@ -246,10 +246,6 @@
                 <li class="toctree-l1"><a class="reference internal" href="../benchmarking/">Benchmarking</a>
                 </li>
               </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../commercial_support/">Commercial support</a>
-                </li>
-              </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../faq/">Frequently Asked Questions (FAQ)</a>
                 </li>
@@ -400,7 +396,7 @@ <h2 id="postgresql-terminology">PostgreSQL terminology</h2>
 <dt>PVC group</dt>
 <dd>A PVC group in CloudNativePG's terminology is a group of related PVCs
   belonging to the same PostgreSQL instance, namely the main volume containing
-  the PGDATA (<code>storage</code>) and the volume for WALs (<code>walStorage</code>).|</dd>
+  the PGDATA (<code>storage</code>) and the volume for WALs (<code>walStorage</code>).</dd>
 </dl>
 <h2 id="cloud-terminology">Cloud terminology</h2>
 <dl>

diff --git a/assets/documentation/1.23/benchmarking/index.html b/assets/documentation/1.23/benchmarking/index.html
@@ -233,7 +233,7 @@
                 </li>
               </ul>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="./">Benchmarking</a>
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">Benchmarking</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#pgbench">pgbench</a>
     </li>
@@ -242,10 +242,6 @@
     </ul>
                 </li>
               </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../commercial_support/">Commercial support</a>
-                </li>
-              </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../faq/">Frequently Asked Questions (FAQ)</a>
                 </li>
@@ -442,7 +438,7 @@ <h3 id="fio">fio</h3>
           </div><footer>
     <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
         <a href="../networking/" class="btn btn-neutral float-left" title="Networking"><span class="icon icon-circle-arrow-left"></span> Previous</a>
-        <a href="../commercial_support/" class="btn btn-neutral float-right" title="Commercial support">Next <span class="icon icon-circle-arrow-right"></span></a>
+        <a href="../faq/" class="btn btn-neutral float-right" title="Frequently Asked Questions (FAQ)">Next <span class="icon icon-circle-arrow-right"></span></a>
     </div>
 
   <hr/>
@@ -468,7 +464,7 @@ <h3 id="fio">fio</h3>
       <span><a href="../networking/" style="color: #fcfcfc">&laquo; Previous</a></span>
 
 
-      <span><a href="../commercial_support/" style="color: #fcfcfc">Next &raquo;</a></span>
+      <span><a href="../faq/" style="color: #fcfcfc">Next &raquo;</a></span>
 
   </span>
 </div>

diff --git a/assets/documentation/1.23/bootstrap/index.html b/assets/documentation/1.23/bootstrap/index.html
@@ -69,7 +69,7 @@
                 </li>
               </ul>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="./">Bootstrap</a>
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">Bootstrap</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#the-bootstrap-section">The bootstrap section</a>
     </li>
@@ -276,10 +276,6 @@
                 <li class="toctree-l1"><a class="reference internal" href="../benchmarking/">Benchmarking</a>
                 </li>
               </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../commercial_support/">Commercial support</a>
-                </li>
-              </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../faq/">Frequently Asked Questions (FAQ)</a>
                 </li>
@@ -778,7 +774,7 @@ <h4 id="usernamepassword-authentication">Username/Password authentication</h4>
 <pre><code># A more restrictive rule for TLS and IP of origin is recommended
 host replication streaming_replica all md5
 </code></pre>
-<p>The following manifest creates a new PostgreSQL 16.4 cluster,
+<p>The following manifest creates a new PostgreSQL 17.0 cluster,
 called <code>target-db</code>, using the <code>pg_basebackup</code> bootstrap method
 to clone an external PostgreSQL cluster defined as <code>source-db</code>
 (in the <code>externalClusters</code> array). As you can see, the <code>source-db</code>
@@ -791,7 +787,7 @@ <h4 id="usernamepassword-authentication">Username/Password authentication</h4>
   name: target-db
 spec:
   instances: 3
-  imageName: ghcr.io/cloudnative-pg/postgresql:16.4
+  imageName: ghcr.io/cloudnative-pg/postgresql:17.0
 
   bootstrap:
     pg_basebackup:
@@ -810,7 +806,7 @@ <h4 id="usernamepassword-authentication">Username/Password authentication</h4>
       key: password
 </code></pre>
 <p>All the requirements must be met for the clone operation to work, including
-the same PostgreSQL version (in our case 16.4).</p>
+the same PostgreSQL version (in our case 17.0).</p>
 <h4 id="tls-certificate-authentication">TLS certificate authentication</h4>
 <p>The second authentication method supported by CloudNativePG
 with the <code>pg_basebackup</code> bootstrap is based on TLS client certificates.
@@ -822,7 +818,7 @@ <h4 id="tls-certificate-authentication">TLS certificate authentication</h4>
 <p>This example can be easily adapted to cover an instance that resides
 outside the Kubernetes cluster.</p>
 </div>
-<p>The manifest defines a new PostgreSQL 16.4 cluster called <code>cluster-clone-tls</code>,
+<p>The manifest defines a new PostgreSQL 17.0 cluster called <code>cluster-clone-tls</code>,
 which is bootstrapped using the <code>pg_basebackup</code> method from the <code>cluster-example</code>
 external cluster. The host is identified by the read/write service
 in the same cluster, while the <code>streaming_replica</code> user is authenticated
@@ -835,7 +831,7 @@ <h4 id="tls-certificate-authentication">TLS certificate authentication</h4>
   name: cluster-clone-tls
 spec:
   instances: 3
-  imageName: ghcr.io/cloudnative-pg/postgresql:16.4
+  imageName: ghcr.io/cloudnative-pg/postgresql:17.0
 
   bootstrap:
     pg_basebackup:

diff --git a/assets/documentation/1.23/certificates/index.html b/assets/documentation/1.23/certificates/index.html
@@ -161,9 +161,9 @@
                 </li>
               </ul>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="./">Certificates</a>
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">Certificates</a>
     <ul class="current">
-    <li class="toctree-l2"><a class="reference internal" href="#operator-managed-mode">Operator-managed mode</a>
+    <li class="toctree-l2"><a class="reference internal" href="#operator-managed-mode">Operator-Managed Mode</a>
         <ul>
     <li class="toctree-l3"><a class="reference internal" href="#server-certificates">Server certificates</a>
         <ul>
@@ -278,10 +278,6 @@
                 <li class="toctree-l1"><a class="reference internal" href="../benchmarking/">Benchmarking</a>
                 </li>
               </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../commercial_support/">Commercial support</a>
-                </li>
-              </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../faq/">Frequently Asked Questions (FAQ)</a>
                 </li>
@@ -357,9 +353,24 @@ <h1 id="certificates">Certificates</h1>
 </ol>
 <p>You can also choose a hybrid approach, where only part of the certificates is
 generated outside CNPG.</p>
-<h2 id="operator-managed-mode">Operator-managed mode</h2>
-<p>By default, the operator generates a single CA and uses it for both client and
-server certificates, which are then managed and renewed automatically.</p>
+<h2 id="operator-managed-mode">Operator-Managed Mode</h2>
+<p>By default, the operator automatically generates a single Certificate Authority
+(CA) to issue both client and server certificates. These certificates are
+managed continuously by the operator, with automatic renewal 7 days before
+expiration (within a 90-day validity period).</p>
+<div class="admonition info">
+<p class="admonition-title">Info</p>
+<p>You can adjust this default behavior by configuring the
+<code>CERTIFICATE_DURATION</code> and <code>EXPIRING_CHECK_THRESHOLD</code> environment variables.
+For detailed guidance, refer to the <a href="../operator_conf/">Operator Configuration</a>.</p>
+</div>
+<div class="admonition important">
+<p class="admonition-title">Important</p>
+<p>Certificate renewal does not cause any downtime for the PostgreSQL server,
+as a simple reload operation is sufficient. However, any user-managed
+certificates not controlled by CloudNativePG must be re-issued following the
+renewal process.</p>
+</div>
 <h3 id="server-certificates">Server certificates</h3>
 <h4 id="server-ca-secret">Server CA secret</h4>
 <p>The operator generates a self-signed CA and stores it in a generic secret