Make Litestream retention configurable #447
Conversation
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
|
recheck |
There was a problem hiding this comment.
I have read the CLA Document and I hereby sign the CLA
It looks like the email address you're using for commits (the @mailbox.org address) isn't associated with your Github account, so CLAbot won't accept your signature.
Can you add the email address to your account? Or add a commit using an email address that's already associated with your Github account?
README.md
Outdated
| @@ -59,6 +59,7 @@ LITESTREAM_BUCKET=YOUR-LITESTREAM-BUCKET | |||
| LITESTREAM_ENDPOINT=YOUR-LITESTREAM-ENDPOINT | |||
| LITESTREAM_ACCESS_KEY_ID=YOUR-ACCESS-ID | |||
| LITESTREAM_SECRET_ACCESS_KEY=YOUR-SECRET-ACCESS-KEY | |||
| LITESTREAM_RETENTION="72h" # optional | |||
There was a problem hiding this comment.
We can omit this here, since I want to limit it to the simplest set of options.
README.md
Outdated
| @@ -123,6 +124,7 @@ You can adjust behavior of the Docker container by specifying these Docker-speci | |||
| | `LITESTREAM_ENDPOINT` | Litestream-compatible cloud storage endpoint where Litestream should replicate data. | | |||
| | `LITESTREAM_ACCESS_KEY_ID` | Litestream-compatible cloud storage access key ID to the bucket where you want to replicate data. | | |||
| | `LITESTREAM_SECRET_ACCESS_KEY` | Litestream-compatible cloud storage secret access key to the bucket where you want to replicate data. | | |||
| | `LITESTREAM_RETENTION` | The amount of time Litestream snapshots & WAL files will be kept. (default 72h) | | |||
There was a problem hiding this comment.
Can we say "(defaults to 72h)." to match the conventions above?
(add 'to' and period after parens)
dev-scripts/serve-docker
Outdated
| @@ -23,6 +23,7 @@ set +x | |||
| set -x | |||
|
|
|||
| PS_SHARED_SECRET=somepassword | |||
| LITESTREAM_RETENTION=${LITESTREAM_RETENTION:-72h} | |||
There was a problem hiding this comment.
We can skip the retention setting in this file, as this script is just for development.
docs/deployment/fly.io.md
Outdated
| @@ -77,6 +77,8 @@ LITESTREAM_BUCKET="my-pico-bucket" | |||
| LITESTREAM_ENDPOINT="s3.us-west-002.backblazeb2.com" | |||
| ``` | |||
|
|
|||
| Additionally you can set up "retention" (see [Litestream replica settings](https://litestream.io/reference/config/#replica-settings)) for how long snapshots will be kept, using `LITESTREAM_RETENTION` variable. If unset, default value of `72h` will be used. | |||
There was a problem hiding this comment.
We can leave out the documentation here for simplicity. Otherwise, we end up redundantly defining every env variable in every deployment doc.
|
recheck |
|
e2e tests are a bit flaky, I had to bump the playwright timeout (I understand it's an "unrelated change") |
Details in #446
One problem though: due to current code organization (few "entrypoints"), I did not find a good single place for a default value.