Skip to content

Commit

Permalink
Add documentation on enabling sqlite
Browse files Browse the repository at this point in the history
  • Loading branch information
mitchnielsen committed Dec 5, 2024
1 parent ad812ee commit 1f3dee9
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions charts/prefect-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,29 @@ prefect-server:
postgresql+asyncpg://{username}:{password}@{hostname}/{database}?ssl=verify-ca
```

## SQLite Configuration

SQLite can be used as an alternative to PostgreSQL. As mentioned in the
[documentation on hosting Prefect](https://docs-3.prefect.io/v3/manage/self-host),
SQLite is only recommended for lightweight, single-server deployments.

To use SQLite for the database, provide the following configuration values:

```yaml
postgresql:
enabled: false
sqlite:
enabled: true
```

More configuration options are available in [`values.yaml`](./values.yaml).

By default, a PersistentVolumeClaim persists the SQLite database file between
Pod restarts.

Note that enabling SQLite enforces 1 replica in the Deployment, and disables
the HorizontalPodAutoscaler.

## Maintainers

| Name | Email | Url |
Expand Down

0 comments on commit 1f3dee9

Please sign in to comment.