Skip to content

Draft: Update DR/Backups handbook pages

Shreya Shah requested to merge sshah/update-handbook into main

Why is this change being made?

💡 Provide a detailed answer to the question on why this change is being proposed, in accordance with our value of Transparency.

Please add the details saying why, not just what in this section. Example: We have discussed the topic in Slack - (copy of Slack conversation). The current process is not efficient, this MR makes the description of X more clear, and helps move Y forward.

Related to issue : gitlab-com/gl-infra/production-engineering#25788

  • Added context to the main backup page from database disaster recovery
  • Removed irrelevant links
  1. Make several updates to the main backup page in the handbook
    • Cover both backups and restores
    • Cover both snapshot strategy and db backup strategy
    • Fold in the content from database disaster recovery handbook page to this page
    • Ensure the section on databases talks about all databases (or is not so specific), not just the main one
    • Add section for gamedays, referencing the gameday overview
  2. Because the design doc for DR appears in google searches, add a header that links to the main backup page as the SSOT
  3. Once (1) is complete remove the faq page as content on that page is like from 2019 and is outdated.
  4. Once (1) is complete remove the database dr handbook page
  5. Any place where we reference RTO/RPO should reference https://handbook.gitlab.com/handbook/engineering/architecture/design-documents/disaster_recovery/ instead as the SSOT.

CHANGEME

Author and Reviewer Checklist

Please verify the check list and ensure to tick them off before the MR is merged.

  • Provided a concise title for this Merge Request (MR)
  • Added a description to this MR explaining the reasons for the proposed change, per say why, not just what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added, and the content is SAFE
  • Assign reviewers for this MR to the correct Directly Responsible Individual/s (DRI)
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the Maintained by section on the page being edited
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies
    • The when to get approval handbook section explains the workflow in more detail
  • For transparency, share this MR with the audience that will be impacted.
    • Team: For changes that affect your direct team, share in your group Slack channel
    • Department: If the update affects your department, share the MR in your department Slack channel
    • Division: If the update affects your division, share the MR in your division Slack channel
    • Company: If the update affects all (or the majority of) GitLab team members, post an update in #whats-happening-at-gitlab linking to this MR

Commits

  • Removed link to BCD

Edited by Shreya Shah

Merge request reports

Loading