Upgrading lakeFS

Note: For a fully managed lakeFS service with guaranteed SLAs, try lakeFS Cloud

Upgrading lakeFS from a previous version usually just requires re-deploying with the latest image (or downloading the latest version if you’re using the binary). If you’re upgrading, check whether the release requires a migration.

When DB migrations are required

lakeFS 0.80.0 or greater (KV Migration)

Starting with version 0.80.2, lakeFS has transitioned from using a PostgreSQL based database implementation to a Key-Value datastore interface supporting multiple database implementations. More information can be found here.
Users upgrading from a previous version of lakeFS must pass through the KV migration version (0.80.2) before upgrading to newer versions of lakeFS.

IMPORTANT: Pre Migrate Requirements

• Users using OS environment variables for database configuration must define the connection_string explicitly or as environment variable before proceeding with the migration.
• Database storage free capacity of at least twice the amount of the currently used capacity
• It is strongly recommended to perform these additional steps:
  • Commit all uncommitted data on branches
  • Create a snapshot of your database
• By default, old database tables are not being deleted by the migration process, and should be removed manually after a successful migration. To enable table drop as part of the migration, set the database.drop_tables configuration param to true

Migration Steps

For each lakeFS instance currently running with the database

1. Modify the database section under lakeFS configuration yaml:
   1. Add type field with "postgres" as value
   2. Copy the current configuration parameters to a new section called postgres

   ---
   database:
    type: "postgres"
    connection_string: "postgres://localhost:5432/postgres?sslmode=disable"
    max_open_connections: 20
      
    postgres:
      connection_string: "postgres://localhost:5432/postgres?sslmode=disable"
      max_open_connections: 20
   

2. Stop all lakeFS instances

3. Using the lakefs binary for the new version (0.80.2), run the following:

   lakefs migrate up
   

4. lakeFS will run the migration process, which in the end should display the following message with no errors:

   time="2022-08-10T14:46:25Z" level=info msg="KV Migration took 717.629563ms" func="pkg/logging.(*logrusEntryWrapper).Infof" file="build/pkg/logging/logger.go:246" TempDir=/tmp/kv_migrate_2913402680
   

5. It is now possible to remove the old database configuration. The updated configuration should look as such:

   ---
   database:
    type: "postgres"
      
    postgres:
      connection_string: "postgres://localhost:5432/postgres?sslmode=disable"
      max_open_connections: 20
   

6. Deploy (or run) the new version of lakeFS.

lakeFS 0.30.0 or greater

In case migration is required, you first need to stop the running lakeFS service. Using the lakefs binary for the new version, run the following:

lakefs migrate up

Deploy (or run) the new version of lakeFS.

Note that an older version of lakeFS cannot run on a migrated database.

Prior to lakeFS 0.30.0

Note: with lakeFS < 0.30.0, you should first upgrade to 0.30.0 following this guide. Then, proceed to upgrade to the newest version.

Starting version 0.30.0, lakeFS handles your committed metadata in a new way, which is more robust and has better performance. To move your existing data, you will need to run the following upgrade commands.

Verify lakeFS version == 0.30.0 (can skip if using Docker)

lakefs --version

Migrate data from the previous format:

lakefs migrate db

Or migrate using Docker image:

docker run --rm -it -e LAKEFS_DATABASE_CONNECTION_STRING=<database connection string> treeverse/lakefs:rocks-migrate migrate db

Once migrated, it is possible to now use more recent lakeFS versions. Please refer to their release notes for more information on ugrading and usage).

If you want to start over, discarding your existing data, you need to explicitly state this in your lakeFS configuration file. To do so, add the following to your configuration (relevant only for 0.30.0):

cataloger:
  type: rocks

Data Migration for Version v0.50.0

We discovered a bug in the way lakeFS is storing objects in the underlying object store. It affects only repositories on Azure and GCP, and not all of them. Issue #2397 describes the repository storage namespaces patterns that are affected by this bug.

When first upgrading to a version greater or equal to v0.50.0, you must follow these steps:

1. Stop lakeFS.
2. Perform a data migration (details below)
3. Start lakeFS with the new version.
4. After a successful run of the new version and validation that the objects are accessible, you can delete the old data prefix.

Note: Migrating data is a delicate procedure. The lakeFS team is here to help, reach out to us on Slack. We’ll be happy to walk you through the process.

Data migration

The following patterns have been impacted by the bug:

You can find the repositories storage namespaces with:

lakectl repo list

Or the settings tab in the UI.

Migrating Google Storage data with gsutil

gsutil is a Python application that lets you access Cloud Storage from the command line. We can use it for copying the data between the prefixes in the Google bucket, and later on removing it.

For every affected repository, copy its data with:

gsutil -m cp -r gs://<BUCKET>//<PREFIX>/ gs://<BUCKET>/

Note the double slash after the bucket name.

Migrating Azure Blob Storage data with AzCopy

AzCopy is a command-line utility that you can use to copy blobs or files to or from a storage account. We can use it for copying the data between the prefixes in the Azure storage account container, and later on removing it.

First, you need to acquire an Account SAS. Using the Azure CLI:

az storage container generate-sas \
    --account-name <ACCOUNT> \
    --name <CONTAINER> \
    --permissions cdrw \
    --auth-mode key \
    --expiry 2021-12-31

With the resulted SAS, use AzCopy to copy the files. If a prefix exists after the container:

azcopy copy \
"https://<ACCOUNT>.blob.core.windows.net/<CONTAINER>/<PREFIX>//?<SAS_TOKEN>" \
"https://<ACCOUNT>.blob.core.windows.net/<CONTAINER>?<SAS_TOKEN>" \
--recursive=true

Or when using the container without a prefix:

azcopy copy \
"https://<ACCOUNT>.blob.core.windows.net/<CONTAINER>//?<SAS_TOKEN>" \
"https://<ACCOUNT>.blob.core.windows.net/<CONTAINER>/./?<SAS_TOKEN>" \
--recursive=true