Skip to content

Commit c0af68c

Browse files
gbartolinigbartolini
committed
docs: prepare for 1.26.0-rc1
Signed-off-by: Gabriele Bartolini <[email protected]> ba77557
1 parent cbb421d commit c0af68c

File tree

308 files changed

+64303
-406
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

308 files changed

+64303
-406
lines changed

‎docs/index.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,11 @@ <h1 class="text-xl">Documentation</h1>
132132

133133
<p class="text-sm">Documentation by version</p>
134134

135+
<p class="ml-6">
136+
<a href="/documentation/preview">v1.26.0-rc1 (preview)</a> - released on <a
137+
href="https://github.com/cloudnative-pg/cloudnative-pg/releases/tag/v1.26.0-rc1">28 Mon 2025</a>
138+
</p>
139+
135140
<p class="ml-6">
136141
<a href="/documentation/1.25">v1.25.1</a> - released on <a
137142
href="https://github.com/cloudnative-pg/cloudnative-pg/releases/tag/v1.25.1">28 Feb 2025</a>

‎docs/index.xml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,12 @@
2121
<guid>https://cloudnative-pg.io/docs/1.25/</guid>
2222
<description></description>
2323
</item>
24+
<item>
25+
<title></title>
26+
<link>https://cloudnative-pg.io/docs/preview/</link>
27+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
28+
<guid>https://cloudnative-pg.io/docs/preview/</guid>
29+
<description></description>
30+
</item>
2431
</channel>
2532
</rss>

