221 lines
6.8 KiB
Markdown
221 lines
6.8 KiB
Markdown
## Migrate GitLab CI to GitLab CE or EE
|
|
|
|
Beginning with version 8.0 of GitLab Community Edition (CE) and Enterprise
|
|
Edition (EE), GitLab CI is no longer its own application, but is instead built
|
|
into the CE and EE applications.
|
|
|
|
This guide will detail the process of migrating your CI installation and data
|
|
into your GitLab CE or EE installation.
|
|
|
|
### Before we begin
|
|
|
|
**You need to have a working installation of GitLab CI version 8.0 to perform
|
|
this migration. The older versions are not supported and will most likely break
|
|
this migration procedure.**
|
|
|
|
This migration cannot be performed online and takes a significant amount of
|
|
time. Make sure to plan ahead.
|
|
|
|
If you are running a version of GitLab CI prior to 8.0 please follow the
|
|
appropriate [update guide](https://gitlab.com/gitlab-org/gitlab-ci/tree/master/doc/update/).
|
|
|
|
The migration is divided into three parts:
|
|
|
|
1. [GitLab CI](#part-i-gitlab-ci)
|
|
1. [Gitlab CE (or EE)](#part-ii-gitlab-ce-or-ee)
|
|
1. [Finishing Up](#part-iii-finishing-up)
|
|
|
|
### Part I: GitLab CI
|
|
|
|
#### 1. Stop GitLab CI
|
|
|
|
sudo service gitlab_ci stop
|
|
|
|
#### 2. Create a backup
|
|
|
|
The migration procedure modifies the structure of the CI database. If something
|
|
goes wrong, you will not be able to revert to a previous version without a
|
|
backup.
|
|
|
|
If your GitLab CI installation uses **MySQL** and your GitLab CE (or EE)
|
|
installation uses **PostgreSQL** you'll need to convert the CI database by
|
|
setting a `MYSQL_TO_POSTGRESQL` flag.
|
|
|
|
You can check which database each install is using by viewing their
|
|
database configuration files:
|
|
|
|
```sh
|
|
cat /home/gitlab_ci/gitlab-ci/config/database.yml
|
|
cat /home/git/gitlab/config/database.yml
|
|
```
|
|
|
|
- If both applications use the same database `adapter`, create the backup with
|
|
this command:
|
|
|
|
```bash
|
|
cd /home/gitlab_ci/gitlab-ci
|
|
sudo -u gitlab_ci -H bundle exec backup:create RAILS_ENV=production
|
|
```
|
|
|
|
- If CI uses MySQL, and CE (or EE) uses PostgreSQL, create the backup with this
|
|
command (note the `MYSQL_TO_POSTGRESQL` flag):
|
|
|
|
|
|
```bash
|
|
cd /home/gitlab_ci/gitlab-ci
|
|
sudo -u gitlab_ci -H bundle exec backup:create RAILS_ENV=production MYSQL_TO_POSTGRESQL=1
|
|
```
|
|
|
|
#### 3. Remove cronjob
|
|
|
|
```
|
|
cd /home/gitlab_ci/gitlab-ci
|
|
sudo -u gitlab_ci -H bundle exec whenever --clear-crontab
|
|
```
|
|
|
|
### Part II: GitLab CE (or EE)
|
|
|
|
#### 1. Ensure GitLab is updated
|
|
|
|
Your GitLab CE or EE installation **must be version 8.0**. If it's not, follow
|
|
the [update guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/update/7.14-to-8.0.md).
|
|
|
|
#### 2. Stop GitLab
|
|
|
|
Before you can migrate data you need to stop the GitLab service first:
|
|
|
|
sudo service gitlab stop
|
|
|
|
#### 3. Create a backup
|
|
|
|
This migration poses a **significant risk** of breaking your GitLab
|
|
installation. Create a backup before proceeding:
|
|
|
|
cd /home/git/gitlab
|
|
sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production
|
|
|
|
#### 4. Copy secret tokens from CI
|
|
|
|
The `secrets.yml` file stores encryption keys for secure variables.
|
|
|
|
You need to copy the contents of GitLab CI's `config/secrets.yml` file to the
|
|
same file in GitLab CE:
|
|
|
|
sudo cp /home/gitlab_ci/gitlab-ci/config/secrets.yml /home/git/gitlab/config/secrets.yml
|
|
sudo chown git:git /home/git/gitlab/config/secrets.yml
|
|
sudo chown 0600 /home/git/gitlab/config/secrets.yml
|
|
|
|
#### 5. 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`:
|
|
|
|
git diff origin/7-14-stable:config/gitlab.yml.example origin/8-0-stable:config/gitlab.yml.example
|
|
|
|
The new options include configuration settings for GitLab CI.
|
|
|
|
#### 6. Copy backup from GitLab CI
|
|
|
|
sudo cp -v /home/gitlab_ci/gitlab-ci/tmp/backups/*_gitlab_ci_backup.tar /home/git/gitlab/tmp/backups
|
|
sudo chown git:git /home/git/gitlab/tmp/backups/*_gitlab_ci_backup.tar
|
|
|
|
#### 7. Import GitLab CI backup
|
|
|
|
Now you'll import the GitLab CI database dump that you created earlier into the
|
|
GitLab CE or EE database:
|
|
|
|
sudo -u git -H bundle exec rake ci:migrate RAILS_ENV=production
|
|
|
|
This task will take some time.
|
|
|
|
#### 8. Start GitLab
|
|
|
|
You can start GitLab CE (or EE) now and see if everything is working:
|
|
|
|
sudo service gitlab start
|
|
|
|
### Part III: Finishing Up
|
|
|
|
#### 1. Update Nginx configuration
|
|
|
|
To ensure that your existing CI runners are able to communicate with the
|
|
migrated installation, and that existing build triggers still work, you'll need
|
|
to update your Nginx configuration to redirect requests for the old locations to
|
|
the new ones.
|
|
|
|
Edit `/etc/nginx/sites-available/gitlab_ci` and paste:
|
|
|
|
```nginx
|
|
# GITLAB CI
|
|
server {
|
|
listen 80 default_server; # e.g., listen 192.168.1.1:80;
|
|
server_name YOUR_CI_SERVER_FQDN; # e.g., server_name source.example.com;
|
|
|
|
access_log /var/log/nginx/gitlab_ci_access.log;
|
|
error_log /var/log/nginx/gitlab_ci_error.log;
|
|
|
|
# expose API to fix runners
|
|
location /api {
|
|
proxy_read_timeout 300;
|
|
proxy_connect_timeout 300;
|
|
proxy_redirect off;
|
|
proxy_set_header X-Real-IP $remote_addr;
|
|
|
|
# You need to specify your DNS servers that are able to resolve YOUR_GITLAB_SERVER_FQDN
|
|
resolver 8.8.8.8 8.8.4.4;
|
|
proxy_pass $scheme://YOUR_GITLAB_SERVER_FQDN/ci$request_uri;
|
|
}
|
|
|
|
# expose build endpoint to allow trigger builds
|
|
location ~ ^/projects/\d+/build$ {
|
|
proxy_read_timeout 300;
|
|
proxy_connect_timeout 300;
|
|
proxy_redirect off;
|
|
proxy_set_header X-Real-IP $remote_addr;
|
|
|
|
# You need to specify your DNS servers that are able to resolve YOUR_GITLAB_SERVER_FQDN
|
|
resolver 8.8.8.8 8.8.4.4;
|
|
proxy_pass $scheme://YOUR_GITLAB_SERVER_FQDN/ci$request_uri;
|
|
}
|
|
|
|
# redirect all other CI requests
|
|
location / {
|
|
return 301 $scheme://YOUR_GITLAB_SERVER_FQDN/ci$request_uri;
|
|
}
|
|
|
|
# adjust this to match the largest build log your runners might submit,
|
|
# set to 0 to disable limit
|
|
client_max_body_size 10m;
|
|
}
|
|
```
|
|
|
|
Make sure you substitute these placeholder values with your real ones:
|
|
|
|
1. `YOUR_CI_SERVER_FQDN`: The existing public-facing address of your GitLab CI
|
|
install (e.g., `ci.gitlab.com`).
|
|
1. `YOUR_GITLAB_SERVER_FQDN`: The current public-facing address of your GitLab
|
|
CE (or EE) install (e.g., `gitlab.com`).
|
|
|
|
**Make sure not to remove the `/ci$request_uri` part. This is required to
|
|
properly forward the requests.**
|
|
|
|
You should also make sure that you can:
|
|
|
|
1. `curl https://YOUR_GITLAB_SERVER_FQDN/` from your previous GitLab CI server.
|
|
1. `curl https://YOUR_CI_SERVER_FQDN/` from your GitLab CE (or EE) server.
|
|
|
|
#### 2. Check Nginx configuration
|
|
|
|
sudo nginx -t
|
|
|
|
#### 3. Restart Nginx
|
|
|
|
sudo /etc/init.d/nginx restart
|
|
|
|
#### 4. Done!
|
|
|
|
If everything went well you should be able to access your migrated CI install by
|
|
visiting `https://gitlab.example.com/ci/`. If you visit the old GitLab CI
|
|
address, you should be redirected to the new one.
|
|
|
|
**Enjoy!**
|