GitLab

From Gentoo Wiki
Jump to:navigation Jump to:search

The Gitlab overlay, originally the CVUT overlay, is currently on par with the latest GitLab version (14.0.1 as of June 2021). The repo and issues can be found here.

With version 13.8.3 the former www-apps/gitlabhq package was renamed to www-apps/gitlab. Since the gitlab core and gitlab-gitaly must neccessarily have the same version the former dev-vcs/gitlab-gitaly package was abandoned and gitlab-gitaly is now included in the www-apps/gitlab package.

By means of "Post Deployment Migrations" as described here starting with version 13.8.4 upgrading takes place without downtime (Nearly: The still required restart needs some time). This made the slots obsolete and so the upgrade procedure less complicated.

The migration from a www-apps/gitlabhq installation to a www-apps/gitlab one is supported by all www-apps/gitlab-13.8.x ebuilds. For more information read the 2021-02-10-gitlabhq-to-gitlab news message of the overlay.

Installation

The overlay may be added using either eselect repository or layman.

To add using eselect repository:

root #eselect repository enable gitlab
root #emerge --sync gitlab

To add using layman:

root #layman -a gitlab

GitLab requires the use of a database backend. Since version 12 PostgreSQL is the only supported database.

USE flags

USE flags www-apps/gitlab
U I
- - favicon       : For the Custom Favicon to work, GraphicsMagick needs to be installed
+ + gitaly_git    : Use the Git version provided by Gitaly 
- - gitlab-config : Config in /opt/gitlab/gitlab/config instead of /etc/gitlab (s. news 2021-02-22-etc-gitlab)
- - kerberos      : Add kerberos support
- - mail_room     : Enables support for GitLab MailRoom 
- - pages         : Pulls in the compatible version of www-apps/gitlab-pages
- - relative_url  : Support for relative url
+ + systemd       : Enable use of systemd-specific libraries and features like socket activation or session tracking

The gitaly-config USE flag is explained in the 2021-02-22-etc-gitlab news of the overlay (since version 13.11.4 its default changed to 'on', as recommended by upstream). The gitaly_git USE flag uses the bundled Git from gitlab-gitaly instead of dev-vcs/git. The former puma and unicorn USE flags were removed because with GitLab 14.0 Unicorn was removed by upstream and Puma is now the only supported web server. The systemd USE flag is preselected since the maintainer of the overlay ran out of OpenRC hosts for init script testing. :-) But with the help of some users of the overlay the OpenRC init scripts will be provided further on.

Preparations

Add the following keywords to be accepted by Portage (we use amd64 as architecture here; x86 is also available):

root #nano /etc/portage/package.accept_keywords/gitlab
www-apps/gitlab ~amd64
dev-vcs/gitlab-shell ~amd64

If you disable the gitaly-git USE flag you also have to keyword the required version of dev-vcs/git (>= 2.31.0 as of gitlab version 13.12.1) and unmask its pcre-jit USE flag:

root #nano /etc/portage/profile/package.use.mask
=dev-vcs/git-2.31* -pcre-jit

From GitLab 13.6 on Ruby 2.7 or later is required. Until Ruby 2.7 will be stabilized one must add further keywords to be accepted. As of January 2021 these were the following versions:

root #nano /etc/portage/package.accept_keywords/ruby27
=dev-lang/ruby-2.7.2 ~amd64
=dev-ruby/minitest-5.13.0 ~amd64
=dev-ruby/net-telnet-0.2.0 ~amd64
=dev-ruby/power_assert-1.1.7 ~amd64
=dev-ruby/rake-13.0.1 ~amd64
=dev-ruby/xmlrpc-0.3.0 ~amd64
=dev-ruby/rdoc-6.2.0 ~amd64
=dev-ruby/kpeg-1.1.0-r1 ~amd64
=virtual/rubygems-16 ~amd64
=dev-ruby/rubygems-3.1* ~amd64

The overlay overrides the gentoo acct-user/git package introducing a new USE flag gitlab which creates the git user as required by www-apps/gitlab with HOME in /var/lib/gitlab/ and as member in the redis group. Add the USE Flag:

root #echo "acct-user/git gitlab" >> /etc/portage/package.use/gitlab

Emerge

Next emerge the package and follow the instructions given on the output (here the output of a 13.8.4 installation for an example).

