|GitLab.com Status||Status Page|
|How to get help||How to get help|
|Incident Management||How we handle GitLab.com incidents|
|Change Management||How we manage changes to GitLab.com|
|Workflow||How may we be of service?|
|Issue Trackers||Infrastructure: Milestones, OnCall||Production: Incidents, Changes, Deltas||Delivery|
|Slack Channels||#infrastructure-lounge, #database||#alerts, #production||#g_delivery|
|Operations||Runbooks (please contribute!)||On-call: Handover Document, Reports|
|Production||SRE Onboarding||Readiness Guide||Database Reliability||On-call Handover|
The GitLab.com production environment is comprised of all the systems, code, and configurations, that operate–or support the operation of–gitlab.com. This includes, but is not limited to:
Production is not:
The Site Reliability teams are responsible for all of GitLab's user-facing services, most notably, GitLab.com. Site Reliability Engineers ensure that these services are available, reliable, scalable, performant and, with the help of GitLab's Security Department, secure. This infrastructure includes a multitude of environments, including staging, GitLab.com (production) and dev.GitLab.org, among others (see the list of environments).
SREs are primarily focused on the GitLab.com's availability, and have a strong focus on building the right toolsets and automations to enable development to ship features as fast and bug-free as possible, leveraging the tools provided by GitLab (we must dogfood).
Another part of the job is building monitoring tools that allow quick troubleshooting as a first step, then turning this into alerts to notify based on symptoms, to then fixing the problem or automating the remediation. We can only scale GitLab.com by being smart and using resources effectively, starting with our own time as the main scarce resource.
The Production Board keeps track of the state of Production, showing, at a glance, incidents, hotspots, changes and deltas related to production, and it also includes on-call reports.
For a detailed description of the board, see production/board.
We want to make GitLab.com ready for mission critical workloads. That readiness means:
To see current SRE on call for urgent requests, issue the GitLab chatops
/chatops run oncall prod. If an issue already exists, please be ready to provide it to the SRE on call.
For high severity issues
that require immediate attention the best way to get help is to use
/pd <msg> in the
#production channel on slack.
For non-urgent requests, open an issue in the infrastructure tracker
@gitlab-com/gl-infra/managers for scheduling.
Long term, additional teams will perform work on the production environment:
We cannot keep track of events in production across a growing number of functional queues.
Furthermore, said teams will start to have on-call rotations for both their function (e.g., security) and their services. For people on-call, having a centralized tracking point to keep track of said events is more effective than perusing various queues. Timely information (in terms of when an event is happening and how long it takes for an on-call person to understand what's happening) about the production environment is critical. The
production queue centralizes production event information.
Functional queues track team workloads (
security, etc) and are the source of the work that has to get done. Some of this work clearly impacts production (build and deploy new storage nodes); some of it will not (develop a tool to do x, y, z) until it is deployed to production.
production queue tracks events in production, namely:
Over time, we will implement hooks into our automation to automagically inject change audit data into the
This also leads to a single source of data. Today, for instance, incident reports for the week get transcribed to both the On-call Handoff and Infra Call documents (we also show exceptions in the latter). These meetings serve different purposes but have overlapping data. The input for this data should be queries against the
production queue versus the manual build in documents.
Additionally, we need to keep track of error budgets, which should also be derived from the
We will also be collapsing the
database queue into the
infrastructure queue. The database is a special piece of the infrastructure for sure, but so are the storage nodes, for example.
For the on-call SRE, every event that pages (where an event may be a group of related pages) should have an issue created for it in the
production queue. Per the severity definitions, if there is at least visible impact (functional inconvenience to users), then it is by definition an incident, and the Incident template should be used for the issue. This is likely to be the majority of pager events; exceptions are typically obvious, i.e. they impact only us and customers won't even be aware, or they're alerts that are pre-incident level which by acting on we avoid incidents.
All direct or indirect changes to authentication and authorization mechanisms used by GitLab Inc. by customers or employees require additional review and approval by a member of at least one of following teams:
This process is enforced for the following repositories where the approval is mandatory using MR approvals:
Additional repositories may also require this approval and can be evaluated on a case-by-case basis.
When should we loop the security team in on changes? If we are making major changes to any of the following areas:
Type labels are very important. They define what kind of issue this is. Every issue should have one or more.
||Represents a Change on infrastructure please check details on : Change|
||Represents a Incident on infrastructure please check details on : Incident|
||Label for problems related to database|
||Label for problems related to security|
The services list is mentioned here : https://gitlab.com/gitlab-com/runbooks/blob/master/services/service-catalog.yml
Service Criticality labels help us to define, how critical is the service and could be a change in the infrastructure, considering how will affect the user experience in case of a failure. I.e.
~C1 Postgresql or Redis Master. As most of the services could reach different levels of criticality we consider here the highest, also we have the template of actions for a change depending on the criticality:
||Vital service and is a single point of failure, if down the application will be down|
||Important service, if down some functionalities will not be available from the application|
||Service in case of some instance is down or the service, we can have performance degradation|
||Services that could be in maintenance mode or would not affect the performance of the application|
The service redundancy level helps us to identify what services has the avaiability of failover or if there is another mechanism of redundancy.
||The loss of a single instance will affect all the users||Instance in PostgreSql or Redis|
||The loss of a single instance will affect a subset of users||Instance in Gitaly|
||The loss of a single instance would not affect any user||Instance of grafana|
We use some other labels to indicate specific conditions and then measure the impact of these conditions within production or the production engineering team. This is specially important from the time investment in specific parts of the production engineering team, to reduce toil or to reduce the chance of a failure by accessing to production more than enough.
Labels that are particularly important for gathering data are:
~toilRepetitive, boring work that should be automated away.
~unscheduledAn issue that became an interruption to the team and had to be handled in a Milestone. It's unplanned work.
~unblocks othersAn issue that is allowing some other part of the company to deliver something.
We should never stop helping and unblocking team members. To this end, data should always be gathered to assist in highlighting areas for automation and the creation of self-service processes. Creating an issue from the request with the proper labels is the first step. The default should be that the person requesting help makes the issue; but we can help with that step too if needed.
If this issue is urgent for whatever reason, we should label them following the instructions above and add them to the ongoing Milestone.
When an on-call person is paged, either via the /pd command in slack or the automated monitoring systems, the SRE member will have a 15 minute SLA to acknowledge or escalate the alert.
This is also noted in the On-Call section of the handbook.
Because GitLab is an asynchronous workflow company, @mentions of On-Call individuals in slack will be treated like normal messages and no SLA for response will be attached or associated with them. This is also because notifications over phones via Slack have no escalation policies. PagerDuty has policies that team members and rotations can configure to make sure an alert is escalated when no person has acknowledged the alert.
If you need to page a team member from slack - you can do the /pd "your message to the on-call here" to send out an alert to the currently on-call team members.
Given the number of systems and service that we use, it's very hard if not impossible to reach an expert level in all of them. What makes it even harder is the rate of changes made to our infrastructure. For this reason, the person on-call is not expected to know everything about all of our systems. In addition, incidents are often complex and vague in their nature requiring different perspectives and ideas for solutions.
Reaching out for help is considered good practice and should not be mistaken for incompetence. Asking for help while following the escalation guidelines and checklists can expose information and result in faster resolution of problems. It also improves the knowledge of the team as a whole when for example an undocumented problem is covered in runbooks after an incident or when questions are asked in Slack channels where others can read it. This is true for on-call emergencies as well as project work. You will not be judged on the questions you ask, regardless of how elemental they might be.
The SRE team's primary responsibility is availability of gitlab.com. For this reason, helping the person on-call should take priority over project work. It doesn't mean that for every single incident, the entire SRE team should drop everything and get involved. However, it does mean that as knowledge and experience in a field that is relevant to a problem, they should feel entitled to prioritize that over project work. Previous experiences have shown that as the incident's severity increased or potential causes were ruled out, more and more people from across the company were getting involved.
There are 2 kind of production events that we track:
For some incidents, we may figure out that the usage patterns that led to the issues were abuse. There is a process for how we define and handle abuse.
All servers in the production environment managed and maintained by the GitLab infrustructure team will be proactively maintained and patched with the latest security patches.
All production servers managed by chef have a base role that configures each server to install and use
unattended-upgrades for automatically installing important security packages from the configured apt sources.
Unattended-upgrades check for updates everyday between 6 and 7 am UTC. The time is randomized to avoid hitting the mirrors at the same time. All output is logged
Unattended upgrades is configured to automatically patch all security upgrades for packages with the exception of the GitLab omnibus package. Critical security releases for GitLab are deployed to GitLab by a separate process. You can read more about that process in the release docs.
Currently validation can be done manually by cross examining the logs of the host with the scans done by tenable.
Infrastructure will provide support to the security team for issues found during penetration testing. For coordinating a pen test or to coordinate any procedures to address and remidiate vulnerabilities, should be communicated to the infrastructure team through an issue in the infrastructure issue tracker.
In the issue please provide the following:
Please tag issues with the
~security label and
/cc infrastructure managers.