257 строки
14 KiB
Markdown
257 строки
14 KiB
Markdown
<!--
|
|
Licensed to the Apache Software Foundation (ASF) under one
|
|
or more contributor license agreements. See the NOTICE file
|
|
distributed with this work for additional information
|
|
regarding copyright ownership. The ASF licenses this file
|
|
to you under the Apache License, Version 2.0 (the
|
|
"License"); you may not use this file except in compliance
|
|
with the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing,
|
|
software distributed under the License is distributed on an
|
|
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
KIND, either express or implied. See the License for the
|
|
specific language governing permissions and limitations
|
|
under the License.
|
|
-->
|
|
|
|
# Apache Airflow
|
|
|
|
[](https://badge.fury.io/py/apache-airflow)
|
|
[](https://github.com/apache/airflow/actions)
|
|
[](https://codecov.io/github/apache/airflow?branch=master)
|
|
[](http://www.apache.org/licenses/LICENSE-2.0.txt)
|
|
[](https://pypi.org/project/apache-airflow/)
|
|
[](https://hub.docker.com/r/apache/airflow)
|
|
[](https://hub.docker.com/r/apache/airflow)
|
|
[](https://pypi.org/project/apache-airflow/)
|
|
[](https://github.com/psf/black)
|
|
[](https://twitter.com/ApacheAirflow)
|
|
[](https://s.apache.org/airflow-slack)
|
|
|
|
[Apache Airflow](https://airflow.apache.org/docs/stable/) (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.
|
|
|
|
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
|
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
**Table of contents**
|
|
|
|
- [Project Focus](#project-focus)
|
|
- [Principles](#principles)
|
|
- [Requirements](#requirements)
|
|
- [Support for Python versions](#support-for-python-versions)
|
|
- [Getting started](#getting-started)
|
|
- [Installing from PyPI](#installing-from-pypi)
|
|
- [Official source code](#official-source-code)
|
|
- [Convenience packages](#convenience-packages)
|
|
- [User Interface](#user-interface)
|
|
- [Contributing](#contributing)
|
|
- [Who uses Apache Airflow?](#who-uses-apache-airflow)
|
|
- [Who Maintains Apache Airflow?](#who-maintains-apache-airflow)
|
|
- [Can I use the Apache Airflow logo in my presentation?](#can-i-use-the-apache-airflow-logo-in-my-presentation)
|
|
- [Airflow merchandise](#airflow-merchandise)
|
|
- [Links](#links)
|
|
|
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
|
|
## Project Focus
|
|
|
|
Airflow works best with workflows that are mostly static and slowly changing. When DAG structure is similar from one run to the next, it allows for clarity around unit of work and continuity. Other similar projects include [Luigi](https://github.com/spotify/luigi), [Oozie](https://oozie.apache.org/) and [Azkaban](https://azkaban.github.io/).
|
|
|
|
Airflow is commonly used to process data, but has the opinion that tasks should ideally be idempotent (i.e. results of the task will be the same, and will not create duplicated data in a destination system), and should not pass large quantities of data from one task to the next (though tasks can pass metadata using Airflow's [Xcom feature](https://airflow.apache.org/docs/stable/concepts.html#xcoms)). 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, but it is often used to process real-time data, pulling data off streams in batches.
|
|
|
|
## 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.
|
|
|
|
## Requirements
|
|
|
|
Apache Airflow is tested with:
|
|
|
|
| | Master version (dev) | Stable version (2.0.0) | Previous version (1.10.14) |
|
|
| ------------ | ------------------------- | ------------------------ | ------------------------- |
|
|
| Python | 3.6, 3.7, 3.8 | 3.6, 3.7, 3.8 | 2.7, 3.5, 3.6, 3.7, 3.8 |
|
|
| PostgreSQL | 9.6, 10, 11, 12, 13 | 9.6, 10, 11, 12, 13 | 9.6, 10, 11, 12, 13 |
|
|
| MySQL | 5.7, 8 | 5.7, 8 | 5.6, 5.7 |
|
|
| SQLite | latest stable | latest stable | latest stable |
|
|
| Kubernetes | 1.16.9, 1.17.5, 1.18.6 | 1.16.9, 1.17.5, 1.18.6 | 1.16.9, 1.17.5, 1.18.6 |
|
|
|
|
**Note:** MariaDB and MySQL 5.x are unable to or have limitations with
|
|
running multiple schedulers -- please see the "Scheduler" docs.
|
|
|
|
**Note:** SQLite is used in Airflow tests. Do not use it in production.
|
|
|
|
## Support for Python versions
|
|
|
|
As of Airflow 2.0 we agreed to certain rules we follow for Python support. They are based on the official
|
|
release schedule of Python, nicely summarized in the
|
|
[Python Developer's Guide](https://devguide.python.org/#status-of-python-branches)
|
|
|
|
1. We finish support for python versions when they reach EOL (For python 3.6 it means that we will remove it
|
|
from being supported on 23.12.2021).
|
|
|
|
2. The "oldest" supported version of Python is the default one. "Default" is only meaningful in terms of
|
|
"smoke tests" in CI PRs which are run using this default version.
|
|
|
|
3. We support a new version of Python after it is officially released, as soon as we manage to make
|
|
it works in our CI pipeline (which might not be immediate) and release a new version of Airflow
|
|
(non-Patch version) based on this CI set-up.
|
|
|
|
### Additional notes on Python version requirements
|
|
|
|
* Previous version [requires](https://github.com/apache/airflow/issues/8162) 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](https://airflow.apache.org/installation.html), [getting started](https://airflow.apache.org/start.html), or walking through a more complete [tutorial](https://airflow.apache.org/tutorial.html).
|
|
|
|
> Note: If you're looking for documentation for master branch (latest development branch): you can find it on [s.apache.org/airflow-docs](https://s.apache.org/airflow-docs/).
|
|
|
|
For more information on Airflow's Roadmap or Airflow Improvement Proposals (AIPs), visit the [Airflow Wiki](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Home).
|
|
|
|
Official Docker (container) images for Apache Airflow are described in [IMAGES.rst](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:
|
|
|
|
NOTE!!!
|
|
|
|
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
|
|
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
|
|
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
|
|
`pip install --upgrade pip==20.2.4` or, in case you use Pip 20.3, you need to add option
|
|
`--use-deprecated legacy-resolver` to your pip install command.
|
|
|
|
|
|
```bash
|
|
pip install apache-airflow==1.10.14 \
|
|
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-1.10.14/constraints-3.7.txt"
|
|
```
|
|
|
|
2. Installing with extras (for example postgres,google)
|
|
|
|
```bash
|
|
pip install apache-airflow[postgres,google]==1.10.14 \
|
|
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-1.10.14/constraints-3.7.txt"
|
|
```
|
|
|
|
For information on installing backport providers check [/docs/backport-providers.rst][/docs/backport-providers.rst].
|
|
|
|
## Official source code
|
|
|
|
Apache Airflow is an [Apache Software Foundation](http://www.apache.org) (ASF) project,
|
|
and our official source code releases:
|
|
|
|
- Follow the [ASF Release Policy](http://www.apache.org/legal/release-policy.html)
|
|
- Can be downloaded from [the ASF Distribution Directory](https://downloads.apache.org/airflow)
|
|
- Are cryptographically signed by the release manager
|
|
- Are officially voted on by the PMC members during the
|
|
[Release Approval Process](http://www.apache.org/legal/release-policy.html#release-approval)
|
|
|
|
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](https://pypi.org/project/apache-airflow/) to install Airflow using standard `pip` tool
|
|
- [Docker Images](https://hub.docker.com/repository/docker/apache/airflow) 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](https://airflow.apache.org/docs/apache-airflow/stable/production-deployment.html), and
|
|
learn details on the internals in the [IMAGES.rst](IMAGES.rst) document.
|
|
- [Tags in GitHub](https://github.com/apache/airflow/tags) 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.
|
|
|
|
## 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](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst).
|
|
|
|
## Who uses Apache Airflow?
|
|
|
|
More than 350 organizations are using Apache Airflow [in the wild](https://github.com/apache/airflow/blob/master/INTHEWILD.md).
|
|
|
|
## Who Maintains Apache Airflow?
|
|
|
|
Airflow is the work of the [community](https://github.com/apache/airflow/graphs/contributors),
|
|
but the [core committers/maintainers](https://people.apache.org/committers-by-project.html#airflow)
|
|
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](https://airflow.apache.org/docs/stable/project.html#committers).
|
|
|
|
## Can I use the Apache Airflow logo in my presentation?
|
|
|
|
Yes! Be sure to abide by the Apache Foundation [trademark policies](https://www.apache.org/foundation/marks/#books) and the Apache Airflow [Brandbook](https://cwiki.apache.org/confluence/display/AIRFLOW/Brandbook). The most up to date logos are found in [this repo](/docs/apache-airflow/img/logos) and on the Apache Software Foundation [website](https://www.apache.org/logos/about.html).
|
|
|
|
## Airflow merchandise
|
|
|
|
If you would love to have Apache Airflow stickers, t-shirt etc. then check out
|
|
[Redbubble Shop](https://www.redbubble.com/i/sticker/Apache-Airflow-by-comdev/40497530.EJUG5).
|
|
|
|
## Links
|
|
|
|
- [Documentation](https://airflow.apache.org/docs/stable/)
|
|
- [Chat](https://s.apache.org/airflow-slack)
|