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

     1  ---
     2  title: Reference
     3  description: Reference documentation for the lakeFS platform's various APIs, CLIs, and file formats.
     4  has_children: true
     5  has_toc: false
     6  nav_order: 20
     7  ---
     8  
     9  # lakeFS Reference
    10  
    11  <img src="/assets/img/docs_logo.png" alt="lakeFS Docs" width=200 style="float: right; margin: 0 0 10px 10px;"/>
    12  
    13  ## API
    14  
    15  - [lakeFS API]({% link reference/api.md %})
    16  - [S3 Gateway API]({% link reference/s3.md %})
    17  
    18  ## Components
    19  
    20  - [Server Configuration]({% link reference/configuration.md %})
    21  - lakeFS command-line tool [lakectl]({% link reference/cli.md %})
    22  
    23  ## Clients
    24  
    25  - [Spark Metadata Client]({% link reference/spark-client.md %})
    26  - [lakeFS Hadoop FileSystem]({% link integrations/spark.md%}#lakefs-hadoop-filesystem)
    27  - [Python Client]({% link integrations/python.md %})
    28  
    29  ## Security
    30  
    31  - [Authentication]({% link reference/security/authentication.md %})
    32  - [Remote Authenticator]({% link reference/security/remote-authenticator.md %})
    33  - [Role-Based Access Control (RBAC)]({% link reference/security/rbac.md %})
    34  - [Presigned URL]({% link reference/security/presigned-url.md %})
    35  - [Access Control Lists (ACLs)]({% link reference/security/access-control-lists.md %})
    36  - [Single Sign On (SSO)]({% link reference/security/sso.md %})
    37  - [Login to lakeFS with AWS IAM]({% link reference/security/external-principals-aws.md %})
    38    
    39  ## Other Reference Documentation
    40  
    41  - [Monitoring using Prometheus]({% link reference/monitor.md %})
    42  - [Auditing]({% link reference/auditing.md %})