‎docs/preview.md.disabled‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎docs/preview/index.html‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
<!DOCTYPE html>
2+
3+
4+
5+
6+
<html lang="en">
7+
8+
<head>
9+
<title>CloudNativePG - PostgreSQL Operator for Kubernetes</title>
10+
<meta charset="UTF-8" />
11+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
12+
<meta http-equiv="X-UA-Compatible" content="ie=edge" />
13+
<meta name="description" content="" />
14+
<meta name="keywords" content="" />
15+
<link rel="preload" href="/fonts/Supreme-Variable.woff2" as="font" type="font/woff2" crossorigin="anonymous" />
16+
<link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,700" rel="stylesheet" />
17+
<link href="/main.min.css" rel="stylesheet" />
18+
<link rel="favicon" href="/favicon/favicon.ico">
19+
<script async defer src="https://buttons.github.io/buttons.js"></script>
20+
21+
<meta name="twitter:card" content="summary_large_image">
22+
<meta name="twitter:image" content="https://cloudnative-pg.io/images/hero_image.png">
23+
<meta name="twitter:title" content="CloudNativePG - PostgreSQL Operator for Kubernetes">
24+
<meta name="twitter:description" content="CloudNativePG - PostgreSQL Operator for Kubernetes">
25+
26+
<meta property="og:url" content="https://cloudnative-pg.io/docs/preview/">
27+
<meta property="og:site_name" content="CloudNativePG - PostgreSQL Operator for Kubernetes">
28+
<meta property="og:title" content="CloudNativePG - PostgreSQL Operator for Kubernetes">
29+
<meta property="og:description" content="CloudNativePG - PostgreSQL Operator for Kubernetes">
30+
<meta property="og:locale" content="en_us">
31+
<meta property="og:type" content="article">
32+
<meta property="article:section" content="docs">
33+
<meta property="og:image" content="https://cloudnative-pg.io/images/hero_image.png">
34+
35+
</head>
36+
37+
<body>
38+
<div class="h-screen w-screen">
39+
40+
<main>
41+
<header>
42+
<div class="md:flex md:flex-row md:px-16 md:justify-between py-5">
43+
<div class="flex justify-between px-4 md:hidden">
44+
<div>
45+
46+
<a href="/"><img src="/logo/large_logo.svg" class="md:h-14 h-9" alt="Cloud Native Postgres Logo"></a>
47+
</div>
48+
<div class="h-6 my-auto" id="toggle-button">
49+
<svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6" fill="none" viewBox="0 0 24 24" stroke="currentColor"
50+
stroke-width="2">
51+
<path stroke-linecap="round" stroke-linejoin="round" d="M4 6h16M4 12h16M4 18h16" />
52+
</svg>
53+
</div>
54+
</div>
55+
<div class="md:block hidden">
56+
57+
<a href="/"><img src="/logo/large_logo.svg" class="h-14" alt="Cloud Native Postgres Logo"></a>
58+
</div>
59+
60+
<div class="hidden md:block">
61+
<ul class="md:flex gap-14 text-2xl medium-gray my-5">
62+
<li><a href="/blog">Blog</a></li>
63+
<li><a href="/releases">Releases</a></li>
64+
<li><a href="/docs">Documentation</a></li>
65+
<li><a href="/support">Support</a></li>
66+
<li><a href="/end_users">End Users</a></li>
67+
</ul>
68+
</div>
69+
70+
<div class="py-4 bg-gray-1 mt-5 hidden" id="navi-list">
71+
<ul class="md:flex gap-14 text-2xl md:medium-gray charcoal">
72+
<li class="text-center py-4"><a href="/blog">Blog</a></li>
73+
<li class="text-center py-4"><a href="/releases">Releases</a></li>
74+
<li class="text-center py-4"><a href="/docs">Documentation</a></li>
75+
<li class="text-center py-4"><a href="/support">Support</a></li>
76+
<li class="text-center py-4"><a href="/end_users">End Users</a></li>
77+
</ul>
78+
<div class="flex gap-3 py-4 justify-center bg-gray-1 fill-cnp-blue">
79+
<a href="https://github.com/cloudnative-pg/cloudnative-pg">
80+
<img src="/icons/Git.svg" alt="Github">
81+
</a>
82+
<a href="https://cloudnativepg.slack.com/">
83+
<img src="/icons/Slack.svg" alt="Slack">
84+
</a>
85+
<a href="https://twitter.com/CloudNativePg">
86+
<img src="/icons/Twitter.svg" alt="Twitter">
87+
</a>
88+
<a href="https://www.youtube.com/channel/UCTGH88W1BiuRRPTzJUDPJyA">
89+
<img src="/icons/YouTube.svg" alt="YouTube">
90+
</a>
91+
</div>
92+
</div>
93+
94+
95+
<div class="flex gap-5 my-4 fill-cnp-blue hidden md:flex">
96+
<a class="github-button" href="https://github.com/cloudnative-pg/cloudnative-pg"
97+
data-color-scheme="no-preference: light; light: light; dark: dark;" data-size="large" data-show-count="true"
98+
aria-label="Star cloudnative-pg/cloudnative-pg on GitHub">Star</a>
99+
<a href="https://join.slack.com/t/cloudnativepg/shared_invite/zt-32c83whjr-L4poobu8NEVGGXqF_Mu5VA">
100+
<img src="/icons/Slack.svg" alt="Slack" title="Join our Slack channel now!">
101+
</a>
102+
<a href="https://twitter.com/CloudNativePg">
103+
<img src="/icons/Twitter.svg" alt="Twitter">
104+
</a>
105+
<a href="https://www.youtube.com/channel/UCTGH88W1BiuRRPTzJUDPJyA">
106+
<img src="/icons/YouTube.svg" alt="YouTube">
107+
</a>
108+
</div>
109+
</div>
110+
</header>
111+
</main>
112+
<script>
113+
const toggleButton = document.getElementById('toggle-button')
114+
const naviList = document.getElementById('navi-list')
115+
116+
toggleButton.addEventListener('click', () => {
117+
naviList.classList.toggle('hidden');
118+
})
119+
</script>
120+
121+
122+
123+
<div class="mx-auto md:w-1/2 px-4">
124+
<h1 class="text-2xl"></h1>
125+
_default layout
126+
127+
</div>
128+
129+
130+
<footer class="text-center pb-24">
131+
<p class="text-sm charcoal md:w-1/2 mx-auto md:pt-10 px-6 pt-12">
132+
133+
Copyright &copy; CloudNativePG a Series of LF Projects, LLC.<br />
134+
For website terms of use, trademark policy and other project policies please see <a href="https://lfprojects.org/policies/">LF Projects, LLC Policies</a>.<br /><br />
135+
136+
<a href="https://www.linuxfoundation.org/trademark-usage/" class="red-1">The Linux Foundation has registered trademarks and uses trademarks</a>.<br /><br />
137+
138+
<a href="https://www.postgresql.org/about/policies/trademarks"
139+
class="red-1">Postgres, PostgreSQL and the Slonik Logo are trademarks or
140+
registered trademarks of the PostgreSQL Community Association of Canada, and
141+
used with their permission</a>.
142+
143+
</p>
144+
</footer>
145+
146+
</div>
147+
148+
<script src="https://cdn.usefathom.com/script.js" data-site="GSMQCVAJ" defer></script>
149+
150+
</body>
151+
152+
</html>

‎documentation/1.26-rc1/appendixes/object_stores/index.html‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,13 @@
336336
<h1 id="appendix-a-common-object-stores-for-backups">Appendix A - Common object stores for backups</h1>
337337
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
338338

