lakefs

module
v1.45.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 17, 2024 License: Apache-2.0

README

Apache License Go tests status Node tests status Integration tests status Artifact HUB code of conduct

lakeFS is Data Version Control (Git for Data)

lakeFS is an open-source tool that transforms your object storage into a Git-like repository. It enables you to manage your data lake the way you manage your code.

With lakeFS you can build repeatable, atomic, and versioned data lake operations - from complex ETL jobs to data science and analytics.

lakeFS supports AWS S3, Azure Blob Storage, and Google Cloud Storage as its underlying storage service. It is API compatible with S3 and works seamlessly with all modern data frameworks such as Spark, Hive, AWS Athena, DuckDB, and Presto.

For more information, see the documentation.

Getting Started

You can spin up a standalone sandbox instance of lakeFS using Docker:

docker run --pull always \
		   --name lakefs \
		   -p 8000:8000 \
		   treeverse/lakefs:latest \
		   run --quickstart

Once you've got lakeFS running, open http://127.0.0.1:8000/ in your web browser.

Quickstart

👉🏻 For a hands-on walk through of the core functionality in lakeFS head over to the quickstart to jump right in!

Make sure to also have a look at the lakeFS samples. These are a rich resource of examples of end-to-end applications that you can build with lakeFS.

Why Do I Need lakeFS?

ETL Testing with Isolated Dev/Test Environment

When working with a data lake, it’s useful to have replicas of your production environment. These replicas allow you to test these ETLs and understand changes to your data without impacting downstream data consumers.

Running ETL and transformation jobs directly in production without proper ETL Testing is a guaranteed way to have data issues flow into dashboards, ML models, and other consumers sooner or later. The most common approach to avoid making changes directly in production is to create and maintain multiple data environments and perform ETL testing on them. Dev environment to develop the data pipelines and test environment where pipeline changes are tested before pushing it to production. With lakeFS you can create branches, and get a copy of the full production data, without copying anything. This enables a faster and easier process of ETL testing.

Reproducibility

Data changes frequently. This makes the task of keeping track of its exact state over time difficult. Oftentimes, people maintain only one state of their data––its current state.

This has a negative impact on the work, as it becomes hard to:

  • Debug a data issue.
  • Validate machine learning training accuracy (re-running a model over different data gives different results). Comply with data audits.

In comparison, lakeFS exposes a Git-like interface to data that allows keeping track of more than just the current state of data. This makes reproducing its state at any point in time straightforward.

Write-Audit-Publish

Data pipelines feed processed data from data lakes to downstream consumers like business dashboards and machine learning models. As more and more organizations rely on data to enable business critical decisions, data reliability and trust are of paramount concern. Thus, it’s important to ensure that production data adheres to the data governance policies of businesses. These data governance requirements can be as simple as a file format validation, schema check, or an exhaustive PII(Personally Identifiable Information) data removal from all of organization’s data.

Thus, to ensure the quality and reliability at each stage of the data lifecycle, data quality gates need to be implemented. That is, we need to run quality and correctness tests on the data, and only if data governance requirements are met can the data can be published to production for business use.

Everytime there is an update to production data, the best practice would be to run tests and then publish (deploy) the data to production. With lakeFS you can create hooks that make sure that only data that passed these tests will become part of production.

Rollback

A rollback operation is used to to fix critical data errors immediately.

What is a critical data error? Think of a situation where erroneous or misformatted data causes a signficant issue with an important service or function. In such situations, the first thing to do is stop the bleeding.

Rolling back returns data to a state in the past, before the error was present. You might not be showing all the latest data after a rollback, but at least you aren’t showing incorrect data or raising errors. Since lakeFS provides versions of the data without making copies of the data, you can time travel between versions and roll back to the version of the data before the error was presented.

Community

Stay up to date and get lakeFS support via:

More information

Licensing

lakeFS is completely free and open-source and licensed under the Apache 2.0 License.

Who Uses lakeFS?

lakeFS is used by numerous companies, including those below. If you use lakeFS and would like to be included here please open a PR.

  • AirAsia
  • APEX Global
  • AppsFlyer
  • Auburn University
  • BAE Systems
  • Bureau of Labor Statistics
  • Cambridge Consultants
  • Connor, Clark & Lunn Financial Group
  • Context Labs Bv
  • Daimler Truck
  • Enigma
  • EPCOR
  • Ford Motor Company
  • Generali
  • Giesecke+Devrient
  • greehill
  • Karius
  • Luxonis
  • Mixpeek
  • Netflix
  • Paige
  • PETRONAS
  • Pollinate
  • Proton Technologies AG
  • ProtonMail
  • Renaissance Computing Institute
  • RHEA Group
  • RMS
  • Sensum
  • Similarweb
  • State Street Global Advisors
  • Terramera
  • Tredence
  • Volvo Cars
  • Webiks
  • Windward
  • Woven by Toyota

Directories

Path Synopsis
cmd
contrib
auth/acl
nolint:stylecheck
nolint:stylecheck
auth/apigen
Package apigen provides primitives to interact with the openapi HTTP API.
Package apigen provides primitives to interact with the openapi HTTP API.
modules
cache Module
pkg
actions/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
api
api/apigen
Package apigen provides generated code for our OpenAPI
Package apigen provides generated code for our OpenAPI
api/helpers
Package helpers provide useful wrappers for clients using the lakeFS OpenAPI.
Package helpers provide useful wrappers for clients using the lakeFS OpenAPI.
auth/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
auth/oidc/encoding
Package encoding defines Claims for interoperable external services to use in JWTs.
Package encoding defines Claims for interoperable external services to use in JWTs.
authentication/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
dockertest
Package dockertest provides a wrapper for running a lakeFS container in integration tests.
Package dockertest provides a wrapper for running a lakeFS container in integration tests.
flare
Package flare is used for collecting, sanitizing, and packaging lakeFS configuration, log files, and environment variables for debugging and troubleshooting purposes.
Package flare is used for collecting, sanitizing, and packaging lakeFS configuration, log files, and environment variables for debugging and troubleshooting purposes.
gateway/sig
Package sig This file implements helper functions to validate Streaming AWS Signature Version '4' authorization header.
Package sig This file implements helper functions to validate Streaming AWS Signature Version '4' authorization header.
git
graveler/committed/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
graveler/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
kv
kv/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
permissions
Code generated by extract_actions.
Code generated by extract_actions.
pyramid/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
uri
tools
wrapgen/testcode
Package testcode contains code and generated code for testing wrapgen.
Package testcode contains code and generated code for testing wrapgen.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL