Commit 42bf1f22 authored by Craig Norris's avatar Craig Norris

Merge branch 'ap-btree' into 'master'

Specify the required postgres extensions

See merge request gitlab-org/gitlab!56097
parents 240e5186 48856955
...@@ -9,8 +9,12 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -9,8 +9,12 @@ info: To determine the technical writer assigned to the Stage/Group associated w
This guide documents how to manage PostgreSQL extensions for installations with an external This guide documents how to manage PostgreSQL extensions for installations with an external
PostgreSQL database. PostgreSQL database.
GitLab requires certain extensions to be installed into the GitLab database. For example, The following extensions must be loaded into the GitLab database:
GitLab relies on `pg_trgm` and the `btree_gist` extensions.
| Extension | Minimum GitLab version |
|--------------|------------------------|
| `pg_trgm` | 8.6 |
| `btree_gist` | 13.1 |
In order to install extensions, PostgreSQL requires the user to have superuser privileges. In order to install extensions, PostgreSQL requires the user to have superuser privileges.
Typically, the GitLab database user is not a superuser. Therefore, regular database migrations Typically, the GitLab database user is not a superuser. Therefore, regular database migrations
......
...@@ -152,18 +152,24 @@ MySQL/MariaDB are advised to [migrate to PostgreSQL](../update/mysql_to_postgres ...@@ -152,18 +152,24 @@ MySQL/MariaDB are advised to [migrate to PostgreSQL](../update/mysql_to_postgres
The server running PostgreSQL should have _at least_ 5-10 GB of storage The server running PostgreSQL should have _at least_ 5-10 GB of storage
available, though the exact requirements [depend on the number of users](../administration/reference_architectures/index.md). available, though the exact requirements [depend on the number of users](../administration/reference_architectures/index.md).
We highly recommend users to use the minimum PostgreSQL versions specified below as these are the versions used for development and testing. We highly recommend using the minimum PostgreSQL versions (as specified in
the following table) as these were used for development and testing:
GitLab version | Minimum PostgreSQL version | GitLab version | Minimum PostgreSQL version |
-|- |----------------|----------------------------|
10.0 | 9.6 | 10.0 | 9.6 |
13.0 | 11 | 13.0 | 11 |
You must also ensure the `pg_trgm` and `btree_gist` extensions are [loaded into every You must also ensure the following extensions are [loaded into every
GitLab database](postgresql_extensions.html). GitLab database](postgresql_extensions.html):
| Extension | Minimum GitLab version |
| ------------ | ---------------------- |
| `pg_trgm` | 8.6 |
| `btree_gist` | 13.1 |
NOTE: NOTE:
Support for [PostgreSQL 9.6 and 10 has been removed in GitLab 13.0](https://about.gitlab.com/releases/2020/05/22/gitlab-13-0-released/#postgresql-11-is-now-the-minimum-required-version-to-install-gitlab) so that GitLab can benefit from PostgreSQL 11 improvements, such as partitioning. For the schedule of transitioning to PostgreSQL 12, see [the related epic](https://gitlab.com/groups/gitlab-org/-/epics/2184). Support for [PostgreSQL 9.6 and 10 was removed in GitLab 13.0](https://about.gitlab.com/releases/2020/05/22/gitlab-13-0-released/#postgresql-11-is-now-the-minimum-required-version-to-install-gitlab) so that GitLab can benefit from PostgreSQL 11 improvements, such as partitioning. For the schedule of transitioning to PostgreSQL 12, see [the related epic](https://gitlab.com/groups/gitlab-org/-/epics/2184).
#### Additional requirements for GitLab Geo #### Additional requirements for GitLab Geo
......
...@@ -167,9 +167,12 @@ sudo make prefix=/usr/local install ...@@ -167,9 +167,12 @@ sudo make prefix=/usr/local install
WARNING: WARNING:
From GitLab 13.0, you must use at least PostgreSQL 11. From GitLab 13.0, you must use at least PostgreSQL 11.
The latest version of GitLab might depend on a more recent PostgreSQL version than what you are currently running (see the [PostgreSQL requirements](../install/requirements.md#postgresql-requirements)). The latest version of GitLab might depend on a more recent PostgreSQL version
than what you're currently running. You may also need to enable some
extensions. For more information, see the
[PostgreSQL requirements](../install/requirements.md#postgresql-requirements)
In order to upgrade PostgreSQL, please refer to its [documentation](https://www.postgresql.org/docs/11/upgrading.html). To upgrade PostgreSQL, refer to its [documentation](https://www.postgresql.org/docs/11/upgrading.html).
### 8. Get latest code ### 8. Get latest code
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment