External PostgreSQL database

This document assumes you already have your own PostgreSQL database.

If you do not have one, consider a cloud provided solution like AWS RDS PostgreSQL or GCP Cloud SQL. For on-premise or deployment to VM, consider our Omnibus GitLab package.

External database requirements

To use an external database with the gitlab chart, there are a few prerequisites.

  1. GitLab requires PostgreSQL 11.x or newer
  2. An empty database to use, named by default: gitlabhq_production. See below how to change the default name.
  3. The pg_trgm and btree_gist extensions must be available. GitLab will attempt to load both extensions if not present. If not providing an account with Superuser flag to GitLab, please ensure this extension is loaded prior to proceeding with the database installation.
  4. A user with full access granted to the database above as described in our general external database docs.
  5. A Kubernetes Secret with the password for the user above.
  6. Ensure that the database is reachable from the cluster. Be sure firewall policies are in place to allow traffic.
noteThe pg_trgm and btree_gist extensions need to be added to the GitLab database. This means that the CREATE EXTENSION command should be executed while connected to the GitLab database (by default named gitlabhq_production) and not the PostgreSQL default database.

If planning to use PostgreSQL as a load balancing cluster and using Kubernetes DNS for service discovery, then when installing the bitnami/postgresql chart it is recommended to install the chart with --set slave.service.clusterIP=None. This will properly setup the PostgreSQL secondary service as a headless service to allow DNS A records to be created for each secondary instance. Please examine the file examples/database/values-loadbalancing-discover.yaml for an example of using Kubernetes DNS for service discovery.

Configuring gitlab to use an external database

You need to set the following parameters:

  • postgresql.install: Set to false to disable the embedded database.
  • global.psql.host: Set to the hostname of the external database, can be a domain or an IP address.
  • global.psql.password.secret: The name of the secret which contains the database password for the gitlab user.
  • global.psql.password.key: The key within the secret, which contains the password.

Items below can be further customized if you are not using the defaults:

  • global.psql.port: The port the database is available on, defaults to 5432.
  • global.psql.database: The name of the database.
  • global.psql.username: The user with access to the database.

If you use a mutual TLS connection to the database:

  • global.psql.ssl.secret: A secret containing client certificate, key and certificate authority.
  • global.psql.ssl.serverCA: The key inside the secret referring the certificate authority (CA).
  • global.psql.ssl.clientCertificate: The key inside the secret referring the client certificate.
  • global.psql.ssl.clientKey: The client inside the secret.

For example, pass these values via Helm’s --set flag while deploying:

helm install gitlab gitlab/gitlab
  --set postgresql.install=false
  --set global.psql.host=psql.example
  --set global.psql.password.secret=gitlab-postgresql-password
  --set global.psql.password.key=postgres-password