If you're a GitLab team member and are looking to alert Reliability Engineering about an availability issue with GitLab.com, please find quick instructions to report an incident here: Reporting an Incident.
If you're a GitLab team member looking for help with a security problem, please see the Engaging the Security On-Call section.
The GitLab.com production environment is comprised of services that operate–or support the operation of–gitlab.com. For a complete list of production services see the service catalog
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
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.
For details about managing schedules, workflows, and documentation, see the on-call documentation.
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.
All configuration, deploys and feature flag events are recorded in Elastic Search using the events index. To access events and for more information about how they are logged see the events runbook.
These events include deploys, feature-flags, configuration (Chef, Terraform), and all Kubernetes changes. Events are recorded separately for the staging and production environment.
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.
This is a Controlled Document
Inline with GitLab's regulatory obligations, changes to controlled documents must be approved or merged by a code owner. All contributions are welcome and encouraged.
This section is part of controlled document covering our controls for backups. It covers BCD-11 in the controls.
Production database backups
|Infrastructure Team||Responsible for configuration and management|
|Infrastructure Management (Code Owners)||Responsible for approving significant changes and exceptions to this procedure|
Backups of our production databases are taken every 24 hours with continuous incremental data (at 60 sec intervals), streamed into GCS. These backups are encrypted, and follow the lifecycle:
After 120 days, backups are deleted.
Data stored in Object Storage (GCS) such as artifacts, the container registry, and others have no additional backups, relying on the 99.999999999% annual durability and multi-region buckets.
For details see the runbooks, particularly for GCP snapshots and Database backups using WAL-E/WAL-G (encrypted)
Exceptions to this backup policy will be tracked in the compliance issue tracker.
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.
The critical change process is described in the emergency change process overview.
Currently validation can be done manually by cross examining the logs of the host with the scans done by tenable.
Infrastructure will look to begin OS upgrades for Ubuntu LTS releases 6 months after their release and attempt to maintain all GCP compute instances on an LTS within the last 5 years of release. When instances are on older OS releases, we leverage Ubuntu Advantage to gain an extension on security releases.
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.