-
Notifications
You must be signed in to change notification settings - Fork 16.3k
Add Apache Airflow setup instructions for Apple Silicon #50179
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
Merged
Merged
Changes from all commits
Commits
Show all changes
47 commits
Select commit
Hold shift + click to select a range
b65254d
Add setup guide for Apache Airflow on Mac M1 and above
praneeth552 5b3c3f9
Add Apple Silicon setup instructions for Apache Airflow
praneeth552 e8d76b8
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 ba39797
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 b55b283
Update README.md
praneeth552 db096a9
Update README.md
praneeth552 c2b9c89
clean up the doc
praneeth552 3c8dd7a
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 9e9c156
further polished and refined the doc
praneeth552 ed733f4
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 fff3a69
Moved installation instructions to INSTALLING.md
praneeth552 97a6e79
Merge branch 'apache:main' into airflow-mac-setup-doc
praneeth552 2620f5b
Merge branch 'airflow-mac-setup-doc' of https://github.com/praneeth55…
praneeth552 6bc7433
Refined entire installation section in README.MD and moved to INSTALL…
praneeth552 c80dbcf
further refined
praneeth552 de230c1
Merge branch 'apache:main' into airflow-mac-setup-doc
praneeth552 207473a
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 3d8a9d5
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 38eaf55
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 a780674
Merge branch 'apache:main' into airflow-mac-setup-doc
praneeth552 7149184
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 8581675
Merge branch 'apache:main' into airflow-mac-setup-doc
praneeth552 8977b05
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 eedf805
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 974515f
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 bb742bc
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 1d3ce0e
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 eabb51a
separated the installation steps
praneeth552 faab8c2
Merge branch 'airflow-mac-setup-doc' of https://github.com/praneeth55…
praneeth552 d763f77
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 dfbdd5b
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 20877bf
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 a7a42a8
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 fd821a6
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 2db62f2
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 e6a3bca
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 23baf14
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 3de015c
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 1597a78
moved to down of the PyPI
praneeth552 0ee2984
Merge branch 'airflow-mac-setup-doc' of https://github.com/praneeth55…
praneeth552 6e60525
Merge branch 'apache:main' into airflow-mac-setup-doc
praneeth552 f2e640c
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 b871a23
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 ef4bf09
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 564264b
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 d582ed3
Merge branch 'apache:main' into airflow-mac-setup-doc
praneeth552 e0b0f0e
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| <!-- | ||
| 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. | ||
| --> | ||
|
|
||
| ## Local Development Setup | ||
|
|
||
| This section outlines a recommended approach for setting up a local development environment for Apache Airflow on macOS and Linux, primarily using PyEnv for Python version management. | ||
|
|
||
| > ⚠️ Avoid using either system-installed Python or Python from Homebrew, as these versions are often labeled `--externally-managed` resulting in restricted dependency installation. | ||
|
|
||
| You can use other ways to install Python and airflow. Airflow development setup requires `uv` and if you want to setup environment for development, `uv` is the only supported local development environment setup, because we are using `uv workspace` extensively. See [local virtualenv setup in contributing docs](https://github.com/apache/airflow/blob/main/contributing-docs/07_local_virtualenv.rst) for details. | ||
|
|
||
| If you are just installing airflow to run it locally, You can use other ways to set up your Python and virtualenv: `uv` is one of the options (refer to `uv` documentation), but you can also use more traditional tools - for example `pyenv`. Note that it is recommended to install airflow with constraints - at least initially - because this way you can reproducibly install airflow. See [Installation from PyPI](https://airflow.apache.org/docs/apache-airflow/stable/installation/installing-from-pypi.html) for more details. | ||
|
|
||
| ### ✅ Setup using pyenv: | ||
|
|
||
| 1. **Install pyenv (macOS and Linux)**: | ||
|
|
||
| ```bash | ||
| brew install pyenv | ||
| ``` | ||
|
|
||
| (Note: Homebrew is the recommended method on macOS. For Linux, you can typically install pyenv using the `pyenv-installer` script as detailed in the official documentation: [https://github.com/pyenv/pyenv#installation](https://github.com/pyenv/pyenv#installation).) | ||
|
|
||
| 2. **Install Python**: | ||
|
|
||
| ```bash | ||
| pyenv install 3.11.9 | ||
| pyenv global 3.11.9 | ||
| ``` | ||
|
|
||
| 3. **Check Python version**: | ||
|
|
||
| ```bash | ||
| python --version | ||
| ``` | ||
|
|
||
| 4. **Create and Activate a Virtual Environment**: Since Apache Airflow requires multiple dependencies, it's a good practice to isolate these dependencies in a virtual environment. | ||
|
|
||
| - Create a virtual environment: | ||
|
|
||
| ```bash | ||
| python -m venv airflow_venv | ||
| ``` | ||
|
|
||
| - Activate the virtual environment: | ||
|
|
||
| ```bash | ||
| source airflow_venv/bin/activate | ||
| ``` | ||
|
|
||
| 5. **Install Apache Airflow**: Apache Airflow is available on PyPI. To install it, you can use the following command in your terminal: | ||
|
|
||
| ```bash | ||
| pip install apache-airflow==3.0.0 --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-3.0.0/constraints-3.11.txt" | ||
| ``` | ||
|
|
||
| Note that installing with constraints - at least initially - is recommended for reproducible installation. It might sometimes happen that 3rd-party distributions are released and their latest versions break airflow. Using constraints makes the installation reproducible with versions of dependencies that were "frozen" at the time of releasing airflow. Note you have to specify both - airflow version and Python version you are using. | ||
|
|
||
| You can also specify additional extras - when you want to install airflow with additional providers: | ||
|
|
||
| ```bash | ||
| pip install apache-airflow[amazon,google]==3.0.0 --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-3.0.0/constraints-3.11.txt" | ||
| ``` | ||
|
|
||
| 6. **Set the AIRFLOW_HOME Environment Variable**: Apache Airflow requires a directory to store configuration files, logs, and other data. Set the AIRFLOW_HOME variable to specify this directory. | ||
|
|
||
| - Set the Airflow home directory: | ||
|
|
||
| ```bash | ||
| export AIRFLOW_HOME=~/airflow | ||
| ``` | ||
|
|
||
| 7. **Run Airflow in standalone mode**: Apache Airflow runs several components, like the scheduler, web server, and API server, to manage workflows and show the UI. | ||
|
|
||
| - To run Airflow in standalone mode (which will automatically start the required components): | ||
|
|
||
| ```bash | ||
| airflow standalone | ||
| ``` | ||
|
|
||
| 8. **Access the Airflow Web UI**: Once the components are up and running, you can access the Airflow UI through your browser: | ||
|
|
||
| - Open your browser and go to: | ||
|
|
||
| ```text | ||
| http://localhost:8080 | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.