mirror of
https://github.com/cloudnative-pg/plugin-barman-cloud.git
synced 2026-01-12 05:33:11 +01:00
docs: review
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
This commit is contained in:
parent
ef4e41d592
commit
e771d0d274
@ -16,27 +16,27 @@ reason, we recommend using the latest available version of both components.
|
|||||||
See the [*Requirements* section](intro.md#requirements) for details.
|
See the [*Requirements* section](intro.md#requirements) for details.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Viewing Logs
|
|
||||||
|
|
||||||
To troubleshoot effectively, you’ll often need to review logs from multiple
|
|
||||||
sources:
|
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
The following commands assume you installed the CloudNativePG operator in
|
The following commands assume you installed the CloudNativePG operator in
|
||||||
the default `cnpg-system` namespace. If you installed it in a different
|
the default `cnpg-system` namespace. If you installed it in a different
|
||||||
namespace, adjust the commands accordingly.
|
namespace, adjust the commands accordingly.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
## Viewing Logs
|
||||||
|
|
||||||
|
To troubleshoot effectively, you’ll often need to review logs from multiple
|
||||||
|
sources:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# View operator logs (includes plugin interaction logs)
|
# View operator logs (includes plugin interaction logs)
|
||||||
kubectl logs -n cnpg-system deployment/cnpg-controller-manager -f
|
kubectl logs -n cnpg-system deployment/cnpg-controller-manager -f
|
||||||
|
|
||||||
# View sidecar container logs (Barman Cloud operations)
|
|
||||||
kubectl logs -n <namespace> <cluster-pod-name> -c plugin-barman-cloud -f
|
|
||||||
|
|
||||||
# View plugin manager logs
|
# View plugin manager logs
|
||||||
kubectl logs -n cnpg-system deployment/barman-cloud -f
|
kubectl logs -n cnpg-system deployment/barman-cloud -f
|
||||||
|
|
||||||
|
# View sidecar container logs (Barman Cloud operations)
|
||||||
|
kubectl logs -n <namespace> <cluster-pod-name> -c plugin-barman-cloud -f
|
||||||
|
|
||||||
# View all containers in a pod
|
# View all containers in a pod
|
||||||
kubectl logs -n <namespace> <cluster-pod-name> --all-containers=true
|
kubectl logs -n <namespace> <cluster-pod-name> --all-containers=true
|
||||||
|
|
||||||
@ -185,7 +185,7 @@ When a backup fails, follow these steps in order:
|
|||||||
a. **Check plugin registration:**
|
a. **Check plugin registration:**
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# If you have kubectl-cnpg plugin installed (v1.27.0+)
|
# If you have the `cnpg` plugin installed (v1.27.0+)
|
||||||
kubectl cnpg status -n <namespace> <cluster-name>
|
kubectl cnpg status -n <namespace> <cluster-name>
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -217,12 +217,12 @@ When a backup fails, follow these steps in order:
|
|||||||
|
|
||||||
2. **"rpc error: code = Unknown desc = panic caught: assignment to entry in nil map" errors**
|
2. **"rpc error: code = Unknown desc = panic caught: assignment to entry in nil map" errors**
|
||||||
|
|
||||||
**Cause:** Misconfiguration in the ObjectStore (e.g., typo or missing field).
|
**Cause:** Misconfiguration in the `ObjectStore` (e.g., typo or missing field).
|
||||||
|
|
||||||
**Solution:**
|
**Solution:**
|
||||||
|
|
||||||
- Review sidecar logs for details
|
- Review sidecar logs for details
|
||||||
- Verify ObjectStore configuration and secrets
|
- Verify `ObjectStore` configuration and secrets
|
||||||
- Common issues include:
|
- Common issues include:
|
||||||
- Missing or incorrect secret references
|
- Missing or incorrect secret references
|
||||||
- Typos in configuration parameters
|
- Typos in configuration parameters
|
||||||
@ -237,8 +237,8 @@ When a backup fails, follow these steps in order:
|
|||||||
|
|
||||||
**Plugin-specific considerations:**
|
**Plugin-specific considerations:**
|
||||||
|
|
||||||
1. **Check ObjectStore parallelism settings**
|
1. **Check `ObjectStore` parallelism settings**
|
||||||
- Adjust `maxParallel` in ObjectStore configuration
|
- Adjust `maxParallel` in `ObjectStore` configuration
|
||||||
- Monitor sidecar container resource usage during backups
|
- Monitor sidecar container resource usage during backups
|
||||||
|
|
||||||
2. **Verify plugin resource allocation**
|
2. **Verify plugin resource allocation**
|
||||||
@ -300,7 +300,7 @@ tuning, refer to the [Barman documentation](https://docs.pgbarman.org/latest/).
|
|||||||
2. **Verify plugin can access backups**
|
2. **Verify plugin can access backups**
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Check if ObjectStore is properly configured for restore
|
# Check if `ObjectStore` is properly configured for restore
|
||||||
kubectl get objectstores.barmancloud.cnpg.io \
|
kubectl get objectstores.barmancloud.cnpg.io \
|
||||||
-n <namespace> <objectstore-name> -o yaml
|
-n <namespace> <objectstore-name> -o yaml
|
||||||
|
|
||||||
@ -371,7 +371,7 @@ For detailed PITR configuration and WAL management, see the
|
|||||||
|
|
||||||
- Sidecar logs show connection errors
|
- Sidecar logs show connection errors
|
||||||
- Backups fail with authentication or network errors
|
- Backups fail with authentication or network errors
|
||||||
- ObjectStore resource reports errors
|
- `ObjectStore` resource reports errors
|
||||||
|
|
||||||
**Solution:**
|
**Solution:**
|
||||||
|
|
||||||
@ -389,7 +389,8 @@ For detailed PITR configuration and WAL management, see the
|
|||||||
|
|
||||||
2. **Check sidecar logs for connectivity issues**
|
2. **Check sidecar logs for connectivity issues**
|
||||||
```sh
|
```sh
|
||||||
kubectl logs -n <namespace> <cluster-pod> -c plugin-barman-cloud | grep -E "connect|timeout|SSL|cert"
|
kubectl logs -n <namespace> <cluster-pod> \
|
||||||
|
-c plugin-barman-cloud | grep -E "connect|timeout|SSL|cert"
|
||||||
```
|
```
|
||||||
|
|
||||||
3. **Adjust provider-specific settings (endpoint, path style, etc.)**
|
3. **Adjust provider-specific settings (endpoint, path style, etc.)**
|
||||||
@ -537,7 +538,8 @@ kubectl get pods -n <namespace> -l cnpg.io/cluster=<cluster-name> \
|
|||||||
# Check sidecar logs on ALL cluster pods (if the target is unclear)
|
# Check sidecar logs on ALL cluster pods (if the target is unclear)
|
||||||
for pod in $(kubectl get pods -n <namespace> -l cnpg.io/cluster=<cluster-name> -o name); do
|
for pod in $(kubectl get pods -n <namespace> -l cnpg.io/cluster=<cluster-name> -o name); do
|
||||||
echo "=== Checking $pod ==="
|
echo "=== Checking $pod ==="
|
||||||
kubectl logs -n <namespace> $pod -c plugin-barman-cloud --tail=20 | grep -i error || echo "No errors found"
|
kubectl logs -n <namespace> $pod -c plugin-barman-cloud \
|
||||||
|
--tail=20 | grep -i error || echo "No errors found"
|
||||||
done
|
done
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -556,7 +558,7 @@ kubectl get events -n <namespace> \
|
|||||||
kubectl get events -n <namespace> --sort-by='.lastTimestamp' | tail -20
|
kubectl get events -n <namespace> --sort-by='.lastTimestamp' | tail -20
|
||||||
```
|
```
|
||||||
|
|
||||||
### Verify ObjectStore Configuration
|
### Verify `ObjectStore` Configuration
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Check the ObjectStore resource
|
# Check the ObjectStore resource
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user