github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/docs/howto/index.md (about)

     1  ---
     2  title: How-To
     3  description: How to perform various tasks in lakeFS
     4  nav_order: 5
     5  has_children: true
     6  has_toc: false
     7  ---
     8  
     9  # lakeFS - How To
    10  
    11  <img src="/assets/img/docs_logo.png" alt="lakeFS Docs" width=200 style="float: right; margin: 0 0 10px 10px;"/>
    12  
    13  
    14  ## Installation and upgrades
    15  
    16  * Step-by-step instructions for deploying and configuring lakeFS on [AWS](/howto/deploy/aws.html), [GCP](/howto/deploy/gcp.html), [Azure](/howto/deploy/azure.html), and [on-premises](/howto/deploy/onprem.html). 
    17  
    18  * Details on [how to upgrade lakeFS](/howto/deploy/upgrade.html)
    19  
    20  ## Getting data in and out of lakeFS
    21  
    22  * [Import](/howto/import.html) and [Export Data](/howto/export.html) from lakeFS
    23  * [Copy data](/howto/copying.html) to/from lakeFS
    24  * [Using external Data Catalogs](/howto/catalog_exports.html) with data stored on lakeFS
    25  * [Migrating](/howto/migrate-away.html) away from lakeFS
    26  * Working with lakeFS data [locally](local-checkouts.md)
    27  
    28  ## Actions and Hooks in lakeFS
    29  
    30  * Use [Actions and Hooks](/howto/hooks/) as part of your workflow to validate data, enforce constraints, and do more when events occur.
    31  
    32  ## Branch Protection
    33  
    34  * [Branch Protection](/howto/protect-branches.html) prevents commits directly to a branch. This is a good way to enforce good practice and make sure that changes to important branches are only done by a merge.
    35  
    36  ## lakeFS Sizing Guide
    37  
    38  * This [comprehensive guide](/howto/sizing-guide.html) details all you need to know to correctly size and test your lakeFS deployment for production use at scale, including: 
    39  
    40      * [System Requirements](/howto/sizing-guide.html#system-requirements)
    41      * [Scaling factors](/howto/sizing-guide.html#scaling-factors)
    42      * [Benchmarks](/howto/sizing-guide.html#benchmarks)
    43      * [Important metrics](/howto/sizing-guide.html#important-metrics)
    44      * [Reference architectures](/howto/sizing-guide.html#reference-architectures)
    45  
    46  ## Garbage Collection
    47  
    48  * lakeFS will keep all of your objects forever, unless you tell it otherwise. Use [Garbage Collection]({% link howto/garbage-collection/index.md %}) (GC) to remove objects from the underlying storage.
    49      If you want GC to happen automagically then you can use [Managed Garbage Collection]({% link howto/garbage-collection/managed-gc.md %}) which is available as part of lakeFS Cloud.
    50  
    51  ## Private Link
    52  
    53  * [Private Link]({% link howto/private-link.md %}) enables lakeFS Cloud to interact with your infrastructure using private networking.
    54  
    55  ## Unity Delta Sharing
    56  
    57  * lakeFS [Unity Delta Sharing]({% link howto/unity-delta-sharing.md %}) provides a read-only experience from Unity Catalog for lakeFS customers.