Skip to content

Commit f44debb

Browse files
committed
chore: review
Signed-off-by: Jonathan Battiato <[email protected]>
1 parent 23a67d3 commit f44debb

File tree

1 file changed

+32
-35
lines changed

1 file changed

+32
-35
lines changed

web/docs/troubleshooting.md

Lines changed: 32 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -78,16 +78,18 @@ kubectl logs -n <namespace> <cluster-pod-name> -c plugin-barman-cloud --previous
7878
If you are using your own certificates without cert-manager, you will need
7979
to verify the entire certificate chain yourself.
8080

81+
8182
2. **Image pull errors**
8283

8384
```sh
8485
# Check pod events for image pull errors
85-
kubectl describe pod -n cnpg-system -l app.kubernetes.io/name=barman-cloud
86+
kubectl describe pod -n cnpg-system -l app=barman-cloud
8687
```
8788

8889
Verify the image exists and you have proper credentials if using a private
8990
registry.
9091

92+
9193
3. **Resource constraints**
9294

9395
```sh
@@ -127,7 +129,7 @@ When a backup fails, follow these steps in order:
127129
-o jsonpath='{.status.instanceID.podName}')
128130

129131
kubectl logs \
130-
-n <namespace> $TARGET_POD -c plugin-barman-cloud
132+
-n <namespace> $TARGET_POD -c plugin-barman-cloud \
131133
--tail=100 | grep -E "ERROR|FATAL|panic"
132134
```
133135
4. **Check cluster events**:
@@ -141,7 +143,7 @@ When a backup fails, follow these steps in order:
141143

142144
```sh
143145
kubectl get pods \
144-
-n cnpg-system -l app.kubernetes.io/name=barman-cloud
146+
-n cnpg-system -l app=barman-cloud
145147
```
146148
6. **Check operator logs**:
147149

@@ -170,9 +172,9 @@ When a backup fails, follow these steps in order:
170172
1. **"requested plugin is not available" errors**
171173

172174
```
173-
ERROR: requested plugin is not available: barman
174-
ERROR: requested plugin is not available: barman-cloud
175-
ERROR: requested plugin is not available: barman-cloud.cloudnative-pg.io
175+
requested plugin is not available: barman
176+
requested plugin is not available: barman-cloud
177+
requested plugin is not available: barman-cloud.cloudnative-pg.io
176178
```
177179

