Skip to content

Commit

Permalink
Update docs to recommend creating a bind mount for airflow scheduler …
Browse files Browse the repository at this point in the history
…logs. #3622
  • Loading branch information
greenape committed Nov 7, 2022
1 parent a95b000 commit 3426beb
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

### Changed
- Changed `AIRFLOW__CORE__SQL_ALCHEMY_CONN` env var to `AIRFLOW__DATABASE__SQL_ALCHEMY_CONN`
- Docs now recommend creating a separate bind mount for airflow scheduler logs, and include this in the secrets quickstart. [#3622](https://github.com/Flowminder/FlowKit/issues/3622)

### Fixed
- Fixed a potential deadlock when using a small connection pool and `store`-ing queries
Expand Down
2 changes: 2 additions & 0 deletions docs/source/administrator/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ We recommend running FlowETL using the celery scheduler, in which case you will

See also the [airflow documentation](https://airflow.apache.org/docs/stable/) for other configuration options which you can provide as environment variables.

When deploying to production you are strongly advised to create a bind mount for logs generated by the airflow scheduler, as these can grow very large. This should bind mount `/opt/airflow/logs` inside the container to a directory where the flowetl user has _read-write access_.

The [ETL](management/etl/etl.md) documentation gives detail on how to use FlowETL to load data into FlowDB.

##### Sample stack files
Expand Down
Empty file added flowetl/mounts/logs/.keep
Empty file.
1 change: 1 addition & 0 deletions secrets_quickstart/flowetl.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ x-flowetl-common:

volumes:
- ${FLOWETL_HOST_DAG_DIR:?Must set FLOWETL_HOST_DAG_DIR env var}:/opt/airflow/dags:ro
- ${FLOWETL_HOST_LOGS_DIR:?}/opt/airflow/logs:rw

environment:
&flowetl-envs
Expand Down
1 change: 1 addition & 0 deletions secrets_quickstart/secrets-quickstart.sh
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ export FLOWDB_DATA_DIR=./flowdb_pgdata
mkdir $FLOWDB_DATA_DIR || true
export FLOWDB_ETL_DIR=./../flowetl/mounts/files/
export FLOWETL_HOST_DAG_DIR=./../flowetl/mounts/dags/
export FLOWETL_HOST_LOGS_DIR=./../flowetl/mounts/logs/


# Deploy the stack
Expand Down

0 comments on commit 3426beb

Please sign in to comment.