gitlab-org--gitlab-foss/doc/update/upgrader.md

85 lines
3.6 KiB
Markdown
Raw Normal View History

2014-04-24 18:48:22 -04:00
# GitLab Upgrader
*DEPRECATED* We recommend to [switch to the Omnibus package and repository server](https://about.gitlab.com/update/) instead of using this script.
Although deprecated, if someone wants to make this script into a gem or otherwise improve it merge requests are welcome.
2015-05-13 06:08:48 -04:00
*Make sure you view this [upgrade guide from the 'master' branch](../../../master/doc/update/upgrader.md) for the most up to date instructions.*
2014-01-27 07:51:01 -05:00
GitLab Upgrader - a ruby script that allows you easily upgrade GitLab to latest minor version.
2014-04-24 18:48:22 -04:00
2014-01-27 07:51:01 -05:00
For example it can update your application from 6.4 to latest GitLab 6 version (like 6.6.1).
2014-04-24 18:48:22 -04:00
You still need to create a backup and manually restart GitLab after running the script but all other operations are done by this upgrade script.
2014-01-27 07:51:01 -05:00
If you have local changes to your GitLab repository the script will stash them and you need to use `git stash pop` after running the script.
2014-04-24 18:48:22 -04:00
**GitLab Upgrader is available only for GitLab version 6.4.2 or higher.**
**This script does NOT update gitlab-shell, it needs manual update. See step 5 below.**
2014-04-24 18:48:22 -04:00
## 0. Backup
cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production
2014-04-24 18:48:22 -04:00
## 1. Stop server
sudo service gitlab stop
2014-04-24 18:48:22 -04:00
## 2. Run GitLab upgrade tool
Please replace X.X.X with the [latest GitLab release](https://packages.gitlab.com/gitlab/gitlab-ce).
GitLab 7.9 adds `nodejs` as a dependency. GitLab 7.6 adds `libkrb5-dev` as a dependency (installed by default on Ubuntu and OSX). GitLab 7.2 adds `pkg-config` and `cmake` as dependency. Please check the dependencies in the [installation guide.](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/install/installation.md#1-packages-dependencies)
cd /home/git/gitlab
sudo -u git -H ruby -Ilib -e 'require "gitlab/upgrader"' -e 'class Gitlab::Upgrader' -e 'def latest_version_raw' -e '"vX.X.X"' -e 'end' -e 'end' -e 'Gitlab::Upgrader.new.execute'
# to perform a non-interactive install (no user input required) you can add -y
# sudo -u git -H ruby -Ilib -e 'require "gitlab/upgrader"' -e 'class Gitlab::Upgrader' -e 'def latest_version_raw' -e '"vX.X.X"' -e 'end' -e 'end' -e 'Gitlab::Upgrader.new.execute' -- -y
2014-04-24 18:48:22 -04:00
## 3. Start application
sudo service gitlab start
sudo service nginx restart
2014-02-13 23:50:02 -05:00
2014-04-24 18:48:22 -04:00
## 4. Check application status
2014-02-13 23:50:02 -05:00
Check if GitLab and its dependencies are configured correctly:
2014-02-13 23:50:02 -05:00
sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production
2014-02-13 23:50:02 -05:00
If all items are green, then congratulations upgrade is complete!
2014-04-04 04:19:40 -04:00
## 5. Upgrade GitLab Shell
2014-04-24 18:48:22 -04:00
GitLab Shell might be outdated, running the commands below ensures you're using a compatible version:
```
cd /home/git/gitlab-shell
sudo -u git -H git fetch
sudo -u git -H git checkout v`cat /home/git/gitlab/GITLAB_SHELL_VERSION`
```
2014-04-04 04:19:40 -04:00
2014-04-24 18:48:22 -04:00
## One line upgrade command
2014-04-04 04:19:40 -04:00
You've read through the entire guide and probably already did all the steps one by one.
2014-04-24 18:48:22 -04:00
Below is a one line command with step 1 to 5 for the next time you upgrade.
Please replace X.X.X with the [latest GitLab release](https://packages.gitlab.com/gitlab/gitlab-ce).
2014-04-04 04:19:40 -04:00
```bash
cd /home/git/gitlab; \
sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production; \
2014-06-02 03:48:55 -04:00
sudo service gitlab stop; \
sudo -u git -H ruby -Ilib -e 'require "gitlab/upgrader"' -e 'class Gitlab::Upgrader' -e 'def latest_version_raw' -e '"vX.X.X"' -e 'end' -e 'end' -e 'Gitlab::Upgrader.new.execute' -- -y; \
cd /home/git/gitlab-shell; \
sudo -u git -H git fetch; \
sudo -u git -H git checkout v`cat /home/git/gitlab/GITLAB_SHELL_VERSION`; \
cd /home/git/gitlab; \
2014-06-02 03:48:55 -04:00
sudo service gitlab start; \
sudo service nginx restart; \
sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production
2015-05-07 08:24:18 -04:00
```