From de3225d6495dec6af27750d4dea0574b4d19a0e6 Mon Sep 17 00:00:00 2001
From: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
Date: Wed, 5 Mar 2025 11:00:40 +0100
Subject: [PATCH] docs: add isWALArchiver to documentation and examples (#185)

Version 1.25.1 of CNPG introduces a new configuration flag called `isWALArchiver`. This flag allows users to designate the plugin as a Write-Ahead Log (WAL) archiver. This update includes the addition of the flag in the examples and documentation.

See also https://github.com/cloudnative-pg/cloudnative-pg/pull/6593

Closes #184

Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
---
 .wordlist.txt                              | 3 ++-
 README.md                                  | 3 +++
 docs/examples/cluster-example.yaml         | 1 +
 docs/examples/cluster-restore-archive.yaml | 1 +
 4 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/.wordlist.txt b/.wordlist.txt
index 5ae0fae..e9676af 100644
--- a/.wordlist.txt
+++ b/.wordlist.txt
@@ -6,8 +6,8 @@ Gi
 IfNotPresent
 MinIO
 PITR
-TODO
 TLS
+TODO
 WAL
 WALs
 api
@@ -34,6 +34,7 @@ hostpath
 https
 imagePullPolicy
 io
+isWALArchiver
 kubectl
 kubernetes
 minio
diff --git a/README.md b/README.md
index 61d9c3d..ed57700 100644
--- a/README.md
+++ b/README.md
@@ -199,6 +199,7 @@ spec:
   imagePullPolicy: Always
   plugins:
   - name: barman-cloud.cloudnative-pg.io
+    isWALArchiver: true
     parameters:
       barmanObjectName: minio-store
   storage:
@@ -272,6 +273,7 @@ spec:
       source: source
   plugins:
   - name: barman-cloud.cloudnative-pg.io
+    isWALArchiver: true
     parameters:
       # Backup Object Store (push, read-write)
       barmanObjectName: minio-store-bis
@@ -311,6 +313,7 @@ spec:
 
   plugins:
   - name: barman-cloud.cloudnative-pg.io
+    isWALArchiver: true
     parameters:
       barmanObjectName: minio-store-a
 
diff --git a/docs/examples/cluster-example.yaml b/docs/examples/cluster-example.yaml
index b367f91..1d240b3 100644
--- a/docs/examples/cluster-example.yaml
+++ b/docs/examples/cluster-example.yaml
@@ -7,6 +7,7 @@ spec:
   imagePullPolicy: Always
   plugins:
   - name: barman-cloud.cloudnative-pg.io
+    isWALArchiver: true
     parameters:
       barmanObjectName: minio-store
 
diff --git a/docs/examples/cluster-restore-archive.yaml b/docs/examples/cluster-restore-archive.yaml
index 5c133de..0505eed 100644
--- a/docs/examples/cluster-restore-archive.yaml
+++ b/docs/examples/cluster-restore-archive.yaml
@@ -12,6 +12,7 @@ spec:
 
   plugins:
   - name: barman-cloud.cloudnative-pg.io
+    isWALArchiver: true
     parameters:
       barmanObjectName: minio-store-bis