GitLab Version Check is a suite of UI elements focused on communicating to instance admins the status of their current instance's version. The status is communicated through various elements depending on how critical the version they are behind is.
This badge element is always visible and communicates the GitLab instance version in relation to the upgrades available.
|Up to date||Update available||Update ASAP|
When to appear
This Modal element is only visible when a GitLab instance is behind a security upgrade that could make the instance vulnerable. This modal appears and forces a interaction before going away. Depending on how verbose the upgrade notes are, the modal can appear with various levels of details. Additionally, when it appears, the admin is faced with a choice. Regardless of the choice made, the modal will be hidden and set to reappear in 3 days.
|No Stable Versions or Details||Stable Versions but no Details||Both Stable Versions and Details|
When to appear
dangerlevel upgrade, always and dismissible for 3 day periods
In the past we used to provide the version check to the UI through an API call that you could see in your Network tab. This has changed and is now provided to the UI through Rails.
The current architecture is a bit complicated due to the nature of the
ReactiveCaching mechanism we are using. This cache is powered by Sidekiq and is executed through Background Jobs (
/admin/background_jobs) with the goal of housing and rehydrating your instance's version status. We have an aggressive caching mechanism due to the nature of this data being fetched from an external endpoint and being needed throughout the GitLab application.
We have an exploration started into transitioning to Cron with a more traditional caching approach.
Below is a visual representation of how Version Check is managed behind the scenes:
The request contains information about the browser, the GitLab version and the HTTP referrer. The HTTP referrer is the URL from which the request was sent. So it is the URL of the help page or the admin area page of the admin's GitLab instance. E.g. if you visit the help page on gitlab.com the HTTP referrer is https://gitlab.com/help. Furthermore the browser has to send the IP address of the instance combined with the request to receive a response. The IP address won't be saved.
Version.gitlab.com collects all browser requests mentioned above and adds them to a database. It saves the HTTP referrer URL, the current GitLab version, the timestamp of the request and information about the browser. As mentioned above it does not save IP addresses.
This information provides better insights into where and how GitLab is used and helps us to improve GitLab for everyone, for example by seeing which versions are popular and require a backport of a security fix.
Only the GitLab team has access to version.gitlab.com.
The HTTP referrer can contain the local or public hostname or IP address of a GitLab instance. It depends on how the admin accessed the GitLab web interface. Local hostnames and local IP addresses are only relevant and reachable within the local network in which the instance is running. Therefore local hostnames can be named anything, for example 'myownGitLab'. Public hostnames or IP addresses can contain information about the owner of the host network. For example if the HTTP referrer contains 'dev.gitlab.org' it is assumable that this instance is owned by GitLab.
Because an HTTP referrer can be easily spoofed and because a local hostname can be named anything, it is impossible to be completely sure if any derived information is actually valid.
By hitting the
/admin/version_check.json endpoint you can see if there is cached data and what is being provided to the UI through Rails.
If the response is
null there are few steps you can take:
/admin/background_jobs, you can look into what jobs are scheduled/running/pending on your instance.
The job you will be looking for is called
If the internal API is returning
null or the upgrade badge is missing:
GitLab Version Check can be disabled via the Metrics and Profiling tab of the GitLab Admin Settings.
You can find the checkbox labeled "Enable version check" at "/admin/application_settings/metrics_and_profiling" in the Usage Statistics section.