Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure lakeFS Enterprise docs #7917

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 0 additions & 37 deletions docs/enterprise/architecture.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
---
title: Fluffy Server Configuration
description: Configuration reference for Fluffy Server
title: lakeFS Enterprise Configuration reference
description: a configuration reference for lakeFS Enterprise
nav_order: 110
parent: lakeFS Enterprise
---

TODO: add an intro

# lakeFS Configuration

# Fluffy Server Configuration

{% include toc.html %}
Expand Down
7 changes: 7 additions & 0 deletions docs/enterprise/getstarted/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Get Started with lakeFS Enterprise
description: Methods for getting started with lakeFS Enterprise
has_children: true
nav_order: 100
parent: lakeFS Enterprise
---
6 changes: 6 additions & 0 deletions docs/enterprise/getstarted/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Install lakeFS Enterprise
description: lakeFS Enterprise Installation Guide
nav_order: 105
parent: Get Started with lakeFS Enterprise
---
6 changes: 6 additions & 0 deletions docs/enterprise/getstarted/migrate-from-oss.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Migrate from lakeFS OSS
description: How to migrate from lakeFS OSS to lakeFS Enterprise
nav_order: 110
parent: Get Started with lakeFS Enterprise
---
6 changes: 6 additions & 0 deletions docs/enterprise/getstarted/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: lakeFS Enterprise Quickstart
description: Quickstart guides for lakeFS Enterprise
nav_order: 100
parent: Get Started with lakeFS Enterprise
---
40 changes: 39 additions & 1 deletion docs/enterprise/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: lakeFS Enterprise
description: lakeFS Enterprise is an enterprise-ready lakeFS solution providing additional features including RBAC, SSO and Support SLA.
has_children: true
nav_order: 110
has_toc: false
---

# lakeFS Enterprise
Expand Down Expand Up @@ -36,3 +35,42 @@ release info found in [Github releases](https://github.com/treeverse/lakeFS/rele
You can learn nore about [lakeFS Enterprise architecture]({% link enterprise/architecture.md %}), or
follow the examples in the [quickstart guide]({% link enterprise/orchestration.md %}).

## Architecture

---
title: Enterprise Architecture
description: Understand lakeFS Enterprise Architecture
parent: lakeFS Enterprise
---

# Architecture

![img.png](../assets/img/enterprise/enterprise-arch.png)

[1] Any user request to lakeFS via Browser or Programmatic access (SDK, HTTP
API, lakectl).

[2] Reverse Proxy (e.g. NGINX, Traefik, K8S Ingress): will handle user requests
and proxy between lakeFS server and fluffy server based on the path prefix
while maintaining the same host.

[3] lakeFS server - the main lakeFS service.

[4] fluffy server - service that is responsible for the Enterprise features.,
it is separated by ports for security reasons.

1. SSO auth (i.e Browser login via Azure AD, Okta, Auth0), default port 8000.
1. RBAC authorization, default port 9000.

[5] The [KV Store]({% link understand/architecture.md %}) - Where metadata is stored used both by lakeFS and fluffy.

[6] SSO IdP - Identity provider (e.g. Azure AD, Okta, JumpCloud). fluffy
implements SAML and Oauth2 protocols.


For more details and pricing, please [contact sales](https://lakefs.io/contact-sales/).


**Note:** Setting up lakeFS enterprise with an SSO IdP (OIDC, SAML or LDAP) requires
configuring access from the IdP too.
{: .note }
6 changes: 6 additions & 0 deletions docs/enterprise/upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Upgrade lakeFS Enterprise
description: How to upgrade lakeFS Enterprise
nav_order: 105
parent: lakeFS Enterprise
---
Loading