339+
<div class="admonition warning">
340+
<p class="admonition-title">Warning</p>
341+
<p>With the deprecation of native Barman Cloud support in CloudNativePG in
342+
favor of the Barman Cloud Plugin, this page—and the backup and recovery
343+
documentation—may undergo changes before the official release of version
344+
1.26.0.</p>
345+
</div>
339346
<p>You can store the <a href="../../backup/">backup</a> files in any service that is supported
340347
by the Barman Cloud infrastructure. That is:</p>
341348
<ul>

‎documentation/1.26-rc1/backup/index.html‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,13 @@
317317
<h1 id="backup">Backup</h1>
318318
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
319319

320+
<div class="admonition warning">
321+
<p class="admonition-title">Warning</p>
322+
<p>With the deprecation of native Barman Cloud support in CloudNativePG in
323+
favor of the Barman Cloud Plugin, this page—and the backup and recovery
324+
documentation—may undergo changes before the official release of version
325+
1.26.0.</p>
326+
</div>
320327
<p>PostgreSQL natively provides first class backup and recovery capabilities based
321328
on file system level (physical) copy. These have been successfully used for
322329
more than 15 years in mission critical production databases, helping
@@ -343,7 +350,11 @@ <h1 id="backup">Backup</h1>
343350
<p>On the other hand, CloudNativePG supports two ways to store physical base backups:</p>
344351
<ul>
345352
<li>on <a href="../backup_barmanobjectstore/">object stores</a>, as tarballs - optionally
346-
compressed</li>
353+
compressed:<ul>
354+
<li>Using the Barman Cloud plugin</li>
355+
<li>Natively via <code>.spec.backup.barmanObjectStore</code> (<em>deprecated, to be removed in CloudNativePG 1.28</em>)</li>
356+
</ul>
357+
</li>
347358
<li>on <a href="../backup_volumesnapshot/">Kubernetes Volume Snapshots</a>, if supported by
348359
the underlying storage class</li>
349360
</ul>
@@ -359,12 +370,6 @@ <h1 id="backup">Backup</h1>
359370
the supported <a href="https://kubernetes-csi.github.io/docs/drivers.html">Container Storage Interface (CSI) drivers</a>
360371
that provide snapshotting capabilities.</p>
361372
</div>
362-
<div class="admonition info">
363-
<p class="admonition-title">Info</p>
364-
<p>Starting with version 1.25, CloudNativePG includes experimental support for
365-
backup and recovery using plugins, such as the
366-
<a href="https://github.com/cloudnative-pg/plugin-barman-cloud">Barman Cloud plugin</a>.</p>
367-
</div>
368373
<h2 id="wal-archive">WAL archive</h2>
369374
<p>The WAL archive in PostgreSQL is at the heart of <strong>continuous backup</strong>, and it
370375
is fundamental for the following reasons:</p>

‎documentation/1.26-rc1/backup_barmanobjectstore/index.html‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,13 @@
315315
<h1 id="backup-on-object-stores">Backup on object stores</h1>
316316
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
317317

318+
<div class="admonition warning">
319+
<p class="admonition-title">Warning</p>
320+
<p>With the deprecation of native Barman Cloud support in CloudNativePG in
321+
favor of the Barman Cloud Plugin, this page—and the backup and recovery
322+
documentation—may undergo changes before the official release of version
323+
1.26.0.</p>
324+
</div>
318325
<p>CloudNativePG natively supports <strong>online/hot backup</strong> of PostgreSQL
319326
clusters through continuous physical backup and WAL archiving on an object
320327
store. This means that the database is always up (no downtime required)

‎documentation/1.26-rc1/backup_volumesnapshot/index.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,8 @@ <h2 id="requirements">Requirements</h2>
381381
at the storage level for each specific CSI driver.</p>
382382
</div>
383383
<h2 id="how-to-configure-volume-snapshot-backups">How to configure Volume Snapshot backups</h2>
384+
<!-- TODO: Change before 1.26.0 -->
385+
384386
<p>CloudNativePG allows you to configure a given Postgres cluster for Volume
385387
Snapshot backups through the <code>backup.volumeSnapshot</code> stanza.</p>
386388
<div class="admonition info">
@@ -617,6 +619,8 @@ <h3 id="examples">Examples</h3>
617619
# other backup configuration...
618620
</code></pre>
619621
<h2 id="example-of-volume-snapshot-backup">Example of Volume Snapshot Backup</h2>
622+
<!-- TODO: Change before 1.26.0 -->
623+
620624
<p>The following example shows how to configure volume snapshot base backups on an
621625
EKS cluster on AWS using the <code>ebs-sc</code> storage class and the <code>csi-aws-vsc</code>
622626
volume snapshot class.</p>

