407 lines
11 KiB
Markdown
407 lines
11 KiB
Markdown
---
|
|
comments: false
|
|
---
|
|
|
|
# From 9.0 to 9.1
|
|
|
|
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](https://about.gitlab.com/blog/archives.html) for installation
|
|
guide links by version.
|
|
|
|
### 1. Stop server
|
|
|
|
```bash
|
|
sudo service gitlab stop
|
|
```
|
|
|
|
### 2. Backup
|
|
|
|
```bash
|
|
cd /home/git/gitlab
|
|
|
|
sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production
|
|
```
|
|
|
|
### 3. Update Ruby
|
|
|
|
NOTE: GitLab 9.0 and higher only support Ruby 2.3.x and dropped support for Ruby 2.1.x. Be
|
|
sure to upgrade your interpreter if necessary.
|
|
|
|
You can check which version you are running with `ruby -v`.
|
|
|
|
Download and compile Ruby:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
sudo gem install bundler --no-ri --no-rdoc
|
|
```
|
|
|
|
### 4. Update Node
|
|
|
|
GitLab now runs [webpack](http://webpack.js.org) 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/>
|
|
|
|
|
|
Since 8.17, GitLab requires the use of yarn `>= v0.17.0` to manage
|
|
JavaScript dependencies.
|
|
|
|
```bash
|
|
curl --silent --show-error https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
|
|
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
|
|
sudo apt-get update
|
|
sudo apt-get install yarn
|
|
```
|
|
|
|
More information can be found on the [yarn website](https://yarnpkg.com/en/docs/install).
|
|
|
|
### 5. Get latest code
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
cd /home/git/gitlab
|
|
|
|
sudo -u git -H git checkout 9-1-stable
|
|
```
|
|
|
|
OR
|
|
|
|
For GitLab Enterprise Edition:
|
|
|
|
```bash
|
|
cd /home/git/gitlab
|
|
|
|
sudo -u git -H git checkout 9-1-stable-ee
|
|
```
|
|
|
|
### 6. Update gitlab-shell
|
|
|
|
```bash
|
|
cd /home/git/gitlab-shell
|
|
|
|
sudo -u git -H git fetch --all --tags
|
|
sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_SHELL_VERSION)
|
|
```
|
|
|
|
### 7. Update gitlab-workhorse
|
|
|
|
Install and compile gitlab-workhorse. This requires
|
|
[Go 1.5](https://golang.org/dl) which should already be on your system from
|
|
GitLab 8.1. GitLab-Workhorse 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.
|
|
|
|
```bash
|
|
cd /home/git/gitlab-workhorse
|
|
|
|
sudo -u git -H git fetch --all --tags
|
|
sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_WORKHORSE_VERSION)
|
|
sudo -u git -H make
|
|
```
|
|
|
|
### 8. Update configuration files
|
|
|
|
#### New configuration options for `gitlab.yml`
|
|
|
|
There might be configuration options available for [`gitlab.yml`][yaml]. View them with the command below and apply them manually to your current `gitlab.yml`:
|
|
|
|
```sh
|
|
cd /home/git/gitlab
|
|
|
|
git diff origin/9-0-stable:config/gitlab.yml.example origin/9-1-stable:config/gitlab.yml.example
|
|
```
|
|
|
|
#### Configuration changes for repository storages
|
|
|
|
This version introduces a new configuration structure for repository storages.
|
|
Update your current configuration as follows, replacing with your storages names and paths:
|
|
|
|
**For installations from source**
|
|
|
|
1. Update your `gitlab.yml`, from
|
|
|
|
```yaml
|
|
repositories:
|
|
storages: # You must have at least a 'default' storage path.
|
|
default: /home/git/repositories
|
|
nfs: /mnt/nfs/repositories
|
|
cephfs: /mnt/cephfs/repositories
|
|
```
|
|
|
|
to
|
|
|
|
```yaml
|
|
repositories:
|
|
storages: # You must have at least a 'default' storage path.
|
|
default:
|
|
path: /home/git/repositories
|
|
nfs:
|
|
path: /mnt/nfs/repositories
|
|
cephfs:
|
|
path: /mnt/cephfs/repositories
|
|
```
|
|
|
|
**For Omnibus installations**
|
|
|
|
1. Update your `/etc/gitlab/gitlab.rb`, from
|
|
|
|
```ruby
|
|
git_data_dirs({
|
|
"default" => "/var/opt/gitlab/git-data",
|
|
"nfs" => "/mnt/nfs/git-data",
|
|
"cephfs" => "/mnt/cephfs/git-data"
|
|
})
|
|
```
|
|
|
|
to
|
|
|
|
```ruby
|
|
git_data_dirs({
|
|
"default" => { "path" => "/var/opt/gitlab/git-data" },
|
|
"nfs" => { "path" => "/mnt/nfs/git-data" },
|
|
"cephfs" => { "path" => "/mnt/cephfs/git-data" }
|
|
})
|
|
```
|
|
|
|
#### Git configuration
|
|
|
|
Configure Git to generate packfile bitmaps (introduced in Git 2.0) on
|
|
the GitLab server during `git gc`.
|
|
|
|
```sh
|
|
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:
|
|
|
|
```sh
|
|
cd /home/git/gitlab
|
|
|
|
# For HTTPS configurations
|
|
git diff origin/9-0-stable:lib/support/nginx/gitlab-ssl origin/9-1-stable:lib/support/nginx/gitlab-ssl
|
|
|
|
# For HTTP configurations
|
|
git diff origin/9-0-stable:lib/support/nginx/gitlab origin/9-1-stable:lib/support/nginx/gitlab
|
|
```
|
|
|
|
If you are using Strict-Transport-Security in your installation to continue using it you must enable it in your Nginx
|
|
configuration as GitLab application no longer handles setting it.
|
|
|
|
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].
|
|
|
|
[Apache templates]: https://gitlab.com/gitlab-org/gitlab-recipes/tree/master/web-server/apache
|
|
[/etc/default/gitlab]: https://gitlab.com/gitlab-org/gitlab-ce/blob/9-1-stable/lib/support/init.d/gitlab.default.example#L38
|
|
|
|
#### 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:
|
|
|
|
```ruby
|
|
ActionMailer::Base.delivery_method = :smtp
|
|
```
|
|
|
|
See [smtp_settings.rb.sample] as an example.
|
|
|
|
[smtp_settings.rb.sample]: https://gitlab.com/gitlab-org/gitlab-ce/blob/9-1-stable/config/initializers/smtp_settings.rb.sample#L13
|
|
|
|
#### Init script
|
|
|
|
There might be new configuration options available for [`gitlab.default.example`][gl-example]. View them with the command below and apply them manually to your current `/etc/default/gitlab`:
|
|
|
|
```sh
|
|
cd /home/git/gitlab
|
|
|
|
git diff origin/9-0-stable:lib/support/init.d/gitlab.default.example origin/9-1-stable:lib/support/init.d/gitlab.default.example
|
|
```
|
|
|
|
Ensure you're still up-to-date with the latest init script changes:
|
|
|
|
```bash
|
|
cd /home/git/gitlab
|
|
|
|
sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
|
|
```
|
|
|
|
For Ubuntu 16.04.1 LTS:
|
|
|
|
```bash
|
|
sudo systemctl daemon-reload
|
|
```
|
|
|
|
### 9. Install libs, migrations, etc.
|
|
|
|
GitLab 9.1.8 [introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/24570)
|
|
a dependency on the `re2` regular expression library. To install this dependency:
|
|
|
|
```bash
|
|
sudo apt-get install libre2-dev
|
|
```
|
|
|
|
Ubuntu 14.04 (Trusty Tahr) doesn't have the `libre2-dev` package available, but
|
|
you can [install re2 manually](https://github.com/google/re2/wiki/Install).
|
|
|
|
```bash
|
|
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
|
|
|
|
# Update node dependencies and recompile assets
|
|
sudo -u git -H bundle exec rake yarn:install gitlab:assets:clean gitlab:assets:compile RAILS_ENV=production NODE_ENV=production
|
|
|
|
# Clean up cache
|
|
sudo -u git -H bundle exec rake cache:clear RAILS_ENV=production
|
|
```
|
|
|
|
**MySQL installations**: Run through the `MySQL strings limits` and `Tables and data conversion to utf8mb4` [tasks](../install/database_mysql.md).
|
|
|
|
### 10. Optional: install Gitaly
|
|
|
|
Gitaly is still an optional component of GitLab. If you want to save time
|
|
during your 9.1 upgrade **you can skip this step**.
|
|
|
|
If you have not yet set up Gitaly then follow [Gitaly section of the installation
|
|
guide](../install/installation.md#install-gitaly).
|
|
|
|
If you installed Gitaly in GitLab 9.0 you need to make some changes in
|
|
gitlab.yml, and create a new config.toml file.
|
|
|
|
#### Gitaly gitlab.yml changes
|
|
|
|
Look for `socket_path:` the `gitaly:` section. Its value is usually
|
|
`/home/git/gitlab/tmp/sockets/private/gitaly.socket`. Note what socket
|
|
path your gitlab.yml is using. Now go to the `repositories:` section,
|
|
and for each entry under `storages:`, add a `gitaly_address:` based on
|
|
the socket path, but with `unix:` in front.
|
|
|
|
```yaml
|
|
repositories:
|
|
storages:
|
|
default:
|
|
path: /home/git/repositories
|
|
gitaly_address: unix:/home/git/gitlab/tmp/sockets/private/gitaly.socket
|
|
other_storage:
|
|
path: /home/git/other-repositories
|
|
gitaly_address: unix:/home/git/gitlab/tmp/sockets/private/gitaly.socket
|
|
```
|
|
|
|
Each entry under `storages:` should use the same `gitaly_address`.
|
|
|
|
#### Compile Gitaly
|
|
|
|
This step will also create `config.toml.example` which you need below.
|
|
|
|
```shell
|
|
cd /home/git/gitaly
|
|
sudo -u git -H git fetch --all --tags
|
|
sudo -u git -H git checkout v$(</home/git/gitlab/GITALY_SERVER_VERSION)
|
|
sudo -u git -H make
|
|
```
|
|
|
|
#### Gitaly config.toml
|
|
|
|
In GitLab 9.1 we are replacing environment variables in Gitaly with a
|
|
TOML configuration file.
|
|
|
|
```shell
|
|
cd /home/git/gitaly
|
|
|
|
sudo mv env env.old
|
|
sudo -u git cp config.toml.example config.toml
|
|
# If you are using custom repository storage paths they need to be in config.toml
|
|
sudo -u git -H editor config.toml
|
|
```
|
|
|
|
### 11. Start application
|
|
|
|
```bash
|
|
sudo service gitlab start
|
|
sudo service nginx restart
|
|
```
|
|
|
|
### 12. Check application status
|
|
|
|
Check if GitLab and its environment are configured correctly:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
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 (9.0)
|
|
|
|
### 1. Revert the code to the previous version
|
|
|
|
Follow the [upgrade guide from 8.17 to 9.0](8.17-to-9.0.md), except for the
|
|
database migration (the backup is already migrated to the previous version).
|
|
|
|
### 2. Restore from the backup
|
|
|
|
```bash
|
|
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.
|
|
|
|
[yaml]: https://gitlab.com/gitlab-org/gitlab-ce/blob/9-1-stable/config/gitlab.yml.example
|
|
[gl-example]: https://gitlab.com/gitlab-org/gitlab-ce/blob/9-1-stable/lib/support/init.d/gitlab.default.example
|