Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions assets/documentation/1.25/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,10 @@
<li class="toctree-l1"><a class="reference internal" href="/container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,10 @@
<li class="toctree-l1"><a class="reference internal" href="../../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions assets/documentation/1.25/applications/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,10 @@
<li class="toctree-l1"><a class="reference internal" href="../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions assets/documentation/1.25/architecture/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,10 @@
<li class="toctree-l1"><a class="reference internal" href="../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions assets/documentation/1.25/backup/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,10 @@
<li class="toctree-l1"><a class="reference internal" href="../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down
14 changes: 14 additions & 0 deletions assets/documentation/1.25/backup_barmanobjectstore/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,10 @@
<li class="toctree-l1"><a class="reference internal" href="../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down Expand Up @@ -341,6 +345,16 @@ <h1 id="backup-on-object-stores">Backup on object stores</h1>
in your system to take advantage of the improvements introduced in
Barman cloud (as well as improve the security aspects of your cluster).</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Changes in Barman Cloud 3.16+ and Bucket Creation</p>
<p>Starting with Barman Cloud 3.16, most Barman Cloud commands no longer
automatically create the target bucket, assuming it already exists. Only the
<code>barman-cloud-check-wal-archive</code> command creates the bucket now. Whenever this
is not the first operation run on an empty bucket, CloudNativePG will throw an
error. As a result, to ensure reliable, future-proof operations and avoid
potential issues, we strongly recommend that you create and configure your
object store bucket <em>before</em> creating a <code>Cluster</code> resource that references it.</p>
</div>
<p>A backup is performed from a primary or a designated primary instance in a
<code>Cluster</code> (please refer to
<a href="../replica_cluster/">replica clusters</a>
Expand Down
4 changes: 4 additions & 0 deletions assets/documentation/1.25/backup_recovery/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,10 @@
<li class="toctree-l1"><a class="reference internal" href="../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions assets/documentation/1.25/backup_volumesnapshot/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,10 @@
<li class="toctree-l1"><a class="reference internal" href="../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions assets/documentation/1.25/before_you_start/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,10 @@
<li class="toctree-l1"><a class="reference internal" href="../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions assets/documentation/1.25/benchmarking/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,10 @@
<li class="toctree-l1"><a class="reference internal" href="../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down
14 changes: 9 additions & 5 deletions assets/documentation/1.25/bootstrap/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,10 @@
<li class="toctree-l1"><a class="reference internal" href="../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down Expand Up @@ -907,7 +911,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 17.5 cluster,
<p>The following manifest creates a new PostgreSQL 18.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>
Expand All @@ -920,7 +924,7 @@ <h4 id="usernamepassword-authentication">Username/Password authentication</h4>
name: target-db
spec:
instances: 3
imageName: ghcr.io/cloudnative-pg/postgresql:17.5
imageName: ghcr.io/cloudnative-pg/postgresql:18.0-system-trixie

bootstrap:
pg_basebackup:
Expand All @@ -939,7 +943,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 17.5).</p>
the same PostgreSQL version (in our case 18.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.
Expand All @@ -951,7 +955,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 17.5 cluster called <code>cluster-clone-tls</code>,
<p>The manifest defines a new PostgreSQL 18.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
Expand All @@ -964,7 +968,7 @@ <h4 id="tls-certificate-authentication">TLS certificate authentication</h4>
name: cluster-clone-tls
spec:
instances: 3
imageName: ghcr.io/cloudnative-pg/postgresql:17.5
imageName: ghcr.io/cloudnative-pg/postgresql:18.0-system-trixie

bootstrap:
pg_basebackup:
Expand Down
4 changes: 4 additions & 0 deletions assets/documentation/1.25/certificates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,10 @@
<li class="toctree-l1"><a class="reference internal" href="../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down
28 changes: 22 additions & 6 deletions assets/documentation/1.25/cloudnative-pg.v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,10 @@
<li class="toctree-l1"><a class="reference internal" href="../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down Expand Up @@ -591,7 +595,8 @@ <h2 id="postgresql-cnpg-io-v1-Backup">Backup</h2>
</table>

<h2 id="postgresql-cnpg-io-v1-Cluster">Cluster</h2>
<p>Cluster is the Schema for the PostgreSQL API</p>
<p>Cluster defines the API schema for a highly available PostgreSQL database cluster
managed by CloudNativePG.</p>

<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
Expand Down Expand Up @@ -1950,7 +1955,8 @@ <h2 id="postgresql-cnpg-io-v1-ClusterSpec">ClusterSpec</h2>
<ul>
<li><a href="#postgresql-cnpg-io-v1-Cluster">Cluster</a></li>
</ul>
<p>ClusterSpec defines the desired state of Cluster</p>
<p>ClusterSpec defines the desired state of a PostgreSQL cluster managed by
CloudNativePG.</p>

<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
Expand Down Expand Up @@ -2159,7 +2165,7 @@ <h2 id="postgresql-cnpg-io-v1-ClusterSpec">ClusterSpec</h2>
<td>
<p>The time in seconds that controls the window of time reserved for the smart shutdown of Postgres to complete.
Make sure you reserve enough time for the operator to request a fast shutdown of Postgres
(that is: <code>stopDelay</code> - <code>smartShutdownTimeout</code>).</p>
(that is: <code>stopDelay</code> - <code>smartShutdownTimeout</code>). Default is 180 seconds.</p>
</td>
</tr>
<tr><td><code>switchoverDelay</code><br/>
Expand Down Expand Up @@ -2370,7 +2376,8 @@ <h2 id="postgresql-cnpg-io-v1-ClusterStatus">ClusterStatus</h2>
<ul>
<li><a href="#postgresql-cnpg-io-v1-Cluster">Cluster</a></li>
</ul>
<p>ClusterStatus defines the observed state of Cluster</p>
<p>ClusterStatus defines the observed state of a PostgreSQL cluster managed by
CloudNativePG.</p>

<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
Expand Down Expand Up @@ -3734,6 +3741,8 @@ <h2 id="postgresql-cnpg-io-v1-MonitoringConfiguration">MonitoringConfiguration</
</td>
<td>
<p>Enable or disable the <code>PodMonitor</code></p>
<p>Deprecated: This feature will be removed in an upcoming release. If
you need this functionality, you can create a PodMonitor manually.</p>
</td>
</tr>
<tr><td><code>tls</code><br/>
Expand All @@ -3749,13 +3758,17 @@ <h2 id="postgresql-cnpg-io-v1-MonitoringConfiguration">MonitoringConfiguration</
</td>
<td>
<p>The list of metric relabelings for the <code>PodMonitor</code>. Applied to samples before ingestion.</p>
<p>Deprecated: This feature will be removed in an upcoming release. If
you need this functionality, you can create a PodMonitor manually.</p>
</td>
</tr>
<tr><td><code>podMonitorRelabelings</code><br/>
<a href="https://pkg.go.dev/github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1#RelabelConfig"><i>[]github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1.RelabelConfig</i></a>
</td>
<td>
<p>The list of relabelings for the <code>PodMonitor</code>. Applied to samples before scraping.</p>
<p>Deprecated: This feature will be removed in an upcoming release. If
you need this functionality, you can create a PodMonitor manually.</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -4014,8 +4027,9 @@ <h2 id="postgresql-cnpg-io-v1-PluginConfiguration">PluginConfiguration</h2>
<i>bool</i>
</td>
<td>
<p>Only one plugin can be declared as WALArchiver.
Cannot be active if &quot;.spec.backup.barmanObjectStore&quot; configuration is present.</p>
<p>Marks the plugin as the WAL archiver. At most one plugin can be
designated as a WAL archiver. This cannot be enabled if the
<code>.spec.backup.barmanObjectStore</code> configuration is present.</p>
</td>
</tr>
<tr><td><code>parameters</code><br/>
Expand Down Expand Up @@ -4303,6 +4317,8 @@ <h2 id="postgresql-cnpg-io-v1-PoolerSpec">PoolerSpec</h2>
</td>
<td>
<p>The configuration of the monitoring infrastructure of this pooler.</p>
<p>Deprecated: This feature will be removed in an upcoming release. If
you need this functionality, you can create a PodMonitor manually.</p>
</td>
</tr>
<tr><td><code>serviceTemplate</code><br/>
Expand Down
4 changes: 4 additions & 0 deletions assets/documentation/1.25/cluster_conf/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,10 @@
<li class="toctree-l1"><a class="reference internal" href="../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions assets/documentation/1.25/cncf-projects/cilium/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,10 @@
<li class="toctree-l1"><a class="reference internal" href="../../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,10 @@
<li class="toctree-l1"><a class="reference internal" href="../../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../cnpg_i/">CNPG-I</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../operator_capability_levels/">Operator capability levels</a>
</li>
Expand Down Expand Up @@ -412,7 +416,7 @@ <h3 id="creating-the-external-secret">Creating the External Secret</h3>
<code>cluster-example-app-secret</code>, which refreshes the password every 24 hours. It
uses a <code>Merge</code> policy to update only the specified fields (<code>password</code>, <code>pgpass</code>,
<code>jdbc-uri</code> and <code>uri</code>) in the <code>cluster-example-app</code> secret.</p>
<pre><code class="language-yaml">apiVersion: external-secrets.io/v1beta1
<pre><code class="language-yaml">apiVersion: external-secrets.io/v1
kind: ExternalSecret
metadata:
name: cluster-example-app-secret
Expand Down Expand Up @@ -482,7 +486,7 @@ <h3 id="creating-the-secretstore">Creating the <code>SecretStore</code></h3>
namespace at <code>http://vault.vault.svc:8200</code>, and that a Kubernetes <code>Secret</code>
named <code>vault-token</code> exists in the same namespace, containing the token used to
authenticate with Vault.</p>
<pre><code class="language-yaml">apiVersion: external-secrets.io/v1beta1
<pre><code class="language-yaml">apiVersion: external-secrets.io/v1
kind: SecretStore
metadata:
name: vault-backend
Expand Down
Loading