‎documentation/1.26-rc1/container_images/index.html‎

Lines changed: 21 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -307,48 +307,42 @@
307307
<h1 id="container-image-requirements">Container Image Requirements</h1>
308308
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
309309

310-
<p>The CloudNativePG operator for Kubernetes is designed to
311-
work with any compatible container image of PostgreSQL that complies
312-
with the following requirements:</p>
310+
<p>The CloudNativePG operator for Kubernetes is designed to work with any
311+
compatible PostgreSQL container image that meets the following requirements:</p>
313312
<ul>
314-
<li>PostgreSQL executables that must be in the path:<ul>
313+
<li>PostgreSQL executables must be available in the system path:</li>
315314
<li><code>initdb</code></li>
316315
<li><code>postgres</code></li>
317316
<li><code>pg_ctl</code></li>
318317
<li><code>pg_controldata</code></li>
319318
<li><code>pg_basebackup</code></li>
319+
<li>Proper locale settings configured</li>
320320
</ul>
321-
</li>
322-
<li>Barman Cloud executables that must be in the path:<ul>
323-
<li><code>barman-cloud-backup</code></li>
324-
<li><code>barman-cloud-backup-delete</code></li>
325-
<li><code>barman-cloud-backup-list</code></li>
326-
<li><code>barman-cloud-check-wal-archive</code></li>
327-
<li><code>barman-cloud-restore</code></li>
328-
<li><code>barman-cloud-wal-archive</code></li>
329-
<li><code>barman-cloud-wal-restore</code></li>
330-
</ul>
331-
</li>
332-
<li>PGAudit extension installed (optional - only if PGAudit is required
333-
in the deployed clusters)</li>
334-
<li>Appropriate locale settings</li>
335-
<li><code>du</code> (optional, for <code>kubectl cnpg status</code>)</li>
321+
<p>Optional Components:</p>
322+
<ul>
323+
<li><a href="https://www.pgaudit.org/">PGAudit</a> extension (only required if audit logging
324+
is needed)</li>
325+
<li><code>du</code> (used for <code>kubectl cnpg status</code>)</li>
336326
</ul>
337327
<div class="admonition important">
338328
<p class="admonition-title">Important</p>
339-
<p>Only <a href="https://postgresql.org/">PostgreSQL versions supported by the PGDG</a> are allowed.</p>
329+
<p>Only <a href="https://postgresql.org/">PostgreSQL versions officially supported by PGDG</a> are allowed.</p>
330+
</div>
331+
<div class="admonition info">
332+
<p class="admonition-title">Info</p>
333+
<p>Barman Cloud executables are no longer required in CloudNativePG. The
334+
recommended approach is to use the dedicated <a href="https://github.com/cloudnative-pg/plugin-barman-cloud">Barman Cloud Plugin</a>.</p>
340335
</div>
341-
<p>No entry point and/or command is required in the image definition, as
342-
CloudNativePG overrides it with its instance manager.</p>
336+
<p>No entry point or command is required in the image definition. CloudNativePG
337+
automatically overrides it with its instance manager.</p>
343338
<div class="admonition warning">
344339
<p class="admonition-title">Warning</p>
345-
<p>Application Container Images will be used by CloudNativePG
346-
in a <strong>Primary with multiple/optional Hot Standby Servers Architecture</strong>
347-
only.</p>
340+
<p>CloudNativePG only supports <strong>Primary with multiple/optional Hot Standby
341+
Servers architecture</strong> for PostgreSQL application container images.</p>
348342
</div>
349-
<p>The CloudNativePG community provides and supports
343+
<p>The CloudNativePG community provides and maintains
350344
<a href="https://github.com/cloudnative-pg/postgres-containers">public PostgreSQL container images</a>
351-
that work with CloudNativePG, and publishes them on
345+
that are fully compatible with CloudNativePG. These images are published on
352346
<a href="https://ghcr.io/cloudnative-pg/postgresql">ghcr.io</a>.</p>
353347
<h2 id="image-tag-requirements">Image Tag Requirements</h2>
354348
<p>To ensure the operator makes informed decisions, it must accurately detect the

‎documentation/1.26-rc1/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -535,5 +535,5 @@ <h2 id="about-this-guide">About this guide</h2>
535535

536536
<!--
537537
MkDocs version : 1.6.1
538-
Build Date UTC : 2025-03-28 11:09:28.105611+00:00
538+
Build Date UTC : 2025-03-28 15:12:41.532239+00:00
539539
-->

0 commit comments

Comments
 (0)