OCI Object Storage as an S3-compatible backup destination
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- kubernetes, postgresql
- Domain
- cloud, databases, documentation
Research direction
Start by reviewing the existing Barman Cloud Plugin documentation structure and the validated OCI configuration described in this issue. Add a concise provider guide covering prerequisites, Secret and ObjectStore examples, WAL archiving, backups, recovery, troubleshooting, and security notes; done means the documented workflow matches the listed validated scenarios.
Written by the indexing model from the issue text.
Description
Summary
I would like to contribute documentation for using Oracle Cloud Infrastructure
(OCI) Object Storage as an S3-compatible backup destination with the Barman
Cloud CNPG-I plugin.
This is a documentation/configuration contribution. It does not add a native
OCI-specific provider implementation.
What was validated
- Continuous WAL archiving
- On-demand physical backup
- Scheduled backups
- Backup object validation in OCI Object Storage
- Restore/bootstrap of a new CloudNativePG cluster from the stored backup
- Recovery readiness / WAL replay
OCI configuration
- OCI Object Storage S3 Compatibility API
- Endpoint pattern:
https://<namespace>.compat.objectstorage.<region>.oci.customer-oci.com - OCI Customer Secret Key used as S3 access key and secret key
- Explicit OCI region configured for request signing
- Unique destination path per PostgreSQL cluster
Validated versions
| Component | Validated version / image |
|---|---|
| CloudNativePG Operator | 1.29.1 |
| Operator image | ghcr.io/cloudnative-pg/cloudnative-pg:1.29.1 |
| PostgreSQL | 18.3 |
| PostgreSQL image | ghcr.io/cloudnative-pg/postgresql:18.3-system-trixie |
| PostgreSQL build | postgres (PostgreSQL) 18.3 (Debian 18.3-1.pgdg13+1) |
| Barman Cloud Plugin | 0.12.0 |
| Plugin image | ghcr.io/cloudnative-pg/plugin-barman-cloud:v0.12.0 |
| Detected cluster plugin | barman-cloud.cloudnative-pg.io, version 0.12.0 |
Proposed documentation
I can submit a concise OCI Object Storage provider guide containing:
- OCI prerequisites and IAM guidance
- Kubernetes Secret example using placeholders
ObjectStoremanifest- Cluster WAL-archiving configuration
- On-demand and scheduled backup examples
- Recovery example
- OCI-specific troubleshooting and security notes
Reference implementation and test details:
https://medium.com/oracledevs/cloudnativepg-oci-object-storage-a-practical-backup-and-restore-guide-98d35c204b55
Could you please confirm whether an OCI Object Storage configuration guide would be welcome as part of the Barman Cloud Plugin documentation?
- Dominant language
- Go
- Stars
- 196
- Forks
- 76
- Avg merge
- 4d 13h
- Merged PRs (30d)
- 19
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from cloudnative-pg/plugin-barman-cloud
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
cloudnative-pg/plugin-barman-cloud#1142 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
cloudnative-pg/plugin-barman-cloud#1117 · 1 reaction ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
cloudnative-pg/plugin-barman-cloud#1104 · 4 reactions ·
Maintainers usually reply within 1 day
-
Add RBAC aggregation labels to ObjectStore editor/viewer ClusterRolesPossibly taken @stefanpeknik claimed this 18 days ago. Open
Difficulty 1/5 Under an hour Newbie friendliness 82/100
cloudnative-pg/plugin-barman-cloud#1102 ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
cloudnative-pg/plugin-barman-cloud#1143 ·
Maintainers usually reply within 1 day
All issues in cloudnative-pg/plugin-barman-cloud
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day