178180
**Cause:** The plugin name in the Cluster configuration doesn’t match the
@@ -267,13 +269,7 @@ tuning, refer to the [Barman documentation](https://docs.pgbarman.org/latest/).
267269
--tail=50 | grep -i wal
268270
```
269271

270-
2. **Verify the plugin is handling `archive_command`**
271-
```sh
272-
# The `archive_command` should be routing through the plugin
273-
kubectl cnpg psql -n <namespace> <cluster-name> -- -c "SHOW archive_command;"
274-
```
275-
276-
3. **Check ObjectStore configuration for WAL settings**
272+
2. **Check ObjectStore configuration for WAL settings**
277273
- Ensure ObjectStore has proper WAL retention settings
278274
- Verify credentials have permissions for WAL operations
279275

@@ -333,16 +329,26 @@ For detailed Barman restore operations and troubleshooting, refer to the
333329
```yaml
334330
apiVersion: postgresql.cnpg.io/v1
335331
kind: Cluster
332+
metadata:
333+
name: <cluster-restore-name>
336334
spec:
337-
plugins:
338-
- name: barman-cloud.cloudnative-pg.io
339-
parameters:
340-
barmanObjectStore: <objectstore-name>
335+
storage:
336+
size: 1Gi
337+
341338
bootstrap:
342339
recovery:
340+
source: origin
343341
recoveryTarget:
344342
targetTime: "2024-01-15 10:30:00"
345-
targetTimezone: "UTC"
343+
344+
externalClusters:
345+
- name: origin
346+
plugin:
347+
enabled: true
348+
name: barman-cloud.cloudnative-pg.io
349+
parameters:
350+
barmanObjectName: <object-store-name>
351+
serverName: <source-cluster-name>
346352
```
347353
348354
2. **Check sidecar logs for WAL-related errors**
@@ -383,7 +389,7 @@ For detailed PITR configuration and WAL management, see the
383389

384390
2. **Check sidecar logs for connectivity issues**
385391
```sh
386-
kubectl logs -n <namespace> <cluster-pod> -c plugin-barman-cloud | grep -E "connection|timeout|SSL|certificate"
392+
kubectl logs -n <namespace> <cluster-pod> -c plugin-barman-cloud | grep -E "connect|timeout|SSL|cert"
387393
```
388394

389395
3. **Adjust provider-specific settings (endpoint, path style, etc.)**
@@ -408,12 +414,6 @@ kubectl cnpg status <cluster-name> -n <namespace>
408414

409415
# View cluster status in detail
410416
kubectl cnpg status <cluster-name> -n <namespace> --verbose
411-
412-
# Check backup status
413-
kubectl cnpg backup list -n <namespace>
414-
415-
# View plugin capabilities
416-
kubectl cnpg plugin list -n <namespace>
417417
```
418418

419419
## Getting Help
@@ -426,6 +426,7 @@ If problems persist:
426426
- [Object Store Configuration](object_stores.md) (for provider-specific settings)
427427
- [Usage Examples](usage.md)
428428

429+
429430
2. **Gather diagnostic information**
430431

431432
```sh
@@ -435,31 +436,28 @@ If problems persist:
435436
kubectl logs -n cnpg-system deployment/barman-cloud --tail=1000 > /tmp/plugin.log
436437
```
437438

439+
438440
3. **Community support**
439441

440442
- CloudNativePG Slack: [#cloudnativepg-users](https://cloud-native.slack.com/messages/cloudnativepg-users)
441443
- GitHub Issues: [plugin-barman-cloud](https://github.com/cloudnative-pg/plugin-barman-cloud/issues)
442444

445+
443446
4. **Include when reporting**
444447

445448
- CloudNativePG version
446449
- Plugin version
447450
- Kubernetes version
448451
- Cloud provider and region
449-
- Relevant configuration (⚠️sanitize/redact sensitive information)
452+
- Relevant configuration (⚠️ sanitize/redact sensitive information)
450453
- Error messages and logs
451454
- Steps to reproduce
452455

453456
## Known Issues and Limitations
454457

455458
### Current Known Issues
456459

457-
1. **WAL overwrite protection**: Unlike the in-tree Barman archiver, the plugin
458-
doesn't prevent WAL overwrites when multiple clusters share the same name and
459-
object store path
460-
([#263](https://github.com/cloudnative-pg/plugin-barman-cloud/issues/263))
461-
462-
2. **Migration compatibility**: After migrating from in-tree backup to the
460+
1. **Migration compatibility**: After migrating from in-tree backup to the
463461
plugin, the `kubectl cnpg backup` command syntax has changed
464462
([#353](https://github.com/cloudnative-pg/plugin-barman-cloud/issues/353)):
465463

@@ -493,9 +491,6 @@ If problems persist:
493491
# List all backups and their status
494492
kubectl get backups.postgresql.cnpg.io -n <namespace>
495493

496-
# Using the kubectl-cnpg plugin (if installed)
497-
kubectl cnpg backup list -n <namespace>
498-
499494
# Get detailed backup information including error messages and target instance
500495
kubectl describe backups.postgresql.cnpg.io \
501496
-n <namespace> <backup-name>
@@ -570,6 +565,8 @@ kubectl get objectstores.barmancloud.cnpg.io \
570565

571566
# Verify the secret exists and has the correct keys
572567
kubectl get secret -n <namespace> <secret-name> -o yaml
568+
# Alternatively
569+
kubectl get secret -n <namespace> <secret-name> -o jsonpath='{.data}' | jq 'keys'
573570
```
574571

575572
### Common Error Messages and Solutions

0 commit comments

Comments
 (0)