Upgrade GitLab using the GitLab Package

This section describes how to upgrade GitLab to a new version using the GitLab package.

We recommend performing upgrades between major and minor releases no more than once per week, to allow time for background migrations to finish. Decrease the time required to complete these migrations by increasing the number of Sidekiq workers that can process jobs in the background_migration queue.

If you don’t follow the steps in zero downtime upgrades, your GitLab application will not be available to users while an upgrade is in progress. They either see a “Deploy in progress” message or a “502” error in their web browser.

Prerequisites:

  • Supported upgrade paths has suggestions on when to upgrade. Upgrade paths are enforced for version upgrades by default. This restricts performing direct upgrades that skip major versions (for example 10.3 to 12.7 in one jump) that can break GitLab installations due to multiple reasons like deprecated or removed configuration settings, upgrade of internal tools and libraries, and so on.
  • If you are upgrading from a non-Package installation to a GitLab Package installation, see Upgrading from a non-Package installation to a GitLab Package installation.
  • It’s important to ensure that any background migrations have been fully completed before upgrading to a new major version. Upgrading before background migrations have finished may lead to data corruption.
  • Gitaly servers must be upgraded to the newer version prior to upgrading the application server. This prevents the gRPC client on the application server from sending RPCs that the old Gitaly version does not support.

You can upgrade the GitLab Package using one of the following methods:

Both automatically back up the GitLab database before installing a newer GitLab version. You may skip this automatic database backup by creating an empty file at /etc/gitlab/skip-auto-backup:

sudo touch /etc/gitlab/skip-auto-backup

For safety reasons, you should maintain an up-to-date backup on your own if you plan to use this flag.

Version-specific changes

Updating to major versions might need some manual intervention. For more information, check the version your are upgrading to:

Upgrade using the official repositories

All GitLab packages are posted to the GitLab package server. Five repositories are maintained:

If you have installed Omnibus GitLab Community Edition or Enterprise Edition, then the official GitLab repository should have already been set up for you.

To upgrade to the newest GitLab version, run:

  • For GitLab Enterprise Edition:

    # Debian/Ubuntu
    sudo apt-get update
    sudo apt-get install gitlab-ee
    
    # Centos/RHEL
    sudo yum install gitlab-ee
    
  • For GitLab Community Edition:

    # Debian/Ubuntu
    sudo apt-get update
    sudo apt-get install gitlab-ce
    
    # Centos/RHEL
    sudo yum install gitlab-ce
    

Upgrade to a specific version using the official repositories

Linux package managers default to installing the latest available version of a package for installation and upgrades. Upgrading directly to the latest major version can be problematic for older GitLab versions that require a multi-stage upgrade path. An upgrade path can span multiple versions, so you must specify the specific GitLab package with each upgrade.

To specify the intended GitLab version number in your package manager’s install or upgrade command:

  1. First, identify the GitLab version number in your package manager:

    # Ubuntu/Debian
    sudo apt-cache madison gitlab-ee
    # RHEL/CentOS 6 and 7
    yum --showduplicates list gitlab-ee
    # RHEL/CentOS 8
    dnf search gitlab-ee*
    
  2. Then install the specific GitLab package:

    # Ubuntu/Debian
    sudo apt install gitlab-ee=12.0.12-ee.0
    # RHEL/CentOS 6 and 7
    yum install gitlab-ee-12.0.12-ee.0.el7
    # RHEL/CentOS 8
    dnf install gitlab-ee-12.0.12-ee.0.el8
    # SUSE
    zypper install gitlab-ee=12.0.12-ee.0
    

Upgrade using a manually-downloaded package

note
The package repository is recommended over a manual installation.

If for some reason you don’t use the official repositories, you can download the package and install it manually. This method can be used to either install GitLab for the first time or update it.

