https://github.com/idealista/airflow-role
Ansible role to install Apache Airflow
https://github.com/idealista/airflow-role
airflow airflow-role ansible ansible-role apache-airflow debian
Last synced: 8 months ago
JSON representation
Ansible role to install Apache Airflow
- Host: GitHub
- URL: https://github.com/idealista/airflow-role
- Owner: idealista
- License: apache-2.0
- Created: 2017-07-17T08:53:18.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-02-27T16:45:56.000Z (over 1 year ago)
- Last Synced: 2025-03-29T05:06:56.188Z (about 1 year ago)
- Topics: airflow, airflow-role, ansible, ansible-role, apache-airflow, debian
- Language: YAML
- Homepage:
- Size: 302 KB
- Stars: 81
- Watchers: 30
- Forks: 53
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Apache Airflow Ansible role
 [](https://galaxy.ansible.com/idealista/clickhouse_role) [](https://travis-ci.org/idealista/airflow-role)
This ansible role installs a Apache Airflow server in a Debian/Ubuntu environment.
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites-ballot_box_with_check)
- [Installing](#installing-inbox_tray )
- [Usage](#usage-runner)
- [Testing](#testing-test_tube)
- [Built With](#built-with-building_construction)
- [Versioning](#versioning-card_file_box)
- [Authors](#authors-superhero)
- [License](#license-spiral_notepad)
- [Contributing](#contributing-construction_worker)
## Getting Started
These instructions will get you a copy of the role for your ansible playbook. Once launched, it will install [Apache Airflow](https://airflow.apache.org/) in a Debian or Ubuntu system.
### Prerequisites :ballot_box_with_check:
Ansible >= 2.9.9 version installed (Tested with 2.18).
Inventory destination should be a Debian (preferable Debian >= 10 Buster ) or Ubuntu environment.
ℹ️ This role should work with older versions of Debian but you need to know that due to Airflow minimum requirements you should check that 🐍 Python 3.8 (or higher) is installed before (👉 See: [Airflow prerequisites](https://airflow.apache.org/docs/apache-airflow/stable/installation/prerequisites.html)).
ℹ️ By default this role use the predefined installation of Python that comes with the distro.
For testing purposes, [Molecule](https://molecule.readthedocs.io/) with [Docker](https://www.docker.com/) as driver.
### Installing :inbox_tray:
Create or add to your roles dependency file (e.g requirements.yml) from GitHub:
```yml
- src: http://github.com/idealista/airflow-role.git
scm: git
version: 3.0.0
name: airflow
```
or using [Ansible Galaxy](https://galaxy.ansible.com/idealista/airflow-role/) as origin if you prefer:
```yml
- src: idealista.airflow_role
version: 3.0.0
name: airflow
```
Install the role with ansible-galaxy command:
```shell
ansible-galaxy install -p roles -r requirements.yml -f
```
Use in a playbook:
```yml
---
- hosts: someserver
roles:
- { role: airflow }
```
## Usage :runner:
Look to the defaults properties files to see the possible configuration properties, take a look for them:
- [`main.yml`](./defaults/main/main.yml) for airflow general purpose.
- [`airflow-cfg.yml`](./defaults/main/airflow-cfg.yml) for all the related airflow.cfg config parameters.
- [`webserver-config-py.yml`](./defaults/main/webserver-config-py.yml) for all the related webserver_config.py config parameters.
❗Attention:❗
- ⚠️ This version is no longer compatible with Apache Airflow 1.x versions.
- ⚠️ Check out the new way to set airflow.cfg parameters in [`airflow-cfg.yml`](./defaults/main/airflow-cfg.yml) file.
👉 Don't forget :
- 🦸 To set your Admin user.
- 🔑 To set Fernet key.
- 🔑 To set webserver secret key.
- 📝 To set your AIRFLOW_HOME and AIRFLOW_CONFIG at your own discretion.
- 📝 To set your installation and config skelton paths at your own discretion.
- 👉 See `airflow_skeleton_paths` in [`main.yml`](./defaults/main/main.yml)
- 🐍 Python and pip version.
- 📦 [Extra packages](#package-Extra-packages) if you need additional operators, hooks, sensors...
- 📦 [Required Python packages](#package-Required-Python-packages) with version specific like SQLAlchemy for example (to avoid known Airflow bugs❗️) like below or because are necessary
### :package: Required Python packages
[`airflow_required_python_packages`](./defaults/main/main.yml) should be a list following this format:
```yml
# This is an example of how to set the required python packages
airflow_required_python_packages:
- { name: SQLAlchemy, version: major.minor.patch }
- { name: psycopg2 }
- {name: pyasn1}
```
### :package: Extra packages
[`airflow_extra_packages`](./defaults/main/main.yml) should be a list following this format:
```yml
# This is an example of how to set the extra packages
airflow_extra_packages:
- apache.atlas
- celery
- ssh
```
👉 For more info about this extra packages see: [Airflow extra packages](https://airflow.apache.org/docs/apache-airflow/stable/extra-packages-ref.html)
## Testing :test_tube:
```bash
pipenv install -r test-requirements.txt --python 3.12
# Optional
pipenv shell # if in shell just use `molecule COMMAND`
pipenv run molecule test # To run role test
# or
pipenv run molecule converge # To run play with the role
```
## Built With :building_construction:
## Versioning :card_file_box:
For the versions available, see the [tags on this repository](https://github.com/idealista/airflow-role/tags).
Additionally you can see what change in each version in the [CHANGELOG.md](CHANGELOG.md) file.
## Authors :superhero:
- **Idealista** - *Work with* - [idealista](https://github.com/idealista)
See also the list of [contributors](https://github.com/idealista/airflow-role/contributors) who participated in this project.
## License :spiral_notepad:
This project is licensed under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license - see the [LICENSE](LICENSE) file for details.
## Contributing :construction_worker:
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.