Skip to content

Add backup, backup validation, and backup replication function to chart - #383

Open
machisuji wants to merge 8 commits into
mainfrom
feature/backups
Open

machisuji wants to merge 8 commits into
mainfrom
feature/backups

Conversation

@machisuji

@machisuji machisuji commented Nov 3, 2026 •

Copy link
Copy Markdown
Member

Ticket

https://community.openproject.org/projects/HELM/work_packages/HELM-10/activity

What are you trying to accomplish?

Add an easy way to get backups for your OpenProject installation.

What approach did you choose and why?

  • this is all based on the old backup mechanism and helpers we already employed in our vanilla kubernetes setup, this is just extracted and translated into the helm chart
  • decided on kopia to create backups that are encrypted, compressed, and deduplicated to reduce backup repo size
  • decided on S3 as the backend (although kopia supports other backends as well)
  • the PR adds a bin/backup helper which should make it reasonably easy to interact with the backups (kopia repository)
  • an integration spec is added testing everything for the backups (including validation and replication) using two temporary rustfs s3 buckets
  • backing up S3-based attachments requires FUSE to mount the bucket for kopia, this in turn requires the backup pod to run in privileged mode which will fail when the namespace is marked for restricted mode (which the chart supports and aims for by default)
    • in this case we suggest installing the k8s-csi-s3 driver to mount buckets as PVCs to circumvent this issue
    • this is not necessary for pvc-based attachments or if the namespace is not in restricted mode
    • the chart installation will check if it is and fail if s3-based attachments are enabled in a restricted namespace

AI involvement

Collaborative – AI generated a substantial part of the code; I reviewed and understand every line.

Merge checklist

  • Added/updated tests

@machisuji
machisuji requested a review from a team as a code owner November 3, 2026 11:35
@changeset-bot

changeset-bot Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: af817ba

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
openproject Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@machisuji
machisuji force-pushed the feature/backups branch 2 times, most recently from 0f9639b to 99e212d Compare November 3, 2026 13:00
@machisuji machisuji added enhancement New feature or request needs review labels Nov 3, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request needs review

Development

Successfully merging this pull request may close these issues.

2 participants