Link Search Menu Expand Document

Deploy lakeFS on Kubernetes

Database

lakeFS requires a PostgreSQL database to synchronize actions on your repositories. This section assumes you already have a PostgreSQL database accessible from your Kubernetes cluster. Instructions for creating the database can be found on the deployment instructions for AWS, Azure and GCP.

Table of contents

  1. Prerequisites
  2. Installing on Kubernetes
  3. Load balancing
  4. DNS
  5. Next Steps

Prerequisites

A production-suitable lakeFS installation will require three DNS records pointing at your lakeFS server. A good convention for those will be, assuming you already own the domain example.com:

  • lakefs.example.com
  • s3.lakefs.example.com - this is the S3 Gateway Domain
  • *.s3.lakefs.example.com

The second record, the S3 Gateway Domain, needs to be specified in the lakeFS configuration (see the S3_GATEWAY_DOMAIN placeholder below). This will allow lakeFS to route requests to the S3-compatible API. For more info, see Why do I need these three DNS records?

Installing on Kubernetes

lakeFS can be easily installed on Kubernetes using a Helm chart. To install lakeFS with Helm:

  1. Copy the Helm values file relevant to your storage provider:
    secrets:
     # replace DATABASE_CONNECTION_STRING with the connection string of the database you created in a previous step.
     # e.g. postgres://postgres:myPassword@my-lakefs-db.rds.amazonaws.com:5432/lakefs
     databaseConnectionString: [DATABASE_CONNECTION_STRING]
     # replace this with a randomly-generated string
     authEncryptSecretKey: [ENCRYPTION_SECRET_KEY]
    lakefsConfig: |
     blockstore:
       type: s3
       s3:
         region: us-east-1
     gateways:
       s3:
         # replace this with the host you will use for the lakeFS S3-compatible endpoint:
         domain_name: [S3_GATEWAY_DOMAIN]
    
    secrets:
     # replace DATABASE_CONNECTION_STRING with the connection string of the database you created in a previous step.
     # e.g.: postgres://postgres:myPassword@localhost/postgres:5432
     databaseConnectionString: [DATABASE_CONNECTION_STRING]
     # replace this with a randomly-generated string
     authEncryptSecretKey: [ENCRYPTION_SECRET_KEY]
    lakefsConfig: |
     blockstore:
       type: gs
     # Uncomment the following lines to give lakeFS access to your buckets using a service account:
     # gs:
     #   credentials_json: [YOUR SERVICE ACCOUNT JSON STRING]
     gateways:
       s3:
         # replace this with the host you will use for the lakeFS S3-compatible endpoint:
         domain_name: [S3_GATEWAY_DOMAIN]
    

    Notes for running lakeFS on GKE

    • To connect to your database, you need to use one of the ways of connecting GKE to Cloud SQL.
    • To give lakeFS access to your bucket, you can start the cluster in storage-rw mode. Alternatively, you can use a service account JSON string by uncommenting the gs.credentials_json property in the following yaml.
    secrets:
     # replace this with the connection string of the database you created in a previous step:
     databaseConnectionString: [DATABASE_CONNECTION_STRING]
     # replace this with a randomly-generated string
     authEncryptSecretKey: [ENCRYPTION_SECRET_KEY]
    lakefsConfig: |
     blockstore:
       type: azure
       azure:
         auth_method: msi # msi for active directory, access-key for access key 
      #  In case you chose to authenticate via access key unmark the following rows and insert the values from the previous step 
      #  storage_account: [your storage account]
      #  storage_access_key: [your access key]
     gateways:
       s3:
         # replace this with the host you will use for the lakeFS S3-compatible endpoint:
         domain_name: s3.lakefs.example.com
    
  2. Fill in the missing values and save the file as conf-values.yaml. For more configuration options, see our Helm chart README.

    The lakefsConfig parameter is the lakeFS configuration documented here, but without sensitive information. Sensitive information like databaseConnectionString is given through separate parameters, and the chart will inject them into Kubernetes secrets.

  3. In the directory where you created conf-values.yaml, run the following commands:

     # Add the lakeFS repository
     helm repo add lakefs https://charts.lakefs.io
     # Deploy lakeFS
     helm install example-lakefs lakefs/lakefs -f conf-values.yaml
    

    example-lakefs is the Helm Release name.

You should give your Kubernetes nodes access to all buckets/containers you intend to use lakeFS with. If you can’t provide such access, lakeFS can be configured to use an AWS key-pair, an Azure access key, or a Google Cloud credentials file to authenticate (part of the lakefsConfig YAML below).

Load balancing

You should have a load balancer direct requests to the lakeFS server. Options to do so include a Kubernetes Service of type LoadBalancer, or a Kubernetes Ingress. By default, lakeFS operates on port 8000, and exposes a /_health endpoint which you can use for health checks.

DNS

As mentioned above, you should create 3 DNS records for lakeFS:

  1. One record for the lakeFS API: lakefs.example.com
  2. Two records for the S3-compatible API: s3.lakefs.example.com and *.s3.lakefs.example.com.

All records should point to your Load Balancer, preferably with a short TTL value.

Next Steps

Your next step is to prepare your storage. If you already have a storage bucket/container, you are ready to create your first lakeFS repository.

Why do I need the three DNS records?

Multiple DNS records are needed to access the two different lakeFS APIs (covered in more detail in the Architecture section):

  1. The lakeFS OpenAPI: used by the lakectl CLI tool. Exposes git-like operations (branching, diffing, merging etc.).
  2. An S3-compatible API: read and write your data in any tool that can communicate with S3. Examples include: AWS CLI, Boto, Presto and Spark.

lakeFS actually exposes only one API endpoint. For every request, lakeFS checks the Host header. If the header is under the S3 gateway domain, the request is directed to the S3-compatible API.

The third DNS record (*.s3.lakefs.example.com) allows for virtual-host style access. This is a way for AWS clients to specify the bucket name in the Host subdomain.