root #emerge -av gitlab
...
* For this new installation, proceed with the following steps:
*
*   1. Create a database user for GitLab.
*      On your database server (local ore remote) become user postgres:
*        su -l postgres
*      GitLab needs two PostgreSQL extensions: pg_trgm and btree_gist.
*      To create the extensions if they are missing do:
*        psql -d template1 -c "CREATE EXTENSION IF NOT EXISTS pg_trgm;"
*        psql -d template1 -c "CREATE EXTENSION IF NOT EXISTS btree_gist;"
*      Create the database user:
*        psql -c "CREATE USER gitlab CREATEDB PASSWORD 'gitlab'"
*      Note: You should change your password to something more random ...
*      You may need to add configs for the new 'gitlab' user to the
*      pg_hba.conf and pg_ident.conf files of your database server.
*
*   2. Edit /etc/gitlab/database.yml in order to configure
*      database settings for "production" environment.
*
*   3. Edit /etc/gitlab/gitlab.yml
*      in order to configure your GitLab settings.
*
*      With gitaly_git USE flag enabled the included git was installed to
*      /opt/gitlab/gitlab-gitaly/bin/. In order to use it one has to set the
*      [git] "bin_path" variable in "/etc/gitlab-gitaly/config.toml" and in
*      "/etc/gitlab/gitlab.yml" to "/opt/gitlab/gitlab-gitaly/bin/git"
*
*      GitLab expects the parent directory of the config files to
*      be its base directory, so you have to sync changes made in
*      /etc/gitlab/ back to /opt/gitlab/gitlab/config/ by running
*      This is done automatically on start/restart of gitlab
*      but sometimes it is neccessary to do it manually by
*        rsync -aHAX /etc/gitlab/ /opt/gitlab/gitlab/config/
*
*   4. You need to configure redis to have a UNIX socket and you may
*      adjust the maxmemory settings. Change /etc/redis.conf to
*        unixsocket /var/run/redis/redis.sock
*        unixsocketperm 770
*        maxmemory 1024MB
*        maxmemory-policy volatile-lru
*
*   5. Gitaly must be running for the "emerge --config". Execute
*          systemctl start gitlab-update-config.service
*          systemctl --job-mode=ignore-dependencies start gitlab-gitaly.service
*      Make sure the Redis server is running and execute:
*          emerge --config "=www-apps/gitlab-14.0.1"

Work through the list. Note that the database you specify in /etc/gitlab/database.yml will be deleted by the "Initializing database" step below! Finally run the configuration script (again with an example output).

root #emerge --config "=www-apps/gitlab-14.0.1"
...
Configuring pkg...
* Checking configuration files ...
* Set the Administrator/root password:  *********
* Set the Administrator/root email: gitlab@theomail.informatik.uni-stuttgart.de
* Initializing database ...
This will create the necessary database tables and seed the database.
You will lose any previous data stored in the database.
Do you want to continue (yes/no)? yes
... (messages from the database creation and initialization)
*
* Now start gitlab with
* $ systemctl start gitlab.target
*
* You might want to check your application status. Run this:
* $ cd /opt/gitlab/gitlab
* $ sudo -u git ruby /usr/bin/bundle exec rake gitlab:check RAILS_ENV=production
*
* GitLab is prepared now.
* To configure your nginx site have a look at the examples configurations
* in the /opt/gitlab/gitlab/lib/support/nginx/ folder.

The Administrator password and email are used for the initial administrator account of the GitLab web application. In the above omitted "messages from the database creation and initialization" you'll find the login and password for this account. You should use a working email address as on startup GitLab will send an "Access to the GitLab Instance group was granted" mail to this address.

Now copy the nginx example configs you need (at least gitlab-ssl plus gitlab-pages-ssl if you use pages) from /opt/gitlab/gitlab/lib/support/nginx/ to /etc/nginx/sites/ and adopt them your setup.

Finally start Nginx and GitLab, log in with the administrator account and adopt the default settings to your need.

Configuration

Files

GitLab expects the parent directory of the config files to be its base directory, so the config has to stay in /opt/gitlab/gitlab/config/. Symlinking /opt/gitlab/gitlab/config -> /etc/gitlab doesn't work as GitLab uses the real path of the config files to get the parent directory. In order to use the standard Gentoo way of managing config files, the config files are copied to /etc/gitlab/ where you edit them and then synced back to /opt/gitlab/gitlab/config/ by running:

root #rsync -aHAX /etc/gitlab/ /opt/gitlab/gitlab/config/
Note
Note that the trailing slashes are important here!

This rsync command is run automatically on start/restart of Gitlab. Only before the emerge --config of the first installation you have run this manually as GitLab does not run then but the emerge --config needs the up-to-date config. The rsync command updates only those config files in /opt/gitlab/gitlab/config/ that exist in /etc/gitlab/, so it suffices to have only the changed ones in /etc/gitlab/.

When the gitlab-config USE flag is set /etc/gitlab/ isn't used and you'll have to edit the files in /opt/gitlab/gitlab/config/ directly.

Service

OpenRC

Starting gitlab:

root #rc-service gitlab start

Current status:

root #rc-service gitlab status

Starting automatically at system boot:

root #rc-update add gitlab default

systemd

Starting gitlab:

root #systemctl start gitlab.target

Current status:

root #systemctl list-dependencies gitlab.target

Starting automatically at system boot:

root #systemctl enable gitlab.target

Testing

Diagnostics

Run this command to get a full diagnostic.

git #cd /opt/gitlab/gitlab
git #bundle exec rake gitlab:env:info RAILS_ENV=production
git #bundle exec rake gitlab:check RAILS_ENV=production

Usage

NGINX is the oficially supported webserver for GitLab. If you cannot or do not want to use NGINX as your web server, see GitLab recipes. You have to set up a sites config for GitLab. See /opt/gitlab/gitlab/lib/support/nginx/gitlab-ssl for an example site configuration.

The web interface is available at the URL you configured in /etc/gitlab/gitlab.yml:

  ## GitLab settings
  gitlab:
    ## Web server settings (note: host is the FQDN, do not include http://)
    host: gitlab.<your-domain>
    port: 443 # Set to 443 if using HTTPS, see installation.md#using-https for additional HTTPS configuration details
    https: true # Set to true if using HTTPS, see installation.md#using-https for additional HTTPS configuration details

With the above the URL would be https://gitlab.<your-domain>.

Upgrade

Warning
Upstream removed several deprecated features in the annual major release 14.0.0. It is strongly advised to work through the upstream website about "information about deprecations and removals for self-managed instances" at https://about.gitlab.com/releases/2021/05/22/gitlab-13-12-released/#release-deprecations before upgrading to version 14!
Warning
It should be especially pointed out that as announced in GitLab 13.0 legacy storage is deprecated and will be removed in GitLab 14.0. Before upgrading to GitLab 14.0 you must migrate fully to hashed storage!

The www-apps/gitlab ebuild will check if one is on a supported "Upgrade path" (see the upstream update README) to ensure that the requirements for "Upgrading without downtime" are met. The upgrade steps are:

root #emerge -u gitlab
...
* Migrating database without post deployment migrations ...
*
* Update the config in /etc/gitlab and then run
*      systemctl restart gitlab.target
*
* To complete the upgrade of your GitLab instance, run:
*     emerge --config "=www-apps/gitlab-14.0.1"
*
*
* Note: With gitaly_git USE flag enabled the included git was installed to
*       /opt/gitlab/gitlab-gitaly/bin/. In order to use it one has to set the
*       [git] "bin_path" variable in "/etc/gitlab-gitaly/config.toml" and in
*       "/etc/gitlab/gitlab.yml" to "/opt/gitlab/gitlab-gitaly/bin/git"

If there are config updates (there were none in the above example output), do an etc-update before the restart:

root #etc-update
root #systemctl daemon-reload
root #systemctl restart gitlab.target

Then do the database migrations with post deployment migrations by executing:

root #emerge --config "=www-apps/gitlab-14.0.1"
Configuring pkg...
* Migrating database ...
* Clean up cache ...
* Configure Git to enable packfile bitmaps ...
*
* You might want to check your application status. Run this:
* $ cd /opt/gitlab/gitlab
* $ sudo -u git ruby /usr/bin/bundle exec rake gitlab:check RAILS_ENV=production
*
* GitLab is prepared now.
* Ensure you're still up-to-date with the latest NGINX configuration changes:
* $ cd /opt/gitlab/gitlab
* $ git -P diff v14.0.0:lib/support/nginx/ v14.0.1:lib/support/nginx/

If the git -P diff ... command shows any differences in the nginx config examples you should merge the updates into your nginx config and restart nginx.

External Resources