To download and install GitLab:

  1. Visit the official repository of your package.
  2. Browse to the repository for the type of package you would like to see the list of packages that are available. Multiple packages exist for a single version, one for each supported distribution type. Next to the filename is a label indicating the distribution, as the file names may be the same.
  3. Find the package version you wish to install and click on it.
  4. Click the Download button in the upper right corner to download the package.
  5. After the GitLab package is downloaded, install it using the following commands:

    • For GitLab Enterprise Edition:

      # Debian/Ubuntu
      dpkg -i gitlab-ee-<version>.deb
      
      # CentOS/RHEL
      rpm -Uvh gitlab-ee-<version>.rpm
      
    • For GitLab Community Edition:

      # GitLab Community Edition
      # Debian/Ubuntu
      dpkg -i gitlab-ce-<version>.deb
      
      # CentOS/RHEL
      rpm -Uvh gitlab-ce-<version>.rpm
      

Troubleshooting

GitLab 13.7 and later unavailable on Amazon Linux 2

Amazon Linux 2 is not an officially supported operating system. However, in past the official package installation script installed the el/6 package repository if run on Amazon Linux. From GitLab 13.7, we no longer provide el/6 packages so administrators must run the installation script again to update the repository to el/7:

curl --silent "https://packages.gitlab.com/install/repositories/gitlab/gitlab-ee/script.rpm.sh" | sudo bash

See the epic on support for GitLab on Amazon Linux 2 for the latest details on official Amazon Linux 2 support.

Get the status of a GitLab installation

sudo gitlab-ctl status
sudo gitlab-rake gitlab:check SANITIZE=true

RPM ‘package is already installed’ error

If you are using RPM and you are upgrading from GitLab Community Edition to GitLab Enterprise Edition you may get an error like this:

package gitlab-7.5.2_omnibus.5.2.1.ci-1.el7.x86_64 (which is newer than gitlab-7.5.2_ee.omnibus.5.2.1.ci-1.el7.x86_64) is already installed

You can override this version check with the --oldpackage option:

sudo rpm -Uvh --oldpackage gitlab-7.5.2_ee.omnibus.5.2.1.ci-1.el7.x86_64.rpm

Package obsoleted by installed package

CE and EE packages are marked as obsoleting and replacing each other so that both aren’t installed and running at the same time.

If you are using local RPM files to switch from CE to EE or vice versa, use rpm for installing the package rather than yum. If you try to use yum, then you may get an error like this:

Cannot install package gitlab-ee-11.8.3-ee.0.el6.x86_64. It is obsoleted by installed package gitlab-ce-11.8.3-ce.0.el6.x86_64

To avoid this issue, either:

500 error when accessing Project > Settings > Repository

When GitLab is migrated from CE > EE > CE, and then back to EE, you might get the following error when viewing a project’s repository settings:

Processing by Projects::Settings::RepositoryController#show as HTML
  Parameters: {"namespace_id"=>"<namespace_id>", "project_id"=>"<project_id>"}
Completed 500 Internal Server Error in 62ms (ActiveRecord: 4.7ms | Elasticsearch: 0.0ms | Allocations: 14583)

NoMethodError (undefined method `commit_message_negative_regex' for #<PushRule:0x00007fbddf4229b8>
Did you mean?  commit_message_regex_change):

This error is caused by an EE feature being added to a CE instance on the initial move to EE. After the instance is moved back to CE and then is upgraded to EE again, the push_rules table already exists in the database. Therefore, a migration is unable to add the commit_message_regex_change column.

This results in the backport migration of EE tables not working correctly. The backport migration assumes that certain tables in the database do not exist when running CE.

To fix this issue, manually add the missing commit_message_negative_regex column and restart GitLab:

# Access psql
sudo gitlab-rails dbconsole

# Add the missing column
ALTER TABLE push_rules ADD COLUMN commit_message_negative_regex VARCHAR;

# Exit psql
\q

# Restart GitLab
sudo gitlab-ctl restart

Error Failed to connect to the internal GitLab API on a separate GitLab Pages server

Please see GitLab Pages troubleshooting.