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

Add instructions to run a local Airflow server #110

Merged
merged 5 commits into from
Feb 15, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,11 @@ __pycache__

# Compiled JSonnet templates
dags/jsonnet/*

# Standalone Airflow instance
airflow-webserver.pid
airflow.cfg
airflow.db
standalone_admin_password.txt
webserver_config.py
logs
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Please review the [contribution guidelines](docs/contributing.md), and note that

## License

[Apache License 2.0](LICENSE)
[Apache License 2.0](LICENSE)
15 changes: 13 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ We use the code formatter [Pyink](https://github.com/google/pyink), which is a f

*For Googlers:*

Run `sudo apt install pipx; pipx install pyink` on your Cloudtop to install Pyink.
Run `sudo apt install pipx; pipx install pyink` on your Cloudtop to install Pyink.

*For external contributors:*

Expand All @@ -47,4 +47,15 @@ Run `bash scripts/format-codes.sh` to format your codes.

All submissions, including submissions by project members, require review. We
use [GitHub pull requests](https://docs.github.com/articles/about-pull-requests)
for this purpose.
for this purpose.

will-cromar marked this conversation as resolved.
Show resolved Hide resolved
### Testing changes locally

To run a standalone Airflow server locally without uploading your changes, run the following from your copy of this repository:

```
gcloud auth login --update-adc
AIRFLOW_HOME=$PWD PYTHONPATH=. airflow standalone
```

This functionality is extremely experimental, and not all DAGs are expected to work with a local standalone server. Only the Airflow server runs locally. Tests will still run in the project defined in each DAG, so use this option with caution.
Loading