diff --git a/doc/settings/configuration.md b/doc/settings/configuration.md index 8378f87cf3192983bd39a520bed313212f7b4431_ZG9jL3NldHRpbmdzL2NvbmZpZ3VyYXRpb24ubWQ=..0eadf7a7b6603d4e2c9c56f2ea9b1929329eaae0_ZG9jL3NldHRpbmdzL2NvbmZpZ3VyYXRpb24ubWQ= 100644 --- a/doc/settings/configuration.md +++ b/doc/settings/configuration.md @@ -260,7 +260,7 @@ gitlab-psql # Prometheus user for prometheus monitoring and various exporters -prometheus +gitlab-prometheus # GitLab Mattermost user (only when using GitLab Mattermost) mattermost @@ -264,6 +264,9 @@ # GitLab Mattermost user (only when using GitLab Mattermost) mattermost + +# GitLab Registry user (only when using GitLab Registry) +registry ``` By default, omnibus-gitlab package expects that following groups exist: @@ -280,4 +283,5 @@ # Postgresql group (only when using packaged Postgresql) gitlab-psql + # Prometheus user for prometheus monitoring and various exporters @@ -283,5 +287,5 @@ # Prometheus user for prometheus monitoring and various exporters -prometheus +gitlab-prometheus # GitLab Mattermost group (only when using GitLab Mattermost) mattermost @@ -285,6 +289,9 @@ # GitLab Mattermost group (only when using GitLab Mattermost) mattermost + +# GitLab Registry group (only when using GitLab Registry) +registry ``` You can also use different user/group names but then you must specify user/group details in `/etc/gitlab/gitlab.rb`, eg. @@ -366,6 +373,7 @@ | `/var/opt/gitlab/gitlab-rails/uploads` | 0700 | git:root | Holds user attachments | | `/var/opt/gitlab/gitlab-rails/shared/pages` | 0750 | git:gitlab-www | Holds user pages | | `/var/opt/gitlab/gitlab-ci/builds` | 0700 | git:root | Holds CI build logs | +| `/var/opt/gitlab/.ssh` | 0700 | git:git | Holds authorized keys | @@ -382,6 +390,35 @@ Run `sudo gitlab-ctl reconfigure` for the change to take effect. +## Configuring runtime directory + +When Prometheus monitoring is enabled, GitLab-monitor will conduct measurements +of each Unicorn process (Rails metrics). Every Unicorn process will need to write +a metrics file to a temporary location for each controller request. +Prometheus will then collect all these files and process their values. + +In order to avoid creating disk I/O, the omnibus-gitlab package will use a +runtime directory. + +During `reconfigure`, package will check if `/run` is a `tmpfs` mount. +If it is not, warning will be printed: + +``` +Runtime directory '/run' is not a tmpfs mount. +``` + +and Rails metrics will be disabled. + +To enable Rails metrics again, create a `tmpfs` mount and specify it in `/etc/gitlab/gitlab.rb`: + +``` +runtime_dir '/path/to/tmpfs' +``` + +*Please note that there is no `=` in the configuration.* + +Run `sudo gitlab-ctl reconfigure` for the settings to take effect. + ## Configuring Rack Attack To prevent abusive clients doing damage GitLab uses rack-attack gem.