ContextQMD
Back to Gitlabhq

Pull from a remote repository

doc/user/project/repository/mirror/pull.md

18.11.27.9 KB
Original Source

{{< details >}}

  • Tier: Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< history >}}

  • Moved to GitLab Premium in 13.9.

{{< /history >}}

You can use the GitLab interface to browse the content and activity of a repository, even if it isn't hosted on GitLab. Create a pull mirror to copy the branches, tags, and commits from an upstream repository to yours.

Unlike push mirrors, pull mirrors retrieve changes from an upstream (remote) repository on a scheduled basis. To prevent the mirror from diverging from the upstream repository, don't push commits directly to the downstream mirror. Push commits to the upstream repository instead. Changes in the remote repository are pulled into the GitLab repository:

UI and API updates are subject to default pull mirroring intervals of 5 minutes. This interval can be configured on GitLab Self-Managed instances.

By default, if any branch or tag on the downstream pull mirror diverges from the local repository, GitLab stops updating the branch. This prevents data loss. Deleted branches and tags in the upstream repository are not reflected in the downstream repository.

[!note] Items deleted from the downstream pull mirror repository, but still in the upstream repository, are restored upon the next pull. For example: a branch deleted only in the mirrored repository reappears after the next pull.

How pull mirroring works

After you configure a GitLab repository as a pull mirror:

  1. GitLab adds the repository to a queue.
  2. Once per minute, a Sidekiq cron job schedules repository mirrors to update, based on:
    • Available capacity, determined by Sidekiq settings. For GitLab.com, read GitLab.com Sidekiq settings.
    • How many mirrors are already in the queue and due for updates. Being due depends on when the repository mirror was last updated, and how many times updates have been retried.
  3. Sidekiq becomes available to process updates, mirrors are updated. If the update process:
    • Succeeds: An update is enqueued again with at least a 30 minute wait.
    • Fails: The update is attempted again later. After 14 failures, a mirror is marked as a hard failure and is no longer enqueued for updates. A branch diverging from its upstream counterpart can cause failures. To prevent branches from diverging, configure overwrite diverged branches when you create your mirror.

Configure pull mirroring

Prerequisites:

  1. In the top bar, select Search or go to and find your project.

  2. Select Settings > Repository.

  3. Expand Mirroring repositories.

  4. Enter the Git repository URL.

    [!note] To mirror the gitlab repository, use gitlab.com:gitlab-org/gitlab.git or https://gitlab.com/gitlab-org/gitlab.git.

  5. In Mirror direction, select Pull.

  6. In Authentication method, select your authentication method. For more information, see authentication methods for mirrors.

  7. Select any of the options you need:

  8. To save the configuration, select Mirror repository.

Overwrite diverged branches

{{< history >}}

  • Moved to GitLab Premium in 13.9.

{{< /history >}}

To always update your local branches with remote versions, even if they have diverged from the remote, select Overwrite diverged branches when you create a mirror.

[!warning] For mirrored branches, enabling this option results in the loss of local changes.

Trigger pipelines for mirror updates

{{< history >}}

  • Moved to GitLab Premium in 13.9.

{{< /history >}}

You can configure your mirror to automatically trigger pipelines when the remote repository updates branches or tags. Before you enable this feature:

  • Ensure your CI runners can handle the additional load from the remote repository activity.
  • Consider the security risks, because the pipelines use the credentials of the user that set up the pull mirroring. For example, a malicious maintainer could:
    • Make an update to the remote repository that attempts to fetch stored CI/CD variable values when the pipeline runs.
    • Could push commits to your mirrored project if the Allow Git push requests to the repository setting is enabled.

[!warning] Only enable this feature for your own projects or those with trusted maintainers.

Pull mirroring with SSO enforcement

When SSO enforcement is enabled for your group, the user who created the mirror must maintain an active SSO session or the mirror fails.

To configure mirroring without SSO session dependency, you can use the Pull mirroring API with a project access token, group access token, or personal access token for service accounts.

Trigger an update by using the API

{{< history >}}

  • moved to GitLab Premium in 13.9.

{{< /history >}}

Pull mirroring uses polling to detect new branches and commits added upstream, often minutes afterwards. You can notify GitLab using an API call, but the minimum interval for pull mirroring limits is still enforced.

For more information, see start the pull mirroring process for a project.

Fix hard failures when mirroring

{{< history >}}

  • Moved to GitLab Premium in 13.9.

{{< /history >}}

After 14 consecutive unsuccessful retries, the mirroring process is marked as a hard failure and mirroring attempts stop. This failure is visible in either the:

  • Project's main dashboard.
  • Pull mirror settings page.

To resume project mirroring, force an update.

If multiple projects are affected by this problem, such as after a long network or server outage, you can use the Rails console to identify and update all affected projects with this command:

ruby
Project.find_each do |p|
  if p.import_state && p.import_state.retry_count >= 14
    puts "Resetting mirroring operation for #{p.full_path}"
    p.import_state.reset_retry_count
    p.import_state.set_next_execution_to_now(prioritized: true)
    p.import_state.save!
  end
end