Write-ahead logging in Gitaly
Production Readiness
For any new or changes to a feature or service in production, the questions in this guide will help to make these changes more robust when they are enabled on GitLab.com.
Before starting, please review the Production Readiness Review document in the handbook.
This issue serves as a tracking issue to guide you through the readiness review. It's not the production readiness document itself!.
The readiness documentation will be added to the project with a merge request, where different interested parties can collaborate.
Readiness MR
Draft: Write-ahead logging in Gitaly (!156)
Reviewers
The reviewers should be filled in as one of the steps of the checklist below. If a reviewer in the "Mandatory" section is not allocated, please add the reason why next to the name.
If you are unsure who should be assigned as a reviewer, please reach out to any Infrastructure Engineering Manager for assistance.
To have a reviewer assigned from the InfraSec team, please create an issue in the issue tracker dedicated to Business as Usual (BAU). This will help the team to triage the review and start working on it. More information is available on the team's handbook page. After the issue is created, put a link to the issue next to Infrasec reviewer item below and add the reviewer name after one has been assigned.
The reviewer will check the box next to their name when the review is complete
Mandatory
-
Reliability: @ahmadsherif -
Delivery: @skarbek @anganga -
InfraSec: reviewer name
Optional
Delete these reviewers if they do not apply
-
Development: reviewer name -
Scalability: reviewer name -
Database: reviewer name
Readiness Checklist
The following items should be completed by the person initiating the readiness review:
-
Create this issue and assign it to yourself. Set a due-date for when you believe the readiness will be completed (this can be updated later if necessary). -
Review the Production Readiness Review handbook page. -
In the "Reviewers" section above, add the reviewer names. Names will be assigned by reaching out to the engineering manager of the corresponding team. -
Create the first draft of the readiness review by copying the template below and submitting an MR, add the label workflow-infraIn Progress to this issue. -
Add a link to the MR in the "Readiness MR" section at the top of this issue -
Assign the initial set reviewers to the MR. There can be multiple iterations of MR if needed, often it is helpful to have the first draft reviewed by team members in the same team. Approval of the MR does not mean the readiness document is approved, approvals will be done later on this issue. -
When last review of the MR is complete, ask the reviewers in the "Reviewers" section above to check the box next to their name if they are satisfied with the review and have no more questions or concerns. -
(Optional) If it is later decided to not proceed with this proposal, add workflow-infraCancelled and close this issue
When all boxes have been check in the "Reviewers" section, add the workflow-infraDone label and close the issue.