Skip to content

Commit

Permalink
docs: update documentation for 1.22 and 1.21 (#211)
Browse files Browse the repository at this point in the history
Closes #208

Signed-off-by: Gabriele Bartolini <[email protected]>
  • Loading branch information
gbartolini authored Jul 29, 2024
1 parent c16d4e1 commit 646531f
Show file tree
Hide file tree
Showing 145 changed files with 1,323 additions and 821 deletions.
6 changes: 3 additions & 3 deletions assets/documentation/1.21/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="The CloudNativePG Contributors" />
<link rel="shortcut icon" href="/img/favicon.ico" />
<title>CloudNativePG</title>
<title>CloudNativePG v1.21</title>
<link rel="stylesheet" href="/css/theme.css" />
<link rel="stylesheet" href="/css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
Expand All @@ -24,7 +24,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="/." class="icon icon-home"> CloudNativePG
<a href="/." class="icon icon-home"> CloudNativePG v1.21
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="//search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
Expand Down Expand Up @@ -257,7 +257,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="/.">CloudNativePG</a>
<a href="/.">CloudNativePG v1.21</a>

</nav>
<div class="wy-nav-content">
Expand Down
8 changes: 4 additions & 4 deletions assets/documentation/1.21/appendixes/object_stores/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="The CloudNativePG Contributors" />
<link rel="shortcut icon" href="../../img/favicon.ico" />
<title>Appendix A - Common object stores for backups - CloudNativePG</title>
<title>Appendix A - Common object stores for backups - CloudNativePG v1.21</title>
<link rel="stylesheet" href="../../css/theme.css" />
<link rel="stylesheet" href="../../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
Expand All @@ -31,7 +31,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../.." class="icon icon-home"> CloudNativePG
<a href="../.." class="icon icon-home"> CloudNativePG v1.21
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
Expand Down Expand Up @@ -294,7 +294,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../..">CloudNativePG</a>
<a href="../..">CloudNativePG v1.21</a>

</nav>
<div class="wy-nav-content">
Expand Down Expand Up @@ -445,7 +445,7 @@ <h3 id="other-s3-compatible-object-storages-providers">Other S3-compatible Objec
</div>
<h2 id="azure-blob-storage">Azure Blob Storage</h2>
<p><a href="https://azure.microsoft.com/en-us/services/storage/blobs/">Azure Blob Storage</a> is the
obect storage service provided by Microsoft.</p>
object storage service provided by Microsoft.</p>
<p>In order to access your storage account for backup and recovery of
CloudNativePG managed databases, you will need one of the following
combinations of credentials:</p>
Expand Down
6 changes: 3 additions & 3 deletions assets/documentation/1.21/applications/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="The CloudNativePG Contributors" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Connecting from an application - CloudNativePG</title>
<title>Connecting from an application - CloudNativePG v1.21</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
Expand All @@ -31,7 +31,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> CloudNativePG
<a href=".." class="icon icon-home"> CloudNativePG v1.21
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
Expand Down Expand Up @@ -272,7 +272,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">CloudNativePG</a>
<a href="..">CloudNativePG v1.21</a>

</nav>
<div class="wy-nav-content">
Expand Down
6 changes: 3 additions & 3 deletions assets/documentation/1.21/architecture/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="The CloudNativePG Contributors" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Architecture - CloudNativePG</title>
<title>Architecture - CloudNativePG v1.21</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
Expand All @@ -31,7 +31,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> CloudNativePG
<a href=".." class="icon icon-home"> CloudNativePG v1.21
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
Expand Down Expand Up @@ -286,7 +286,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">CloudNativePG</a>
<a href="..">CloudNativePG v1.21</a>

</nav>
<div class="wy-nav-content">
Expand Down
6 changes: 3 additions & 3 deletions assets/documentation/1.21/backup/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="The CloudNativePG Contributors" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Backup - CloudNativePG</title>
<title>Backup - CloudNativePG v1.21</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
Expand All @@ -31,7 +31,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> CloudNativePG
<a href=".." class="icon icon-home"> CloudNativePG v1.21
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
Expand Down Expand Up @@ -278,7 +278,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">CloudNativePG</a>
<a href="..">CloudNativePG v1.21</a>

</nav>
<div class="wy-nav-content">
Expand Down
6 changes: 3 additions & 3 deletions assets/documentation/1.21/backup_barmanobjectstore/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="The CloudNativePG Contributors" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Backup on object stores - CloudNativePG</title>
<title>Backup on object stores - CloudNativePG v1.21</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
Expand All @@ -31,7 +31,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> CloudNativePG
<a href=".." class="icon icon-home"> CloudNativePG v1.21
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
Expand Down Expand Up @@ -276,7 +276,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">CloudNativePG</a>
<a href="..">CloudNativePG v1.21</a>

</nav>
<div class="wy-nav-content">
Expand Down
6 changes: 3 additions & 3 deletions assets/documentation/1.21/backup_recovery/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="The CloudNativePG Contributors" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Backup and Recovery - CloudNativePG</title>
<title>Backup and Recovery - CloudNativePG v1.21</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
Expand All @@ -31,7 +31,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> CloudNativePG
<a href=".." class="icon icon-home"> CloudNativePG v1.21
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
Expand Down Expand Up @@ -264,7 +264,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">CloudNativePG</a>
<a href="..">CloudNativePG v1.21</a>

</nav>
<div class="wy-nav-content">
Expand Down
6 changes: 3 additions & 3 deletions assets/documentation/1.21/backup_volumesnapshot/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="The CloudNativePG Contributors" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Backup on volume snapshots - CloudNativePG</title>
<title>Backup on volume snapshots - CloudNativePG v1.21</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
Expand All @@ -31,7 +31,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> CloudNativePG
<a href=".." class="icon icon-home"> CloudNativePG v1.21
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
Expand Down Expand Up @@ -282,7 +282,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">CloudNativePG</a>
<a href="..">CloudNativePG v1.21</a>

</nav>
<div class="wy-nav-content">
Expand Down
6 changes: 3 additions & 3 deletions assets/documentation/1.21/before_you_start/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="The CloudNativePG Contributors" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Before You Start - CloudNativePG</title>
<title>Before You Start - CloudNativePG v1.21</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
Expand All @@ -31,7 +31,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> CloudNativePG
<a href=".." class="icon icon-home"> CloudNativePG v1.21
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
Expand Down Expand Up @@ -274,7 +274,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">CloudNativePG</a>
<a href="..">CloudNativePG v1.21</a>

</nav>
<div class="wy-nav-content">
Expand Down
6 changes: 3 additions & 3 deletions assets/documentation/1.21/benchmarking/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="The CloudNativePG Contributors" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Benchmarking - CloudNativePG</title>
<title>Benchmarking - CloudNativePG v1.21</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
Expand All @@ -31,7 +31,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> CloudNativePG
<a href=".." class="icon icon-home"> CloudNativePG v1.21
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
Expand Down Expand Up @@ -270,7 +270,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">CloudNativePG</a>
<a href="..">CloudNativePG v1.21</a>

</nav>
<div class="wy-nav-content">
Expand Down
16 changes: 8 additions & 8 deletions assets/documentation/1.21/bootstrap/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="The CloudNativePG Contributors" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Bootstrap - CloudNativePG</title>
<title>Bootstrap - CloudNativePG v1.21</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
Expand All @@ -31,7 +31,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> CloudNativePG
<a href=".." class="icon icon-home"> CloudNativePG v1.21
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
Expand Down Expand Up @@ -304,7 +304,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">CloudNativePG</a>
<a href="..">CloudNativePG v1.21</a>

</nav>
<div class="wy-nav-content">
Expand Down Expand Up @@ -770,7 +770,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.1 cluster,
<p>The following manifest creates a new PostgreSQL 16.3 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>
Expand All @@ -783,7 +783,7 @@ <h4 id="usernamepassword-authentication">Username/Password authentication</h4>
name: target-db
spec:
instances: 3
imageName: ghcr.io/cloudnative-pg/postgresql:16.1
imageName: ghcr.io/cloudnative-pg/postgresql:16.3

bootstrap:
pg_basebackup:
Expand All @@ -802,7 +802,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.1).</p>
the same PostgreSQL version (in our case 16.3).</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.
Expand All @@ -814,7 +814,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.1 cluster called <code>cluster-clone-tls</code>,
<p>The manifest defines a new PostgreSQL 16.3 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
Expand All @@ -827,7 +827,7 @@ <h4 id="tls-certificate-authentication">TLS certificate authentication</h4>
name: cluster-clone-tls
spec:
instances: 3
imageName: ghcr.io/cloudnative-pg/postgresql:16.1
imageName: ghcr.io/cloudnative-pg/postgresql:16.3

bootstrap:
pg_basebackup:
Expand Down
Loading

0 comments on commit 646531f

Please sign in to comment.