debian-mirror-gitlab/doc/update/upgrading_from_source.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

509 lines
16 KiB
Markdown
Raw Normal View History

2019-07-07 11:18:12 +05:30
---
2022-07-23 23:45:48 +05:30
stage: Systems
2021-03-08 18:12:59 +05:30
group: Distribution
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2019-07-07 11:18:12 +05:30
comments: false
---
2021-04-29 21:17:54 +05:30
# Upgrading Community Edition and Enterprise Edition from source **(FREE SELF)**
2019-07-07 11:18:12 +05:30
Make sure you view this update guide from the branch (version) of GitLab you
2022-08-13 15:12:31 +05:30
would like to install (for example, `11.8`). You can select the required version of documentation in the dropdown list at the top right corner of GitLab documentation page.
2019-07-07 11:18:12 +05:30
2021-10-27 15:23:28 +05:30
In each of the following examples, replace `BRANCH` with the branch of the version you upgrading to (for example, `11-8-stable` for `11.8`). Replace `PREVIOUS_BRANCH` with the
branch for the version you are upgrading from (for example, `11-7-stable` for `11.7`).
2019-07-07 11:18:12 +05:30
2022-08-13 15:12:31 +05:30
If the highest number stable branch is unclear check the
2019-07-07 11:18:12 +05:30
[GitLab Blog](https://about.gitlab.com/blog/archives.html) for installation
guide links by version.
2019-07-31 22:56:46 +05:30
If you are changing from GitLab Community Edition to GitLab Enterprise Edition, see
the [Upgrading from CE to EE](upgrading_from_ce_to_ee.md) documentation.
2020-03-13 15:44:24 +05:30
## Upgrading to a new major version
Major versions are reserved for backwards incompatible changes. We recommend that
2021-10-27 15:23:28 +05:30
you first upgrade to the latest available minor version of your current major version.
2022-08-13 15:12:31 +05:30
Follow the [Upgrade Recommendations](../policy/maintenance.md#upgrade-recommendations)
2020-03-13 15:44:24 +05:30
to identify the ideal upgrade path.
Before upgrading to a new major version, you should ensure that any background
migration jobs from previous releases have been completed. To see the current size of the `background_migration` queue,
2021-03-11 19:13:27 +05:30
[Check for background migrations before upgrading](index.md#checking-for-background-migrations-before-upgrading).
2020-03-13 15:44:24 +05:30
2019-07-07 11:18:12 +05:30
## Guidelines for all versions
This section contains all the steps necessary to upgrade Community Edition or
Enterprise Edition, regardless of the version you are upgrading to. Version
specific guidelines (should there be any) are covered separately.
2019-09-04 21:01:54 +05:30
### 1. Backup
2019-07-07 11:18:12 +05:30
2021-02-22 17:27:13 +05:30
If you installed GitLab from source, make sure `rsync` is installed.
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production
```
2019-09-04 21:01:54 +05:30
### 2. Stop server
2020-03-13 15:44:24 +05:30
```shell
2021-12-11 22:18:48 +05:30
# For systems running systemd
sudo systemctl stop gitlab.target
# For systems running SysV init
2019-09-04 21:01:54 +05:30
sudo service gitlab stop
```
2019-07-07 11:18:12 +05:30
### 3. Update Ruby
2021-02-22 17:27:13 +05:30
NOTE:
Beginning in GitLab 13.6, we only support Ruby 2.7 or higher, and dropped
2021-01-29 00:20:46 +05:30
support for Ruby 2.6. Be sure to upgrade if necessary.
2019-07-07 11:18:12 +05:30
You can check which version you are running with `ruby -v`.
Download Ruby and compile it:
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
mkdir /tmp/ruby && cd /tmp/ruby
2022-07-23 23:45:48 +05:30
curl --remote-name --location --progress-bar "https://cache.ruby-lang.org/pub/ruby/2.7/ruby-2.7.6.tar.gz"
echo 'e7203b0cc09442ed2c08936d483f8ac140ec1c72e37bb5c401646b7866cb5d10 ruby-2.7.6.tar.gz' | sha256sum -c - && tar xzf ruby-2.7.6.tar.gz
cd ruby-2.7.6
2019-07-07 11:18:12 +05:30
2021-04-29 21:17:54 +05:30
./configure --disable-install-rdoc --enable-shared
2019-07-07 11:18:12 +05:30
make
sudo make install
```
2020-03-13 15:44:24 +05:30
### 4. Update Node.js
2019-07-07 11:18:12 +05:30
2021-09-04 01:27:46 +05:30
To check the minimum required Node.js version, see [Node.js versions](../install/installation.md#software-requirements).
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
GitLab also requires the use of Yarn `>= v1.10.0` to manage JavaScript
2019-07-07 11:18:12 +05:30
dependencies.
2020-03-13 15:44:24 +05:30
In Debian or Ubuntu:
```shell
2021-06-08 01:23:25 +05:30
sudo apt-get remove yarn
npm install --global yarn
2019-07-07 11:18:12 +05:30
```
2020-04-22 19:07:51 +05:30
More information can be found on the [Yarn website](https://classic.yarnpkg.com/en/docs/install).
2019-07-07 11:18:12 +05:30
### 5. Update Go
2021-09-04 01:27:46 +05:30
To check the minimum required Go version, see [Go versions](../install/installation.md#software-requirements).
2019-07-07 11:18:12 +05:30
You can check which version you are running with `go version`.
2020-03-13 15:44:24 +05:30
Download and install Go (for Linux, 64-bit):
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
# Remove former Go installation folder
sudo rm -rf /usr/local/go
2022-07-23 23:45:48 +05:30
curl --remote-name --location --progress-bar "https://go.dev/dl/go1.17.10.linux-amd64.tar.gz"
echo '87fc728c9c731e2f74e4a999ef53cf07302d7ed3504b0839027bd9c10edaa3fd go1.17.10.linux-amd64.tar.gz' | shasum -a256 -c - && \
sudo tar -C /usr/local -xzf go1.17.10.linux-amd64.tar.gz
2021-11-18 22:05:49 +05:30
sudo ln -sf /usr/local/go/bin/{go,gofmt} /usr/local/bin/
2022-07-23 23:45:48 +05:30
rm go1.17.10.linux-amd64.tar.gz
2019-07-07 11:18:12 +05:30
```
2019-12-04 20:38:33 +05:30
### 6. Update Git
2019-07-31 22:56:46 +05:30
2020-06-23 00:09:42 +05:30
To check you are running the minimum required Git version, see
2021-09-04 01:27:46 +05:30
[Git versions](../install/installation.md#software-requirements).
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
From GitLab 13.6, we recommend you use the [Git version provided by
Gitaly](https://gitlab.com/gitlab-org/gitaly/-/issues/2729)
that:
2019-07-31 22:56:46 +05:30
2021-04-17 20:07:23 +05:30
- Is always at the version required by GitLab.
- May contain custom patches required for proper operation.
2019-07-31 22:56:46 +05:30
2021-04-17 20:07:23 +05:30
```shell
2019-07-31 22:56:46 +05:30
# Install dependencies
2021-04-17 20:07:23 +05:30
sudo apt-get install -y libcurl4-openssl-dev libexpat1-dev gettext libz-dev libssl-dev libpcre2-dev build-essential
2019-07-31 22:56:46 +05:30
2021-04-17 20:07:23 +05:30
# Clone the Gitaly repository
git clone https://gitlab.com/gitlab-org/gitaly.git -b <X-Y-stable> /tmp/gitaly
2019-07-31 22:56:46 +05:30
2021-04-17 20:07:23 +05:30
# Compile and install Git
cd /tmp/gitaly
sudo make git GIT_PREFIX=/usr/local
2019-07-31 22:56:46 +05:30
```
2021-04-17 20:07:23 +05:30
Replace `<X-Y-stable>` with the stable branch that matches the GitLab version you want to
install. For example, if you want to install GitLab 13.6, use the branch name `13-6-stable`.
Remember to set `git -> bin_path` to `/usr/local/bin/git` in `config/gitlab.yml`.
2020-11-24 15:15:51 +05:30
### 7. Update PostgreSQL
2021-02-22 17:27:13 +05:30
WARNING:
2022-07-16 23:28:13 +05:30
GitLab 14.0 requires at least PostgreSQL 12.
2020-11-24 15:15:51 +05:30
2021-04-17 20:07:23 +05:30
The latest version of GitLab might depend on a more recent PostgreSQL version
2021-10-27 15:23:28 +05:30
than what you are running. You may also have to enable some
2021-04-17 20:07:23 +05:30
extensions. For more information, see the
[PostgreSQL requirements](../install/requirements.md#postgresql-requirements)
2020-11-24 15:15:51 +05:30
2021-04-17 20:07:23 +05:30
To upgrade PostgreSQL, refer to its [documentation](https://www.postgresql.org/docs/11/upgrading.html).
2020-11-24 15:15:51 +05:30
### 8. Get latest code
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
cd /home/git/gitlab
sudo -u git -H git fetch --all --prune
2021-04-17 20:07:23 +05:30
sudo -u git -H git checkout -- Gemfile.lock db/structure.sql locale
2019-07-07 11:18:12 +05:30
```
For GitLab Community Edition:
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
cd /home/git/gitlab
sudo -u git -H git checkout BRANCH
```
OR
For GitLab Enterprise Edition:
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
cd /home/git/gitlab
sudo -u git -H git checkout BRANCH-ee
```
2021-04-17 20:07:23 +05:30
### 9. Update configuration files
2019-07-07 11:18:12 +05:30
#### New configuration options for `gitlab.yml`
2021-09-04 01:27:46 +05:30
There might be configuration options available for [`gitlab.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/gitlab.yml.example)).
2020-03-13 15:44:24 +05:30
View them with the command below and apply them manually to your current `gitlab.yml`:
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
cd /home/git/gitlab
git diff origin/PREVIOUS_BRANCH:config/gitlab.yml.example origin/BRANCH:config/gitlab.yml.example
```
2022-06-21 17:19:12 +05:30
#### New configuration options for `database.yml`
There might be configuration options available for [`database.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/database.yml.postgresql).
View them with the command below and apply them manually to your current `database.yml`:
```shell
cd /home/git/gitlab
git diff origin/PREVIOUS_BRANCH:config/database.yml.postgresql origin/BRANCH:config/database.yml.postgresql
```
2019-12-21 20:55:43 +05:30
#### NGINX configuration
2019-07-07 11:18:12 +05:30
Ensure you're still up-to-date with the latest NGINX configuration changes:
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
cd /home/git/gitlab
# For HTTPS configurations
git diff origin/PREVIOUS_BRANCH:lib/support/nginx/gitlab-ssl origin/BRANCH:lib/support/nginx/gitlab-ssl
# For HTTP configurations
git diff origin/PREVIOUS_BRANCH:lib/support/nginx/gitlab origin/BRANCH:lib/support/nginx/gitlab
```
2021-10-27 15:23:28 +05:30
If you are using Strict-Transport-Security in your installation, you must enable it in your
NGINX configuration to continue using it. This is because the GitLab application no longer
sets it.
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
If you are using Apache instead of NGINX see the updated [Apache templates](https://gitlab.com/gitlab-org/gitlab-recipes/tree/master/web-server/apache).
2022-08-13 15:12:31 +05:30
Also because Apache does not support upstreams behind Unix sockets you
2021-02-22 17:27:13 +05:30
must let GitLab Workhorse listen on a TCP port. You can do this
2021-09-04 01:27:46 +05:30
via [`/etc/default/gitlab`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/support/init.d/gitlab.default.example#L38).
2019-07-07 11:18:12 +05:30
#### SMTP configuration
2021-02-22 17:27:13 +05:30
If you're installing from source and use SMTP to deliver mail, you must
2019-07-07 11:18:12 +05:30
add the following line to `config/initializers/smtp_settings.rb`:
```ruby
ActionMailer::Base.delivery_method = :smtp
```
2021-09-04 01:27:46 +05:30
See [`smtp_settings.rb.sample`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/initializers/smtp_settings.rb.sample#L13) as an example.
2019-07-07 11:18:12 +05:30
2021-12-11 22:18:48 +05:30
#### Configure systemd units
If using the SysV init script, see [Configure SysV init script](#configure-sysv-init-script).
Check if the systemd units have been updated:
```shell
cd /home/git/gitlab
git diff origin/PREVIOUS_BRANCH:lib/support/systemd origin/BRANCH:lib/support/systemd
```
Copy them over:
```shell
sudo mkdir -p /usr/local/lib/systemd/system
sudo cp lib/support/systemd/* /usr/local/lib/systemd/system/
sudo systemctl daemon-reload
```
#### Configure SysV init script
If using systemd units, see [Configure systemd units](#configure-systemd-units).
2019-07-07 11:18:12 +05:30
There might be new configuration options available for
2021-09-04 01:27:46 +05:30
[`gitlab.default.example`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/support/init.d/gitlab.default.example).
2020-03-13 15:44:24 +05:30
View them with the command below and apply them manually to your current `/etc/default/gitlab`:
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
cd /home/git/gitlab
git diff origin/PREVIOUS_BRANCH:lib/support/init.d/gitlab.default.example origin/BRANCH:lib/support/init.d/gitlab.default.example
```
Ensure you're still up-to-date with the latest init script changes:
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
cd /home/git/gitlab
sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
```
2021-12-11 22:18:48 +05:30
If you are using the init script on a system running systemd as init, because you have not switched to native systemd units yet, run:
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
sudo systemctl daemon-reload
```
2021-04-17 20:07:23 +05:30
### 10. Install libraries, migrations, etc
2019-07-07 11:18:12 +05:30
2021-11-18 22:05:49 +05:30
Make sure you have the required
[PostgreSQL extensions](../install/requirements.md#postgresql-requirements),
then proceed to install the needed libraries:
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
cd /home/git/gitlab
2021-04-17 20:07:23 +05:30
# If you haven't done so during installation or a previous upgrade already
2021-04-29 21:17:54 +05:30
sudo -u git -H bundle config set --local deployment 'true'
sudo -u git -H bundle config set --local without 'development test mysql aws kerberos'
2021-04-17 20:07:23 +05:30
# Update gems
sudo -u git -H bundle install
2019-07-07 11:18:12 +05:30
# Optional: clean up old gems
sudo -u git -H bundle clean
# Run database migrations
sudo -u git -H bundle exec rake db:migrate RAILS_ENV=production
# Compile GetText PO files
sudo -u git -H bundle exec rake gettext:compile RAILS_ENV=production
# Update node dependencies and recompile assets
2019-09-04 21:01:54 +05:30
sudo -u git -H bundle exec rake yarn:install gitlab:assets:clean gitlab:assets:compile RAILS_ENV=production NODE_ENV=production NODE_OPTIONS="--max_old_space_size=4096"
2019-07-07 11:18:12 +05:30
# Clean up cache
sudo -u git -H bundle exec rake cache:clear RAILS_ENV=production
```
2021-04-17 20:07:23 +05:30
### 11. Update GitLab Shell
```shell
cd /home/git/gitlab-shell
sudo -u git -H git fetch --all --tags --prune
sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_SHELL_VERSION)
sudo -u git -H make build
```
### 12. Update GitLab Workhorse
Install and compile GitLab Workhorse.
```shell
cd /home/git/gitlab
sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse]" RAILS_ENV=production
```
2021-11-18 22:05:49 +05:30
NOTE:
If you get any errors concerning Rack attack, see the [13.0](#1301) specific
upgrade instructions.
2021-04-17 20:07:23 +05:30
### 13. Update Gitaly
2022-07-23 23:45:48 +05:30
If Gitaly is located on its own server, or you use Gitaly Cluster, see [Gitaly or Gitaly Cluster](zero_downtime.md#gitaly-or-gitaly-cluster)
on the Zero downtime upgrades page.
2021-04-17 20:07:23 +05:30
#### Compile Gitaly
```shell
2021-11-18 22:05:49 +05:30
# Fetch Gitaly source with Git and compile with Go
cd /home/git/gitlab
sudo -u git -H bundle exec rake "gitlab:gitaly:install[/home/git/gitaly,/home/git/repositories]" RAILS_ENV=production
2021-04-17 20:07:23 +05:30
```
### 14. Update GitLab Pages
#### Only needed if you use GitLab Pages
Install and compile GitLab Pages. GitLab Pages uses
[GNU Make](https://www.gnu.org/software/make/).
If you are not using Linux you may have to run `gmake` instead of
`make` below.
```shell
cd /home/git/gitlab-pages
sudo -u git -H git fetch --all --tags --prune
sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_PAGES_VERSION)
sudo -u git -H make
```
2020-11-24 15:15:51 +05:30
### 15. Start application
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
```shell
2021-12-11 22:18:48 +05:30
# For systems running systemd
sudo systemctl start gitlab.target
sudo systemctl restart nginx.service
# For systems running SysV init
2019-07-07 11:18:12 +05:30
sudo service gitlab start
sudo service nginx restart
```
2020-11-24 15:15:51 +05:30
### 16. Check application status
2019-07-07 11:18:12 +05:30
Check if GitLab and its environment are configured correctly:
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
```
To make sure you didn't miss anything run a more thorough check:
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production
```
If all items are green, then congratulations, the upgrade is complete!
2022-08-13 15:12:31 +05:30
### 17. Upgrade the product documentation
This is an optional step. If you [installed the product documentation](../install/installation.md#install-the-product-documentation),
see how to [upgrade to a later version](../administration/docs_self_host.md#upgrade-the-product-documentation-to-a-later-version).
2019-07-07 11:18:12 +05:30
## Version specific upgrading instructions
This section contains upgrading instructions for specific versions. When
present, first follow the upgrading guidelines for all versions. If the version
you are upgrading to is not listed here, then no additional steps are required.
<!--
Example:
### 11.8.0
Additional instructions here.
-->
2022-07-16 23:28:13 +05:30
### 15.0.0
Support for more than one database has been added to GitLab. [As part of this](https://gitlab.com/gitlab-org/gitlab/-/issues/338182),
2022-08-13 15:12:31 +05:30
`config/database.yml` must include a database name in the database configuration.
2022-07-16 23:28:13 +05:30
The `main: database` must be first. If an invalid or deprecated syntax is used, an error is generated
during application start:
```plaintext
ERROR: This installation of GitLab uses unsupported 'config/database.yml'.
The main: database needs to be defined as a first configuration item instead of primary. (RuntimeError)
```
Previously, the `config/database.yml` file looked like the following:
```yaml
production:
adapter: postgresql
encoding: unicode
database: gitlabhq_production
...
```
2022-08-13 15:12:31 +05:30
Starting with GitLab 15.0, it must define a `main` database first:
2022-07-16 23:28:13 +05:30
```yaml
production:
main:
adapter: postgresql
encoding: unicode
database: gitlabhq_production
...
```
2022-04-04 11:22:00 +05:30
### 14.5.0
As part of [enabling real-time issue assignees](https://gitlab.com/gitlab-org/gitlab/-/issues/330117), Action Cable is now enabled by default, and requires `config/cable.yml` to be present.
You can configure this by running:
```shell
cd /home/git/gitlab
sudo -u git -H cp config/cable.yml.example config/cable.yml
# Change the Redis socket path if you are not using the default Debian / Ubuntu configuration
sudo -u git -H editor config/cable.yml
```
2020-06-23 00:09:42 +05:30
### 13.0.1
2021-11-18 22:05:49 +05:30
As part of [deprecating Rack Attack throttles on Omnibus GitLab](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/4750), the Rack Attack initializer on GitLab
2020-06-23 00:09:42 +05:30
was renamed from [`config/initializers/rack_attack_new.rb` to `config/initializers/rack_attack.rb`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/33072).
If this file exists on your installation, consider creating a backup before updating:
```shell
cd /home/git/gitlab
2021-11-18 22:05:49 +05:30
cp config/initializers/rack_attack.rb ~/config/initializers/rack_attack_backup.rb
2020-06-23 00:09:42 +05:30
```
2020-03-13 15:44:24 +05:30
## Troubleshooting
2019-07-07 11:18:12 +05:30
### 1. Revert the code to the previous version
2021-10-27 15:23:28 +05:30
To revert to a previous version, you must follow the upgrading guides
2020-03-13 15:44:24 +05:30
for the previous version.
For example, if you have upgraded to GitLab 12.6 and want to revert back to
2021-10-27 15:23:28 +05:30
12.5, follow the guides for upgrading from 12.4 to 12.5. You can
2022-08-13 15:12:31 +05:30
use the version dropdown list at the top of the page to select the right version.
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
When reverting, you should **not** follow the database migration guides, as the
backup has already been migrated to the previous version.
2019-07-07 11:18:12 +05:30
### 2. Restore from the backup
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:backup:restore RAILS_ENV=production
```
2020-03-13 15:44:24 +05:30
If you have more than one backup `*.tar` file, add `BACKUP=timestamp_of_backup` to the above.