Apache Airflow (Incubating)
Перейти к файлу
Ryan Hamilton 36a4d6c1dc
Improve interaction with Recent Tasks/DAG Runs circles by ignoring pointer-events (#11786)
Resolves #11563. With the hover event triggering the tooltips, the tooltip was triggering a mouse-out event when the cursor was at the top of the circle (where the tooltip is presented). This was causing the fluttering behavior due to the looping off these events.
2020-10-23 19:19:14 +01:00
.github Add test types displayed in CI (#11770) 2020-10-23 14:19:40 +02:00
airflow Improve interaction with Recent Tasks/DAG Runs circles by ignoring pointer-events (#11786) 2020-10-23 19:19:14 +01:00
chart Remove unused value in Helm Chart - podMutation (#11703) 2020-10-21 08:40:02 -07:00
clients Make Clients Google Shell guide compatible (#10810) 2020-09-14 10:20:21 +02:00
dags Add D200 pydocstyle check (#11688) 2020-10-20 22:33:54 +02:00
dev Fix case of GitHub (#11398) 2020-10-21 14:32:41 +02:00
docker-context-files Adds capability of installing wheel packages in CI image (#11527) 2020-10-15 15:19:18 +02:00
docs The .pypirc file is read from docker-context-files (#11779) 2020-10-23 17:55:15 +02:00
empty Prepare release candidate for backport packages (#8891) 2020-05-17 20:38:46 +02:00
hooks Group CI scripts in subdirectories (#9653) 2020-07-16 18:05:35 +02:00
images Updated documentation for the CI with mermaid sequence diagrams (#10380) 2020-08-24 22:45:28 +02:00
kubernetes_tests More stable kubernetes port forwarding (#11538) 2020-10-15 11:05:58 +02:00
license-templates [AIRFLOW-5234] Rst files have consistent, auto-added license 2019-08-18 19:51:02 -04:00
licenses Replace JS package toggle w/ pure CSS solution (#11035) 2020-09-21 12:29:05 +01:00
manifests [AIRFLOW-7013] Automated check if Breeze image needs to be pulled (#7656) 2020-03-12 09:48:24 +01:00
metastore_browser Add D200 pydocstyle check (#11688) 2020-10-20 22:33:54 +02:00
provider_packages The .tar.gz provider packages are installable now. (#11630) 2020-10-23 16:47:47 +02:00
scripts The .pypirc file is read from docker-context-files (#11779) 2020-10-23 17:55:15 +02:00
tests Ensure that manually creating a DAG run doesn't "block" the scheduler (#11732) 2020-10-23 09:51:03 +01:00
.asf.yaml Add Hacktoberfest topic to the repo (#11258) 2020-10-03 16:05:51 +02:00
.bash_completion [AIRFLOW-3611] Simplified development environment (#4932) 2019-08-27 14:39:36 -04:00
.coveragerc Bring back code coverage (#10143) 2020-08-05 09:44:24 +02:00
.dockerignore The .pypirc file is read from docker-context-files (#11779) 2020-10-23 17:55:15 +02:00
.editorconfig [AIRFLOW-6714] Remove magic comments about UTF-8 (#7338) 2020-02-02 22:18:19 +01:00
.flake8 Enable Black on Providers Packages (#10543) 2020-08-25 17:39:04 +01:00
.gitignore Rename backport packages to provider packages (#11459) 2020-10-12 16:29:48 +02:00
.hadolint.yaml [AIRFLOW-5180] Added static checks (yamllint) + auto-licences for yaml file (#5790) 2019-08-22 10:13:56 -04:00
.mailmap Remove duplicate entries from .mailmap (#10736) 2020-09-05 08:56:17 +02:00
.pre-commit-config.yaml Enforce strict rules for yamllint (#11709) 2020-10-21 12:24:32 +02:00
.rat-excludes Added support for provider packages for Airflow 2.0 (#11487) 2020-10-13 16:33:00 +01:00
.readthedocs.yml [AIRFLOW-5180] Added static checks (yamllint) + auto-licences for yaml file (#5790) 2019-08-22 10:13:56 -04:00
BREEZE.rst Fix case of GitHub (#11398) 2020-10-21 14:32:41 +02:00
CHANGELOG.txt Fix more docs spellings (#10965) 2020-09-16 01:03:41 +01:00
CI.rst Fix case of JavaScript (#11718) 2020-10-21 19:56:54 +02:00
CODE_OF_CONDUCT.md Add Apache Airflow CODE_OF_CONDUCT.md (#9715) 2020-08-05 16:02:04 +02:00
CONTRIBUTING.rst Fix case of GitHub (#11398) 2020-10-21 14:32:41 +02:00
Dockerfile The .pypirc file is read from docker-context-files (#11779) 2020-10-23 17:55:15 +02:00
Dockerfile.ci Behaviour to install all airflow providers added (#11529) 2020-10-17 11:16:28 +02:00
IMAGES.rst Fix case of GitHub (#11398) 2020-10-21 14:32:41 +02:00
INSTALL Behaviour to install all airflow providers added (#11529) 2020-10-17 11:16:28 +02:00
INTHEWILD.md Add uSmart Securities to the INTHEWILD.md (#11757) 2020-10-23 14:08:06 +01:00
LICENSE Remove vendored nvd3 and slugify libraries (#9136) 2020-06-04 15:45:29 +01:00
LOCAL_VIRTUALENV.rst Constraint files are now maintained automatically (#9889) 2020-07-20 14:36:03 +02:00
MANIFEST.in Fix example DAGs in pip packages (#11687) 2020-10-20 18:30:59 +02:00
NOTICE Housekeeping of auth backend & Update Security doc (#8071) 2020-04-03 18:20:39 +02:00
README.md Enable MySQL 8 CI jobs (#11247) 2020-10-04 13:45:05 +02:00
STATIC_CODE_CHECKS.rst in_container bats pre-commit hook and updated bats-tests hook (#11179) 2020-09-29 11:59:06 +02:00
TESTING.rst Rename backport packages to provider packages (#11459) 2020-10-12 16:29:48 +02:00
UPDATING.md Prepend `DAG:` to dag permissions (#11189) 2020-10-16 00:32:38 +01:00
breeze Enables splitting tests into smaller chunks (#11659) 2020-10-22 23:25:00 +02:00
breeze-complete Name and optionally preserve data volumes in Breeze (#11628) 2020-10-18 16:39:44 +02:00
codecov.yml Enforce strict rules for yamllint (#11709) 2020-10-21 12:24:32 +02:00
confirm Implement Google Shell Conventions for breeze script (#10695) 2020-09-02 21:55:50 +02:00
pylintrc Introduce TaskMixin (#10930) 2020-09-16 13:56:36 +02:00
pyproject.toml Enable Black on Connexion API folders (#10545) 2020-08-25 12:10:20 +01:00
pytest.ini Remove unknown pytest.ini setting (#10923) 2020-09-14 09:49:41 +01:00
setup.cfg The .tar.gz provider packages are installable now. (#11630) 2020-10-23 16:47:47 +02:00
setup.py The .tar.gz provider packages are installable now. (#11630) 2020-10-23 16:47:47 +02:00
yamllint-config.yml [AIRFLOW-5180] Added static checks (yamllint) + auto-licences for yaml file (#5790) 2019-08-22 10:13:56 -04:00

README.md

Apache Airflow

PyPI version GitHub Build Coverage Status Documentation Status License PyPI - Python Version Docker Pulls Docker Stars

Twitter Follow Slack Status

Apache Airflow (or simply Airflow) is a platform to programmatically author, schedule, and monitor workflows.

When workflows are defined as code, they become more maintainable, versionable, testable, and collaborative.

Use Airflow to author workflows as directed acyclic graphs (DAGs) of tasks. The Airflow scheduler executes your tasks on an array of workers while following the specified dependencies. Rich command line utilities make performing complex surgeries on DAGs a snap. The rich user interface makes it easy to visualize pipelines running in production, monitor progress, and troubleshoot issues when needed.

Table of contents

Requirements

Apache Airflow is tested with:

Master version (2.0.0dev) Stable version (1.10.12)
Python 3.6, 3.7, 3.8 2.7, 3.5, 3.6, 3.7, 3.8
PostgreSQL 9.6, 10 9.6, 10
MySQL 5.7, 8 5.6, 5.7
SQLite latest stable latest stable
Kubernetes 1.16.2, 1.17.0 1.16.2, 1.17.0

Note: SQLite is used primarily for development purpose.

Additional notes on Python version requirements

  • Stable version requires at least Python 3.5.3 when using Python 3

Getting started

Visit the official Airflow website documentation (latest stable release) for help with installing Airflow, getting started, or walking through a more complete tutorial.

Note: If you're looking for documentation for master branch (latest development branch): you can find it on ReadTheDocs.

For more information on Airflow's Roadmap or Airflow Improvement Proposals (AIPs), visit the Airflow Wiki.

Official Docker (container) images for Apache Airflow are described in IMAGES.rst.

Installing from PyPI

We publish Apache Airflow as apache-airflow package in PyPI. Installing it however might be sometimes tricky because Airflow is a bit of both a library and application. Libraries usually keep their dependencies open and applications usually pin them, but we should do neither and both at the same time. We decided to keep our dependencies as open as possible (in setup.py) so users can install different versions of libraries if needed. This means that from time to time plain pip install apache-airflow will not work or will produce unusable Airflow installation.

In order to have repeatable installation, however, introduced in Airflow 1.10.10 and updated in Airflow 1.10.12 we also keep a set of "known-to-be-working" constraint files in the orphan constraints-master and constraints-1-10 branches. We keep those "known-to-be-working" constraints files separately per major/minor python version. You can use them as constraint files when installing Airflow from PyPI. Note that you have to specify correct Airflow tag/version/branch and python versions in the URL.

  1. Installing just Airflow:
pip install apache-airflow==1.10.12 \
 --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-1.10.12/constraints-3.7.txt"
  1. Installing with extras (for example postgres,google)
pip install apache-airflow[postgres,google]==1.10.12 \
 --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-1.10.12/constraints-3.7.txt"

For information on installing backport providers check https://airflow.readthedocs.io/en/latest/backport-providers.html.

Official source code

Apache Airflow is an Apache Software Foundation (ASF) project, and our official source code releases:

Following the ASF rules, the source packages released must be sufficient for a user to build and test the release provided they have access to the appropriate platform and tools.

Convenience packages

There are other ways of installing and using Airflow. Those are "convenience" methods - they are not "official releases" as stated by the ASF Release Policy, but they can be used by the users who do not want to build the software themselves.

Those are - in the order of most common ways people install Airflow:

  • PyPI releases to install Airflow using standard pip tool
  • Docker Images to install airflow via docker tool, use them in Kubernetes, Helm Charts, docker-compose, docker swarm etc. You can read more about using, customising, and extending the images in the Latest docs, and learn details on the internals in the IMAGES.rst document.
  • Tags in GitHub to retrieve the git project sources that were used to generate official source packages via git

All those artifacts are not official releases, but they are prepared using officially released sources. Some of those artifacts are "development" or "pre-release" ones, and they are clearly marked as such following the ASF Policy.

Project Focus

Airflow works best with workflows that are mostly static and slowly changing. When the structure is similar from one run to the next, it allows for clarity around unit of work and continuity. Other similar projects include Luigi, Oozie and Azkaban.

Airflow is commonly used to process data, but has the opinion that tasks should ideally be idempotent, and should not pass large quantities of data from one task to the next (though tasks can pass metadata using Airflow's Xcom feature). For high-volume, data-intensive tasks, a best practice is to delegate to external services that specialize on that type of work.

Airflow is not a streaming solution. Airflow is not in the Spark Streaming or Storm space.

Principles

  • Dynamic: Airflow pipelines are configuration as code (Python), allowing for dynamic pipeline generation. This allows for writing code that instantiates pipelines dynamically.
  • Extensible: Easily define your own operators, executors and extend the library so that it fits the level of abstraction that suits your environment.
  • Elegant: Airflow pipelines are lean and explicit. Parameterizing your scripts is built into the core of Airflow using the powerful Jinja templating engine.
  • Scalable: Airflow has a modular architecture and uses a message queue to orchestrate an arbitrary number of workers.

User Interface

  • DAGs: Overview of all DAGs in your environment.

  • Tree View: Tree representation of a DAG that spans across time.

  • Graph View: Visualization of a DAG's dependencies and their current status for a specific run.

  • Task Duration: Total time spent on different tasks over time.

  • Gantt View: Duration and overlap of a DAG.

  • Code View: Quick way to view source code of a DAG.

Contributing

Want to help build Apache Airflow? Check out our contributing documentation.

Who uses Apache Airflow?

More than 350 organizations are using Apache Airflow in the wild.

Who Maintains Apache Airflow?

Airflow is the work of the community, but the core committers/maintainers are responsible for reviewing and merging PRs as well as steering conversation around new feature requests. If you would like to become a maintainer, please review the Apache Airflow committer requirements.

Can I use the Apache Airflow logo in my presentation?

Yes! Be sure to abide by the Apache Foundation trademark policies and the Apache Airflow Brandbook. The most up to date logos are found in this repo and on the Apache Software Foundation website.

Airflow merchandise

If you would love to have Apache Airflow stickers, t-shirt etc. then check out Redbubble Shop.