Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs about the new keep-alive mechanism #989

Merged
merged 1 commit into from
Aug 19, 2024
Merged

Conversation

gustabowill
Copy link
Contributor

Add in the docs a description of the new keepalive_interval server configuration as well as your equivalent CLI argument --keepalive-interval that can be specifided together with the backup command.

References: BAR-256

@gustabowill gustabowill self-assigned this Aug 15, 2024
@gustabowill gustabowill marked this pull request as ready for review August 15, 2024 15:18
@gustabowill gustabowill requested a review from a team as a code owner August 15, 2024 15:18
@gcalacoci
Copy link
Contributor

this LGTM, approved.

Copy link
Contributor

@barthisrael barthisrael left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes introduced by this PR look good.

I'm only missing some "note" in the Backup with rsync/SSH section providing more context about this setting. Maybe something like this:

> **NOTE:**
> Starting with Barman 3.11.0, Barman uses a keep-alive mechanism when taking
> rsync-based backups. It keeps sending a simple `SELECT 1` query over the
> libpq connection where Barman runs `pg_backup_start`/`pg_backup_stop`
> low-level API functions, and it's in place to reduce the probability of a firewall or
> a router dropping that connection as it can be idle for a long time while the base
> backup is being copied. You can control the interval of the hearbeats, or even
> disable the mechanism, through the `keepalive_interval` configuration option.

Thoughts @gcalacoci @gustabowill ?

@gcalacoci
Copy link
Contributor

Thoughts @gcalacoci @gustabowill ?

LGTM

Add in the docs a description of the new `keepalive_interval`
server configuration as well as your equivalent CLI argument
`--keepalive-interval` that can be specifided together with the
`backup` command.

References: BAR-256

Signed-off-by: Gustavo William <[email protected]>
@gustabowill
Copy link
Contributor Author

Thoughts @gcalacoci @gustabowill ?

Looks awesome, thanks! I added that at the end of the Rsync section.

Copy link
Contributor

@barthisrael barthisrael left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@barthisrael barthisrael merged commit 3a0b26c into master Aug 19, 2024
7 of 8 checks passed
@barthisrael barthisrael deleted the dev/bar-256 branch August 19, 2024 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants