@@ -16,27 +16,27 @@ reason, we recommend using the latest available version of both components.
1616See the [ * Requirements* section] ( intro.md#requirements ) for details.
1717:::
1818
19- ## Viewing Logs
20-
21- To troubleshoot effectively, you’ll often need to review logs from multiple
22- sources:
23-
2419::: note
2520The following commands assume you installed the CloudNativePG operator in
2621the default ` cnpg-system ` namespace. If you installed it in a different
2722namespace, adjust the commands accordingly.
2823:::
2924
25+ ## Viewing Logs
26+
27+ To troubleshoot effectively, you’ll often need to review logs from multiple
28+ sources:
29+
3030``` sh
3131# View operator logs (includes plugin interaction logs)
3232kubectl logs -n cnpg-system deployment/cnpg-controller-manager -f
3333
34- # View sidecar container logs (Barman Cloud operations)
35- kubectl logs -n < namespace> < cluster-pod-name> -c plugin-barman-cloud -f
36-
3734# View plugin manager logs
3835kubectl logs -n cnpg-system deployment/barman-cloud -f
3936
37+ # View sidecar container logs (Barman Cloud operations)
38+ kubectl logs -n < namespace> < cluster-pod-name> -c plugin-barman-cloud -f
39+
4040# View all containers in a pod
4141kubectl logs -n < namespace> < cluster-pod-name> --all-containers=true
4242
@@ -185,7 +185,7 @@ When a backup fails, follow these steps in order:
185185 a. ** Check plugin registration:**
186186
187187 ``` sh
188- # If you have kubectl- cnpg plugin installed (v1.27.0+)
188+ # If you have the ` cnpg` plugin installed (v1.27.0+)
189189 kubectl cnpg status -n < namespace> < cluster-name>
190190 ```
191191
@@ -217,12 +217,12 @@ When a backup fails, follow these steps in order:
217217
2182182 . ** "rpc error: code = Unknown desc = panic caught: assignment to entry in nil map" errors**
219219
220- ** Cause:** Misconfiguration in the ObjectStore (e.g., typo or missing field).
220+ ** Cause:** Misconfiguration in the ` ObjectStore ` (e.g., typo or missing field).
221221
222222 ** Solution:**
223223
224224 - Review sidecar logs for details
225- - Verify ObjectStore configuration and secrets
225+ - Verify ` ObjectStore ` configuration and secrets
226226 - Common issues include:
227227 - Missing or incorrect secret references
228228 - Typos in configuration parameters
@@ -237,8 +237,8 @@ When a backup fails, follow these steps in order:
237237
238238** Plugin-specific considerations:**
239239
240- 1 . ** Check ObjectStore parallelism settings**
241- - Adjust ` maxParallel ` in ObjectStore configuration
240+ 1 . ** Check ` ObjectStore ` parallelism settings**
241+ - Adjust ` maxParallel ` in ` ObjectStore ` configuration
242242 - Monitor sidecar container resource usage during backups
243243
2442442 . ** Verify plugin resource allocation**
@@ -300,7 +300,7 @@ tuning, refer to the [Barman documentation](https://docs.pgbarman.org/latest/).
3003002 . ** Verify plugin can access backups**
301301
302302 ``` sh
303- # Check if ObjectStore is properly configured for restore
303+ # Check if ` ObjectStore` is properly configured for restore
304304 kubectl get objectstores.barmancloud.cnpg.io \
305305 -n < namespace> < objectstore-name> -o yaml
306306
@@ -371,7 +371,7 @@ For detailed PITR configuration and WAL management, see the
371371
372372- Sidecar logs show connection errors
373373- Backups fail with authentication or network errors
374- - ObjectStore resource reports errors
374+ - ` ObjectStore ` resource reports errors
375375
376376** Solution:**
377377
@@ -389,7 +389,8 @@ For detailed PITR configuration and WAL management, see the
389389
3903902 . ** Check sidecar logs for connectivity issues**
391391 ``` sh
392- kubectl logs -n < namespace> < cluster-pod> -c plugin-barman-cloud | grep -E " connect|timeout|SSL|cert"
392+ kubectl logs -n < namespace> < cluster-pod> \
393+ -c plugin-barman-cloud | grep -E " connect|timeout|SSL|cert"
393394 ```
394395
3953963 . ** Adjust provider-specific settings (endpoint, path style, etc.)**
@@ -537,7 +538,8 @@ kubectl get pods -n <namespace> -l cnpg.io/cluster=<cluster-name> \
537538# Check sidecar logs on ALL cluster pods (if the target is unclear)
538539for pod in $( kubectl get pods -n < namespace> -l cnpg.io/cluster=< cluster-name> -o name) ; do
539540 echo " === Checking $pod ==="
540- kubectl logs -n < namespace> $pod -c plugin-barman-cloud --tail=20 | grep -i error || echo " No errors found"
541+ kubectl logs -n < namespace> $pod -c plugin-barman-cloud \
542+ --tail=20 | grep -i error || echo " No errors found"
541543done
542544```
543545
@@ -556,7 +558,7 @@ kubectl get events -n <namespace> \
556558kubectl get events -n < namespace> --sort-by=' .lastTimestamp' | tail -20
557559```
558560
559- ### Verify ObjectStore Configuration
561+ ### Verify ` ObjectStore ` Configuration
560562
561563``` sh
562564# Check the ObjectStore resource
0 commit comments