Skip to content

Commit

Permalink
doc fixes: clarify quickstart is learning (#929)
Browse files Browse the repository at this point in the history
fix indention in helm conf
  • Loading branch information
johnnyaug authored Nov 15, 2020
1 parent 148b8e8 commit eb8ff9b
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 23 deletions.
4 changes: 4 additions & 0 deletions docs/_includes/learn_only.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
**Note:** The quickstart section is for learning purposes. The installations below will not persist your data.
Instead, it will spin-up a database in a docker container, which will be discarded later.<br/><br/>
For a production suitable deployment, see [Deploying on AWS](../deploying/index.html).
{: .note }
32 changes: 16 additions & 16 deletions docs/deploying/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,22 @@ lakeFS can be easily installed on Kubernetes using a [Helm chart](https://github
To install lakeFS with Helm:
1. Create a `conf-values.yaml` file, replacing values as described in the comments:

```yaml
secrets:
# replace this with the connection string of the database you created in a previous step:
databaseConnectionString: postgres://postgres:myPassword@my-lakefs-db.rds.amazonaws.com:5432/lakefs?search_path=lakefs
# replace this with a randomly-generated string
authEncryptSecretKey: <some random string>
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.lakefs.example.com
```
```yaml
secrets:
# replace this with the connection string of the database you created in a previous step:
databaseConnectionString: postgres://postgres:myPassword@my-lakefs-db.rds.amazonaws.com:5432/lakefs?search_path=lakefs
# replace this with a randomly-generated string
authEncryptSecretKey: <some random string>
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.lakefs.example.com
```
See [below](#configurations) for more configuration options. The `lakefsConfig` parameter is the lakeFS configuration documented [here](https://docs.lakefs.io/reference/configuration.html), but without sensitive information.
Sensitive information like `databaseConnectionString` is given through separate parameters, and the chart will inject them into Kubernetes secrets.
Expand Down
2 changes: 2 additions & 0 deletions docs/quickstart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ redirect_from: "../quickstart.html"
---

This section will guide you through setting up your lakeFS environment locally.

{% include learn_only.html %}
6 changes: 2 additions & 4 deletions docs/quickstart/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,12 @@ has_children: false
# Installing lakeFS
{: .no_toc }

**Note** This section is for learning purposes. The installations below will not persist your data.
For a production suitable deployment, see [Deploying on AWS](../deploying/index.md).
{: .note }
{% include learn_only.html %}

## Using docker-compose
{: .no_toc }

If you wish to install your lakeFS using Kubernetes, install it manually, or install it on Windows, check out [Other Installations](other_installations.md) page.
Other quickstart methods can be found [here](more_quickstart_options.md).
{: .note .note-info }

To run a local lakeFS instance using [Docker Compose](https://docs.docker.com/compose/){:target="_blank"}:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
layout: default
title: Other Installations
title: More Quickstart Options
parent: Quick Start
nav_order: 50
has_children: false
---

# Other Installation Options
# More Quickstart Options
{: .no_toc}

{% include learn_only.html %}

## Table of Contents
{: .no_toc .text-delta }

Expand Down Expand Up @@ -40,7 +42,7 @@ helm repo add lakefs https://charts.lakefs.io
helm install my-lakefs lakefs/lakefs
```

## Manual Installation
## Using the Binary

Alternatively, you may opt to run the lakefs binary directly on your computer.

Expand Down

0 comments on commit eb8ff9b

Please sign in to comment.