gitlab-org--gitlab-foss/doc/update/8.16-to-8.17.md
2017-02-16 14:26:39 -06:00

6.7 KiB

From 8.16 to 8.17

Make sure you view this update guide from the tag (version) of GitLab you would like to install. In most cases this should be the highest numbered production tag (without rc in it). You can select the tag in the version dropdown at the top left corner of GitLab (below the menu bar).

If the highest number stable branch is unclear please check the GitLab Blog for installation guide links by version.

1. Stop server

sudo service gitlab stop

2. Backup

cd /home/git/gitlab

sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production

3. Update Ruby

We will continue supporting Ruby < 2.3 for the time being but we recommend you upgrade to Ruby 2.3 if you're running a source installation, as this is the same version that ships with our Omnibus package.

You can check which version you are running with ruby -v.

Download and compile Ruby:

mkdir /tmp/ruby && cd /tmp/ruby
curl --remote-name --progress https://cache.ruby-lang.org/pub/ruby/2.3/ruby-2.3.3.tar.gz
echo '1014ee699071aa2ddd501907d18cbe15399c997d ruby-2.3.3.tar.gz' | shasum -c - && tar xzf ruby-2.3.3.tar.gz
cd ruby-2.3.3
./configure --disable-install-rdoc
make
sudo make install

Install Bundler:

sudo gem install bundler --no-ri --no-rdoc

4. Update Node

GitLab now runs webpack to compile frontend assets and it has a minimum requirement of node v4.3.0.

You can check which version you are running with node -v. If you are running a version older than v4.3.0 you will need to update to a newer version. You can find instructions to install from community maintained packages or compile from source at the nodejs.org website.

https://nodejs.org/en/download/

5. Get latest code

cd /home/git/gitlab

sudo -u git -H git fetch --all
sudo -u git -H git checkout -- db/schema.rb # local changes will be restored automatically

For GitLab Community Edition:

cd /home/git/gitlab

sudo -u git -H git checkout 8-17-stable

OR

For GitLab Enterprise Edition:

cd /home/git/gitlab

sudo -u git -H git checkout 8-17-stable-ee

6. Install libs, migrations, etc.

cd /home/git/gitlab

# MySQL installations (note: the line below states '--without postgres')
sudo -u git -H bundle install --without postgres development test --deployment

# PostgreSQL installations (note: the line below states '--without mysql')
sudo -u git -H bundle install --without mysql development test --deployment

# 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

# Install/update frontend asset dependencies
sudo -u git -H npm install --production

# Clean up assets and cache
sudo -u git -H bundle exec rake gitlab:assets:clean gitlab:assets:compile cache:clear RAILS_ENV=production

MySQL installations: Run through the MySQL strings limits and Tables and data conversion to utf8mb4 tasks.

7. Update gitlab-workhorse

Install and compile gitlab-workhorse. This requires Go 1.5 which should already be on your system from GitLab 8.1.

cd /home/git/gitlab

sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse]" RAILS_ENV=production

8. Update gitlab-shell

cd /home/git/gitlab-shell

sudo -u git -H git fetch --all --tags
sudo -u git -H git checkout v4.1.1

9. Update configuration files

New configuration options for gitlab.yml

There are new configuration options available for gitlab.yml. View them with the command below and apply them manually to your current gitlab.yml:

cd /home/git/gitlab

git diff origin/8-16-stable:config/gitlab.yml.example origin/8-17-stable:config/gitlab.yml.example

Git configuration

Configure Git to generate packfile bitmaps (introduced in Git 2.0) on the GitLab server during git gc.

cd /home/git/gitlab

sudo -u git -H git config --global repack.writeBitmaps true

Nginx configuration

Ensure you're still up-to-date with the latest NGINX configuration changes:

cd /home/git/gitlab

# For HTTPS configurations
git diff origin/8-16-stable:lib/support/nginx/gitlab-ssl origin/8-17-stable:lib/support/nginx/gitlab-ssl

# For HTTP configurations
git diff origin/8-16-stable:lib/support/nginx/gitlab origin/8-17-stable:lib/support/nginx/gitlab

If you are using Apache instead of NGINX please see the updated Apache templates. Also note that because Apache does not support upstreams behind Unix sockets you will need to let gitlab-workhorse listen on a TCP port. You can do this via /etc/default/gitlab.

SMTP configuration

If you're installing from source and use SMTP to deliver mail, you will need to add the following line to config/initializers/smtp_settings.rb:

ActionMailer::Base.delivery_method = :smtp

See smtp_settings.rb.sample as an example.

Init script

Ensure you're still up-to-date with the latest init script changes:

cd /home/git/gitlab

sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab

For Ubuntu 16.04.1 LTS:

sudo systemctl daemon-reload

10. Start application

sudo service gitlab start
sudo service nginx restart

11. Check application status

Check if GitLab and its environment are configured correctly:

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:

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!

Things went south? Revert to previous version (8.16)

1. Revert the code to the previous version

Follow the upgrade guide from 8.15 to 8.16, except for the database migration (the backup is already migrated to the previous version).

2. Restore from the backup

cd /home/git/gitlab

sudo -u git -H bundle exec rake gitlab:backup:restore RAILS_ENV=production

If you have more than one backup *.tar file(s) please add BACKUP=timestamp_of_backup to the command above.