Link Search Menu Expand Document

Creating the database

lakeFS requires a PostgreSQL database to synchronize actions on your repositories. We will show you how to create a database on your cloud platform. You can use any PostgreSQL database as long as it’s accessible by your lakeFS installation.

If you already have a database, take note of the connection string and proceed to Configuring the Storage.

Table of contents

  1. On AWS RDS
  2. On Microsoft Azure Database
  3. On Google Cloud SQL

On AWS RDS

  1. Follow the official AWS documentation on how to create a PostgreSQL instance and connect to it.
    You may use the default PostgreSQL engine, or Aurora PostgreSQL. Make sure you’re using PostgreSQL version >= 11.
  2. Once your RDS is set up and the server is in Available state, take note of the endpoint and port.

    RDS Connection String

  3. Make sure your security group rules allow you to connect to the database instance.

You can now proceed to Configuring the Storage.

On Microsoft Azure Database

  1. Follow the official Azure documentation on how to create a PostgreSQL instance and connect to it. Make sure you’re using PostgreSQL version >= 11.
  2. Once your Azure Database for PostgreSQL server is set up and the server is in Available state, take note of the endpoint and username. Azure postgres Connection String
  3. Make sure your Access control roles allow you to connect to the database instance.

You can now proceed to Configuring the Storage.

On Google Cloud SQL

  1. Follow the official Google documentation on how to create a PostgreSQL instance. Make sure you’re using PostgreSQL version >= 11.
  2. On the Users tab in the console, create a user to be used by the lakeFS installation.
  3. Choose the method by which lakeFS will connect to your database. Google recommends using the SQL Auth Proxy.

Depending on the chosen lakeFS installation method, you will need to make sure lakeFS can access your database. For example, if you install lakeFS on GKE, you need to deploy the SQL Auth Proxy from this Helm chart, or as a sidecar container in your lakeFS pod.

You can now proceed to Configuring the Storage.