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

Doc: Explain how GFS backups work #8223

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Doc: Explain how GFS backups work #8223

wants to merge 5 commits into from

Conversation

thomas-dkmt
Copy link
Contributor

As announced in the 5.101 release note, Xen Orchestra now supports the GFS (Grandfather-Father-Son) backup strategy.

The XO documentation is updated to reflect this new feature and explain how to use it.

Description

Short explanation of this PR (feel free to re-use commit message)

Checklist

  • Commit
    • Title follows commit conventions
    • Reference the relevant issue (Fixes #007, See xoa-support#42, See https://...)
    • If bug fix, add Introduced by
  • Changelog
    • If visible by XOA users, add changelog entry
    • Update "Packages to release" in CHANGELOG.unreleased.md
  • PR
    • If UI changes, add screenshots
    • If not finished or not tested, open as Draft

Review process

This 2-passes review process aims to:

  • develop skills of junior reviewers
  • limit the workload for senior reviewers
  • limit the number of unnecessary changes by the author
  1. The author creates a PR.
  2. Review process:
    1. The author assigns the junior reviewer.
    2. The junior reviewer conducts their review:
      • Resolves their comments if they are addressed.
      • Adds comments if necessary or approves the PR.
    3. The junior reviewer assigns the senior reviewer.
    4. The senior reviewer conducts their review:
      • If there are no unresolved comments on the PR → merge.
      • Otherwise, we continue with 3.
  3. The author responds to comments and/or makes corrections, and we go back to 2.

Notes:

  1. The author can request a review at any time, even if the PR is still a Draft.
  2. In theory, there should not be more than one reviewer at a time.
  3. The author should not make any changes:
    • When a reviewer is assigned.
    • Between the junior and senior reviews.

Xen Orchestra now supports the GFS (Grandfather-Father-Son) backup strategy.
The XO documentation is updated to reflect this new feature and explain how to use it.

Signed-off-by: Thomas Moraine <[email protected]>
@thomas-dkmt thomas-dkmt requested a review from fbeauchamp January 6, 2025 15:06
Comment on lines 415 to 422
#### FAQ

- **What happens if I change my GFS retention policy?**
Excess backups will be deleted during the next job execution to match the updated retention settings.

- **Is GFS retention applied globally or per repository?**
GFS retention is applied on a per-remote/repository basis, allowing you to manage retention independently for different storage locations.

Copy link
Collaborator

Choose a reason for hiding this comment

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

there are two FAQ, is it intended ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed by 84836af

4. In that section, you can define the following:
- **Daily backups** (Son): The number of daily backups to keep.
- **Weekly backups** (Father): The number of weekly backups to keep.
- **Monthly backups** (Grandfather): The number of monthly backups to keep.
Copy link
Collaborator

Choose a reason for hiding this comment

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

there is also a yearly setting

Copy link
Contributor Author

@thomas-dkmt thomas-dkmt Jan 9, 2025

Choose a reason for hiding this comment

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

Fixed by c928669


:::warning
- **Definition of a week:**\
The "week" in GFS retention refers to a practical interval, not a strict alignment with calendar weeks.
Copy link
Collaborator

Choose a reason for hiding this comment

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

the start of the week is computed with the timezone set in the schedule

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed by 6cdff03

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants