BigW Consortium Gitlab

5.1-to-6.0.md 7.57 KB
Newer Older
1
# From 5.1 to 6.0
2
*Make sure you view this [upgrade guide from the `master` branch](../../../master/doc/update/5.1-to-6.0.md) for the most up to date instructions.*
3

4
## Warning
5

6
GitLab 6.0 is affected by critical security vulnerabilities CVE-2013-4490 and CVE-2013-4489.
7

8
## Deprecations
9

10
### Global projects
11 12 13

The root (global) namespace for projects is deprecated.

14 15 16
So you need to move all your global projects under groups or users manually before update or they will be automatically moved to the project owner namespace during the update. When a project is moved all its members will receive an email with instructions how to update their git remote URL. Please make sure you disable sending email when you do a test of the upgrade.

### Teams
17 18

We introduce group membership in 6.0 as a replacement for teams.
19

20
The old combination of groups and teams was confusing for a lot of people.
21

22
And when the members of a team where changed this wasn't reflected in the project permissions.
23

24
In GitLab 6.0 you will be able to add members to a group with a permission level for each member.
25

26
These group members will have access to the projects in that group.
27

28
Any changes to group members will immediately be reflected in the project permissions.
29

30 31
You can even have multiple owners for a group, greatly simplifying administration.

32
## 0. Backup & prepare for update
33 34 35 36 37 38 39 40 41

It's useful to make a backup just in case things go south:
(With MySQL, this may require granting "LOCK TABLES" privileges to the GitLab user on the database version)

```bash
cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production
```

42 43
The migrations in this update are very sensitive to incomplete or inconsistent data. If you have a long-running GitLab installation and some of the previous upgrades did not work out 100% correct this may bite you now. The following can help you have a more smooth upgrade.

44
### Find projects with invalid project names
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

#### MySQL
Login to MySQL:

    mysql -u root -p

Find projects with invalid names:

```bash
mysql> use gitlabhq_production;

# find projects with invalid first char, projects must start with letter
mysql> select name from projects where name REGEXP '^[^A-Za-z]';

# find projects with other invalid chars
## names must only contain alphanumeric chars, underscores, spaces, periods, and dashes
mysql> select name from projects where name REGEXP '[^a-zA-Z0-9_ .-]+';
```

If any projects have invalid names try correcting them from the web interface before starting the upgrade.
If correcting them from the web interface fails you can correct them using MySQL:

```bash
# e.g. replace invalid / with allowed _
mysql> update projects set name = REPLACE(name,'/','_');
# repeat for all invalid chars found in project names
```

#### PostgreSQL
Make sure all project names start with a letter and only contain alphanumeric chars, underscores, spaces, periods, and dashes (a-zA-Z0-9_ .-).

### Find other common errors

```
cd /home/git/gitlab
# Start rails console
sudo -u git -H bin/rails console production

# Make sure none of the following rails commands return results

# All project owners should have an owner:
Project.all.select { |project| project.owner.blank? }

# Every user should have a namespace:
User.all.select { |u| u.namespace.blank? }

# Projects in the global namespace should not conflict with projects in the owner namespace:
Project.where(namespace_id: nil).select { |p| Project.where(path: p.path, namespace_id: p.owner.try(:namespace).try(:id)).present? }
```

If any of the above rails commands returned results other than `=> []` try correcting the issue from the web interface.

If you find projects without an owner (first rails command above), correct it. For MySQL setups:

```bash
# get your user id
mysql> select id, name from users order by name;

# set yourself as owner of project
# replace your_user_id with your user id and bad_project_id with the project id from the rails command
mysql> update projects set creator_id=your_user_id where id=bad_project_id;
```

108
## 1. Stop server
109 110 111

    sudo service gitlab stop

112
## 2. Get latest code
113 114 115 116 117 118 119

```bash
cd /home/git/gitlab
sudo -u git -H git fetch
sudo -u git -H git checkout 6-0-stable
```

120
## 3. Update gitlab-shell
121 122 123 124

```bash
cd /home/git/gitlab-shell
sudo -u git -H git fetch
125
sudo -u git -H git checkout v1.7.9
126 127
```

128
## 4. Install additional packages
129 130 131 132 133 134

```bash
# For reStructuredText markup language support install required package:
sudo apt-get install python-docutils
```

135
## 5. Install libs, migrations, etc.
136 137 138 139

```bash
cd /home/git/gitlab

140 141 142 143 144
# The Modernizr gem was yanked from RubyGems. It is required for GitLab >= 2.8.0
# Edit `Gemfile` and change `gem "modernizr", "2.5.3"` to
# `gem "modernizr-rails", "2.7.1"``
sudo -u git -H vim Gemfile

145
# MySQL
146 147 148 149 150

# Run a bundle install without deployment to generate the new Gemfile
sudo -u git -H bundle install --without development test postgres --no-deployment

# Install libs (with deployment this time)
151 152
sudo -u git -H bundle install --without development test postgres --deployment

153 154 155 156 157 158
# PostgreSQL

# Run a bundle install without deployment to generate the new Gemfile
sudo -u git -H bundle install --without development test mysql --no-deployment

# Install libs (with deployment this time)
159 160
sudo -u git -H bundle install --without development test mysql --deployment

161
# Both MySQL and PostgreSQL
162 163 164 165 166 167 168 169 170 171 172 173 174
sudo -u git -H bundle exec rake db:migrate RAILS_ENV=production
sudo -u git -H bundle exec rake migrate_groups RAILS_ENV=production
sudo -u git -H bundle exec rake migrate_global_projects RAILS_ENV=production
sudo -u git -H bundle exec rake migrate_keys RAILS_ENV=production
sudo -u git -H bundle exec rake migrate_inline_notes RAILS_ENV=production
sudo -u git -H bundle exec rake gitlab:satellites:create RAILS_ENV=production

# Clear redis cache
sudo -u git -H bundle exec rake cache:clear RAILS_ENV=production

# Clear and precompile assets
sudo -u git -H bundle exec rake assets:clean RAILS_ENV=production
sudo -u git -H bundle exec rake assets:precompile RAILS_ENV=production
175 176 177

#Add dealing with newlines for editor
sudo -u git -H git config --global core.autocrlf input
178 179
```

180
## 6. Update config files
181 182 183

Note: We switched from Puma in GitLab 5.x to unicorn in GitLab 6.0.

184 185
- Make `/home/git/gitlab/config/gitlab.yml` the same as https://gitlab.com/gitlab-org/gitlab-ce/blob/6-0-stable/config/gitlab.yml.example but with your settings.
- Make `/home/git/gitlab/config/unicorn.rb` the same as https://gitlab.com/gitlab-org/gitlab-ce/blob/6-0-stable/config/unicorn.rb.example but with your settings.
186

187
## 7. Update Init script
188 189 190 191

```bash
cd /home/git/gitlab
sudo rm /etc/init.d/gitlab
192
sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
193 194 195
sudo chmod +x /etc/init.d/gitlab
```

196
## 8. Create uploads directory
197 198 199 200 201 202 203

```bash
cd /home/git/gitlab
sudo -u git -H mkdir -p public/uploads
sudo chmod -R u+rwX  public/uploads
```

204
## 9. Start application
205 206 207 208

    sudo service gitlab start
    sudo service nginx restart

209
## 10. Check application status
210 211 212 213 214 215 216 217 218 219 220 221 222 223

Check if GitLab and its environment are configured correctly:

    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 with:

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

If all items are green, then congratulations upgrade complete!

## Things went south? Revert to previous version (5.1)

### 1. Revert the code to the previous version
224

225
Follow the [upgrade guide from 5.0 to 5.1](5.0-to-5.1.md), except for the database migration (the backup is already migrated to the previous version).
226 227 228 229 230 231 232

### 2. Restore from the backup:

```bash
cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:backup:restore RAILS_ENV=production
```