zalando / zalando/spilo

Test (wal-g) backup compression algorithms are supported

Open
#1,007 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
1.9k
Forks
462
Avg merge
6d 5m
Merged PRs (30d)
1

Description

Why?

Wal-g 3.x made brotli compression an optional build flag, see https://github.com/wal-g/wal-g/pull/1379. Upgrading to v3.x broke assumptions in some clusters relying on brotli compression and explicitly setting backup creation to use wal-g. Restoration would have equally failed, but in those cases no backups could be created in the first place.

Proposed solution

  • The proposed fix is to use pre-built wal-g binaries from the source repository itself instead of compiling in Spilo, which at this moment seem to include brotli compression (https://github.com/zalando/spilo/pull/1006)

To prevent any regressions, we should run automated tests to verify that all expected compression algorithms are still working for each Spilo build as expressed in this comment https://github.com/zalando/spilo/pull/1006#issuecomment-2244915865, because lz4 or lzma might be dropped (or made optional) at one time in future as well.

This would help detecting issues with creating or restoring from backups early.

for algo in lz4 lzma brotli; do
  # ... verify backups can be created and restored from $algo
done

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the proposed pre-built wal-g binary change in Spilo PR #1006 and its referenced comment, then locate the existing backup creation and restoration test entry points. Add automated coverage for lz4, lzma, and brotli across each Spilo build, verifying that backups can be created and restored with every algorithm.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, postgresql
Domain
build-system, databases, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.