Skip to content

Commit 02ca263

Browse files
gbartolinimnencia
authored andcommitted
docs: first part of troubleshooting review
Signed-off-by: Gabriele Bartolini <[email protected]>
1 parent b8a5638 commit 02ca263

File tree

1 file changed

+41
-31
lines changed

1 file changed

+41
-31
lines changed

web/docs/troubleshooting.md

Lines changed: 41 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,37 @@
11
---
2-
sidebar_position: 50
2+
sidebar_position: 90
33
---
44

55
# Troubleshooting
66

77
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
88

9-
This guide helps you diagnose and resolve common issues with the Barman Cloud Plugin.
10-
11-
## Before You Begin
12-
13-
### Recommended Upgrades
9+
This guide helps you diagnose and resolve common issues with the Barman Cloud
10+
plugin.
1411

1512
:::important
16-
**CloudNativePG 1.27.0** offers significantly improved error and status reporting for plugins. If you're experiencing issues, we strongly recommend upgrading to version 1.27.0 or later for better diagnostics.
17-
18-
- **Upgrade CloudNativePG**: Follow the [official upgrade guide](https://cloudnative-pg.io/documentation/current/installation_upgrade)
19-
- **Update kubectl-cnpg plugin**: Install or update the kubectl plugin for better debugging capabilities. See the [kubectl plugin documentation](https://cloudnative-pg.io/documentation/current/kubectl-plugin/)
13+
We are continuously improving the integration between CloudNativePG and the
14+
Barman Cloud plugin as it moves toward greater stability and maturity. For this
15+
reason, we recommend using the latest available version of both components.
16+
See the [*Requirements* section](intro.md#requirements) for details.
2017
:::
2118

22-
### Viewing Logs
19+
## Viewing Logs
2320

24-
To effectively troubleshoot issues, you need to check logs from multiple sources:
21+
To troubleshoot effectively, you’ll often need to review logs from multiple
22+
sources:
2523

2624
:::note
27-
The following commands assume you've installed the CloudNativePG operator in the default `cnpg-system` namespace. If you've installed it in a different namespace, adjust the commands accordingly.
25+
The following commands assume you installed the CloudNativePG operator in
26+
the default `cnpg-system` namespace. If you installed it in a different
27+
namespace, adjust the commands accordingly.
2828
:::
2929

30-
```bash
31-
# View operator logs (contains plugin interaction logs)
32-
# Assumes operator is installed in the default cnpg-system namespace
30+
```sh
31+
# View operator logs (includes plugin interaction logs)
3332
kubectl logs -n cnpg-system deployment/cnpg-controller-manager -f
3433

35-
# View sidecar container logs (barman-cloud operations)
34+
# View sidecar container logs (Barman Cloud operations)
3635
kubectl logs -n <namespace> <cluster-pod-name> -c plugin-barman-cloud -f
3736

3837
# View plugin manager logs
@@ -52,41 +51,52 @@ kubectl logs -n <namespace> <cluster-pod-name> -c plugin-barman-cloud --previous
5251
#### Plugin pods not starting
5352

5453
**Symptoms:**
55-
- Plugin pods are in `CrashLoopBackOff` or `Error` state
56-
- Plugin deployment is not ready
54+
55+
- Plugin pods stuck in `CrashLoopBackOff` or `Error`
56+
- Plugin deployment not ready
5757

5858
**Possible causes and solutions:**
5959

6060
1. **Certificate issues**
61-
```bash
61+
62+
```sh
6263
# Check if cert-manager is installed and running
6364
kubectl get pods -n cert-manager
64-
65+
6566
# Check if the plugin certificate is created
6667
kubectl get certificates -n cnpg-system
6768
```
68-
69+
6970
If cert-manager is not installed, install it first:
70-
```bash
71-
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/latest/download/cert-manager.yaml
71+
72+
```sh
73+
# Note: other installation methods for cert-manager are available
74+
kubectl apply -f \
75+
https://github.com/cert-manager/cert-manager/releases/latest/download/cert-manager.yaml
7276
```
7377

78+
If you are using your own certificates without cert-manager, you will need
79+
to verify the entire certificate chain yourself.
80+
7481
2. **Image pull errors**
75-
```bash
82+
83+
```sh
7684
# Check pod events for image pull errors
7785
kubectl describe pod -n cnpg-system -l app.kubernetes.io/name=barman-cloud
7886
```
79-
80-
Verify the image exists and you have proper credentials if using a private registry.
87+
88+
Verify the image exists and you have proper credentials if using a private
89+
registry.
8190

8291
3. **Resource constraints**
83-
```bash
92+
93+
```sh
8494
# Check node resources
8595
kubectl top nodes
8696
kubectl describe nodes
8797
```
88-
89-
Ensure your cluster has sufficient CPU and memory resources.
98+
99+
Make sure your cluster has sufficient CPU and memory resources.
90100

91101
### Backup Failures
92102

@@ -488,4 +498,4 @@ If you continue to experience issues:
488498

489499
:::tip
490500
Always check the [Release Notes](https://github.com/cloudnative-pg/plugin-barman-cloud/releases) for version-specific known issues and fixes.
491-
:::
501+
:::

0 commit comments

Comments
 (0)