Skip to content

Commit 3de76d6

Browse files
authored
Docs: Update enterprise installation licensing docs (#9313)
* Docs: Update enterprise installation licensing docs * CR Fixes
1 parent 198fc8e commit 3de76d6

File tree

3 files changed

+70
-2
lines changed

3 files changed

+70
-2
lines changed

docs/src/enterprise/getstarted/install.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,41 @@ Error: feature not licensed - to enable, contact support@treeverse.io
225225
226226
---
227227
228+
### License Configuration
229+
230+
!!! note
231+
You can proceed without this step at the moment. However, licensing enforcement will be introduced soon.
232+
Contact [support](mailto:support@treeverse.io) to receive your installation license.
233+
234+
lakeFS Enterprise requires a valid license to work.
235+
In the helm chart the license is provided as a JWT token either from an existing secret or explicitly.
236+
The following demonstrates how to configure the license in the `values` file:
237+
238+
=== "License with token provided in secrets"
239+
240+
```yaml
241+
enterprise:
242+
enabled: true
243+
244+
secrets:
245+
licenseContents: <Your licese JWT token>
246+
```
247+
248+
=== "License with token provided from existing secret"
249+
250+
```yaml
251+
enterprise:
252+
enabled: true
253+
254+
# Name of existing secret to use
255+
existingSecret: <Name of existing secret>
256+
257+
secretKeys:
258+
# Use to fetch license token from an existing secret:
259+
licenseContentsKey: <Name of license contents key from existing secret>
260+
```
261+
262+
228263
### Authentication Configuration
229264
230265
Authentication in lakeFS Enterprise is handled directly by the lakeFS Enterprise service. This section explains the configurations required for setting up SSO.

docs/src/enterprise/getstarted/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Checkout the [RBAC demo](https://github.com/treeverse/lakeFS-samples/blob/main/0
4343
3. With the token you've been granted, login locally to Docker Hub with `docker login -u externallakefs -p <TOKEN>`.
4444

4545
<br>
46-
The quickstart docker-compose files below create a lakeFS server that's connected to a [local blockstore](../../howto/deploy/onprem.md#local-blockstore) and spin up the following containers:
46+
The quickstart docker-compose file below creates a lakeFS server that's connected to a [local blockstore](../../howto/deploy/onprem.md#local-blockstore) and spin up the following containers:
4747

4848
* lakeFS Enterprise
4949
* Postgres: used by lakeFS as a KV store

docs/src/enterprise/upgrade.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ To migrate from fluffy to lakeFS Enterprise, follow the steps below:
3434

3535
## Configuration Changes
3636

37-
3837
### Authentication configuration
3938

4039
Most Fluffy `auth.*` settings migrate directly to lakeFS Enterprise with the same structure. Below are the differences between the configurations.
@@ -363,6 +362,40 @@ image:
363362
364363
**Note**: If you're not overriding the image, the chart will automatically use the correct Enterprise image.
365364
365+
#### Step 3.5: License Configuration
366+
367+
!!! note
368+
You can proceed without this step at the moment. However, licensing enforcement will be introduced soon.
369+
Contact [support](mailto:support@treeverse.io) to receive your installation license.
370+
371+
lakeFS Enterprise requires a valid license to work.
372+
In the helm chart the license is provided as a JWT token either from an existing secret or explicitly.
373+
The following demonstrates how to configure the license in the `values` file:
374+
375+
=== "License with token provided in secrets"
376+
377+
```yaml
378+
enterprise:
379+
enabled: true
380+
381+
secrets:
382+
licenseContents: <Your licese JWT token>
383+
```
384+
385+
=== "License with token provided from existing secret"
386+
387+
```yaml
388+
enterprise:
389+
enabled: true
390+
391+
# Name of existing secret to use
392+
existingSecret: <Name of existing secret>
393+
394+
secretKeys:
395+
# Use to fetch license token from an existing secret:
396+
licenseContentsKey: <Name of license contents key from existing secret>
397+
```
398+
366399
#### Step 4: Migrate Your Authentication Configuration
367400

368401
Using the [configuration examples below](#configuration-examples), update your values.yaml file:

0 commit comments

Comments
 (0)