This workflow is meant to provide guidance on when GitLab Team members might offer to import projects on behalf of customers or prospects as a courtesy, and the process for doing the imports. Due to the shifting nature of what issues might be relevant, the specifics of this workflow may change. Overall though, the import process should follow the flow outlined below.
When a request to import a project on behalf of a customer or prospect is received, we first need to determine if the request fits the criteria.
If the customer requires that only a couple projects or less be imported and those projects have a reasonable number of users within them, we can do it. If the request is complex or there are many projects that need importing, the requester should be referred to Professional Services instead.
Once you've determined that GitLab Support is able to process the import, proceed with verifying the Baseline Eligibility of all of the projects to be imported or determine that the requestor is approved because they meet the criteria of a Pre-Approved Case.
In addition to the above criteria, we can automatically offer to import a project for a customer if their case falls under the criteria of any of the following sections.
Due to 24806, users with large projects (typically ~1GB+ or 1000+ MRs) will often hit the sidekiq timeout. Imports stop when they hit a timeout, but an incomplete project will always be created, resulting in a partial import.
A project's size can be reduced by:
import_export.ymlfile on the self-managed instance. For more context see this comment.
These are also noted in the
NOTE: Once 196875 is implemented, imports should be able to be restarted, which should get around this case.
A GitLab.com admin is required to correctly map users in GitLab, per our documentation. Without an admin account, repository commits will have correct user attribution but issues and merge requests will not. We can import a project for a customer if they require this.
NOTE: Using an admin account will not be required once 223137 is implemented.
If you're unsure of whether or not we should perform an import for a specific requestor, get input via #support_managers Slack channel or an internal issue. If a manager approves, proceed with the import.
We can only offer an import if no validation (not timeout) error is found on a previously attempted import. Most timeout related imports end up with a partial import with very few or zero issues or merge requests. Where there is a relatively smaller difference (10% or less), then there are most likely errors with those specific issues or merge requests.
Anytime there is an error, ensure that the export originated from a compatible version of GitLab.
NOTE: See the Diagnose Errors on GitLab.com workflow for more details on searching Kibana and Sentry.
Projects::ImportsControllerwith error status
Projects::ImportService::Error; make sure to remove the
If there is an error, search for an existing issue. Errors where the metadata is throwing an error and no issue exists, consider creating one from Sentry.
If no error is found and the import is partial, most likely it is a timeout issue.
NOTE: In all cases, the import process is the same except that infra has a longer timeout period. If any validation errors are not worked out ahead of time, these will crop up during the infra import as well.
GitLab.com::Import::Determine_Eligibility.json Zendesk macro to make the requestor aware of all of these requirements and get additional details from them. If the requestor's case is approved based on their followup reply, move on to Stage 2: Offering Import & Preparation.
When customers request a specific time period for the imports to be done, they should always do a test import for each project and make note of how long it takes. It can be approximate, but should give everyone a clear idea of whether it's reasonable to be done within the given time period. Remember that both Support and Infra require additional time in addition to the actual import time, and too short of a time interval might be interrupted by an incident.
If the customer requires that all issues, merge requests, and commits be mapped to the appropriate users in their organization, use the
GitLab.com::Import::Offer Import (Users Mapped) Zendesk macro and then follow the next sections in sequence.
groupwith the group name).
AR-Priority::1(24 hour turnaround) label.
@it-ops-teamin the #it_help Slack channel with a link to the request to ensure quick provisioning as soon as you receive a manager's approval.
In the access request, enter the following in the Person Details section.
- Admin user access for customer import for Infra's use with username: `group-import` - Set email to: `email@example.com` - Ticket: <TICKET LINK> - Import request: <INFRA ISSUE LINK> **Note:** This is part of the [project import process](/handbook/support/workflows/importing_projects.html) for customers.
Then, enter the following for the Account Creation section.
GitLab PRD | Role: `admin` | Rationale: `customer import` ; Please confirm, and enable 2FA for this user.
The customer should send you a copy of the project export ahead of their chosen import time (if scheduled) so that there is ample time to do the next section and for the customer to verify the list and correct any errors.
User emails unique to export file:section of the results and ensure that all email addresses listed are on the requestor's company domain, meaning no users have an email address on a generic domain such as Gmail.com.
If issues within the list are found:
GitLab.com::Import::Verify User List (Problem Found)Zendesk macro, which will ask them to resolve the issues we found and send us a new project export once that's done. Once they have, repeat the 2. Verify User List section.
If no issues within the list are found:
GitLab.com::Import::Verify User List (Looks Good)Zendesk macro and await their reply. Once they reply and confirm that all email addresses that were found only in the export file are from employees no longer with the company, this section is complete.
NOTE: For these users, items will be mapped to the admin account, then the ghost user once the admin account is deleted.
If the customer does not mention that they need project contributions (issues, MRs, etc.) mapped to their users, then we'll be importing their project(s) as a user of their choosing. Use the
GitLab.com::Import::Offer Import (Users Not Mapped) Zendesk macro and then perform the steps in the following section:
The customer should have replied stating which GitLab.com account they'd like the project imported as. The user they choose will have all contributions mapped to it. We need to verify that the following are true of this user.
If the user is not an Owner, use the
GitLab.com::Import::Require Group Permission macro as a response.
This stage is applicable to both Users Mapped and Users Not Mapped imports. For Users Mapped, it may be started once the requestor has confirmed that the User List has been verified. For Users Not Mapped, it may be started once User Permissions have been verified.
Proceed in the following order:
tar -zxvf filename.tar.gz -C project_export.
Note that the expectation from the Reliablity team is 5 business days of lead time to accomodate proper scheduling of the work.
Project Importtemplate with all available information. This issue template will auto-assign the Reliability team managers and label the issue for triage.
After the import has completed successfully, perform the following steps.
GitLab.com::Import::Complete Customer to Verifyto let the customer know that the import has completed and that they should double check that everything is in order.
GitLab.com::Import::Require Group Permission
GitLab.com::Import::Offer Import (Users Mapped)
GitLab.com::Import::Offer Import (Users Not Mapped)
GitLab.com::Import::Verify User List (Looks Good)
GitLab.com::Import::Verify User List (Problem Found)
GitLab.com::Import::Complete Customer to Verify
There is a video recording from 2019-05-22 (internal) where the first half is a walkthrough of the process, and the second half talks through troubleshooting issues.
Time And Date can be used to convert timezones to UTC, useful for when imports are scheduled for a future time.