Skip to content

Commit 2b53ac3

Browse files
jmealogbartolinijbattiato
authored
docs: add troubleshooting section (#509)
Signed-off-by: Jeff Mealo <[email protected]> Signed-off-by: Gabriele Bartolini <[email protected]> Signed-off-by: Jonathan Battiato <[email protected]> Co-authored-by: Gabriele Bartolini <[email protected]> Co-authored-by: Jonathan Battiato <[email protected]>
1 parent f896442 commit 2b53ac3

File tree

4 files changed

+653
-8
lines changed

4 files changed

+653
-8
lines changed

.wordlist.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
AccessDenied
12
AdditionalContainerArgs
23
Akamai
34
Azurite
@@ -21,9 +22,12 @@ IRSA
2122
IfNotPresent
2223
InstanceSidecarConfiguration
2324
JSON
25+
Kustomize
2426
Lifecycle
2527
Linode
2628
MinIO
29+
Misconfiguration
30+
NoSuchBucket
2731
ObjectMeta
2832
ObjectStore
2933
ObjectStoreSpec
@@ -42,6 +46,7 @@ SAS
4246
SFO
4347
SPDX
4448
SPDX
49+
SSL
4550
ServerRecoveryWindow
4651
Slonik
4752
TLS
@@ -54,18 +59,21 @@ amz
5459
api
5560
apiVersion
5661
apiextensions
62+
archiver
5763
args
5864
auth
5965
autocert
6066
aws
6167
backend
6268
backends
6369
barmanObjectName
70+
barmanObjectStore
6471
barmancloud
6572
boto
6673
bzip
6774
cd
6875
cloudnative
76+
cloudnativepg
6977
clusterrole
7078
clusterrolebinding
7179
cmctl
@@ -76,7 +84,9 @@ cpu
7684
creds
7785
csi
7886
customresourcedefinition
87+
declaratively
7988
deps
89+
desc
8090
devel
8191
env
8292
externalClusters
@@ -88,11 +98,19 @@ hostpath
8898
http
8999
https
90100
imagePullPolicy
101+
instanceID
102+
instanceName
103+
instanceRole
104+
involvedObject
91105
io
92106
isWALArchiver
107+
jq
108+
jsonpath
93109
kb
110+
krew
94111
kubectl
95112
kubernetes
113+
lastTimestamp
96114
lifecycle
97115
localhost
98116
md
@@ -102,6 +120,8 @@ namespaces
102120
objectstore
103121
objectstores
104122
pluginConfiguration
123+
podName
124+
postgres
105125
postgresql
106126
primaryUpdateStrategy
107127
rbac
@@ -112,6 +132,7 @@ retentionCheckInterval
112132
retentionPolicy
113133
rolebinding
114134
rollout
135+
rpc
115136
sc
116137
secretKeyRef
117138
selfsigned

web/docs/intro.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,30 @@ for detailed instructions.
2121

2222
## Requirements
2323

24-
To use the Barman Cloud Plugin, you need:
24+
Before using the Barman Cloud Plugin, ensure that the following components are
25+
installed and properly configured:
2526

26-
- [CloudNativePG](https://cloudnative-pg.io) version **1.26** <!-- ADD WHEN 1.27 IS OUT "or later" -->
27-
- [cert-manager](https://cert-manager.io/) to enable TLS communication between
28-
the plugin and the operator
27+
- [CloudNativePG](https://cloudnative-pg.io) version 1.26 or later
28+
29+
- We strongly recommend version 1.27.0 or later, which includes improved
30+
error handling and status reporting for the plugin.
31+
- If you are running an earlier release, refer to the
32+
[upgrade guide](https://cloudnative-pg.io/documentation/current/installation_upgrade).
33+
34+
- [cert-manager](https://cert-manager.io/)
35+
36+
- The recommended way to enable secure TLS communication between the plugin
37+
and the operator.
38+
- Alternatively, you can provide your own certificate bundles. See the
39+
[CloudNativePG documentation on TLS configuration](https://cloudnative-pg.io/documentation/current/cnpg_i/#configuring-tls-certificates).
40+
41+
- [`kubectl-cnpg`](https://cloudnative-pg.io/documentation/current/kubectl-plugin/)
42+
plugin (optional but recommended)
43+
44+
- Simplifies debugging and monitoring with additional status and inspection
45+
commands.
46+
- Multiple installation options are available in the
47+
[installation guide](https://cloudnative-pg.io/documentation/current/kubectl-plugin/#install).
2948

3049
## Key Features
3150

0 commit comments

Comments
 (0)