Skip to content

Commit e9b2ff5

Browse files
authored
Add notes about PIP 20.3 breaking Airflow installation (#12840)
Part of #12838
1 parent 12c1fe2 commit e9b2ff5

File tree

11 files changed

+129
-6
lines changed

11 files changed

+129
-6
lines changed

CONTRIBUTING.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Licensed to the Apache Software Foundation (ASF) under one
1+
.. Licensed to the Apache Software Foundation (ASF) under one
22
or more contributor license agreements. See the NOTICE file
33
distributed with this work for additional information
44
regarding copyright ownership. The ASF licenses this file
@@ -532,6 +532,15 @@ than production performance. The production images are not yet officially publis
532532
Airflow dependencies
533533
====================
534534

535+
.. note::
536+
537+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
538+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
539+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
540+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
541+
``--use-deprecated legacy-resolver`` to your pip install command.
542+
543+
535544
Extras
536545
------
537546

@@ -666,6 +675,15 @@ as of airflow 1.10.10 and further improved with 1.10.12 (moved to separate orpha
666675
Pinned constraint files
667676
=======================
668677

678+
.. note::
679+
680+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
681+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
682+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
683+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
684+
``--use-deprecated legacy-resolver`` to your pip install command.
685+
686+
669687
By default when you install ``apache-airflow`` package - the dependencies are as open as possible while
670688
still allowing the apache-airflow package to install. This means that ``apache-airflow`` package might fail to
671689
install in case a direct or transitive dependency is released that breaks the installation. In such case

IMAGES.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,16 @@ parameter to Breeze:
117117
./breeze build-image --python 3.7 --additional-extras=presto \
118118
--production-image --install-airflow-version=1.10.13
119119
120+
121+
.. note::
122+
123+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
124+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
125+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
126+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
127+
``--use-deprecated legacy-resolver`` to your pip install command.
128+
129+
120130
This will build the image using command similar to:
121131

122132
.. code-block:: bash

INSTALL

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ java -jar apache-rat.jar -E ./.rat-excludes -d .
2828
python3 -m venv PATH_TO_YOUR_VENV
2929
source PATH_TO_YOUR_VENV/bin/activate
3030

31+
NOTE!!
32+
33+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
34+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
35+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
36+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
37+
``--use-deprecated legacy-resolver`` to your pip install command.
38+
3139
# [required] building and installing by pip (preferred)
3240
pip install .
3341

LOCAL_VIRTUALENV.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,16 @@ of required packages.
6161
Extra Packages
6262
--------------
6363

64+
.. note::
65+
66+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
67+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
68+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
69+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
70+
``--use-deprecated legacy-resolver`` to your pip install command.
71+
72+
73+
6474
You can also install extra packages (like ``[ssh]``, etc) via
6575
``pip install -e [EXTRA1,EXTRA2 ...]``. However, some of them may
6676
have additional install and setup requirements for your local system.
@@ -114,6 +124,15 @@ To create and initialize the local virtualenv:
114124
115125
2. Install Python PIP requirements:
116126

127+
.. note::
128+
129+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
130+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
131+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
132+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
133+
``--use-deprecated legacy-resolver`` to your pip install command.
134+
135+
117136
.. code-block:: bash
118137
119138
pip install -U -e ".[devel,<OTHER EXTRAS>]" # for example: pip install -U -e ".[devel,google,postgres]"

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,15 @@ correct Airflow tag/version/branch and python versions in the URL.
122122

123123
1. Installing just Airflow:
124124

125+
NOTE!!!
126+
127+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
128+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
129+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
130+
`pip upgrade --pip==20.2.4` or, in case you use Pip 20.3, you need to add option
131+
`--use-deprecated legacy-resolver` to your pip install command.
132+
133+
125134
```bash
126135
pip install apache-airflow==1.10.13 \
127136
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-1.10.13/constraints-3.7.txt"

UPDATING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1668,6 +1668,16 @@ For example:
16681668
If you want to install integration for Microsoft Azure, then instead of `pip install apache-airflow[atlas]`
16691669
you should use `pip install apache-airflow[apache.atlas]`.
16701670

1671+
1672+
NOTE!
1673+
1674+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
1675+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
1676+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
1677+
`pip upgrade --pip==20.2.4` or, in case you use Pip 20.3, you need to add option
1678+
`--use-deprecated legacy-resolver` to your pip install command.
1679+
1680+
16711681
If you want to install integration for Microsoft Azure, then instead of
16721682

16731683
```

UPGRADING_TO_2.0.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,15 @@ assists users migrating to a new version.
5151

5252
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
5353

54+
NOTE!
55+
56+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
57+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
58+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
59+
`pip upgrade --pip==20.2.4` or, in case you use Pip 20.3, you need to add option
60+
`--use-deprecated legacy-resolver` to your pip install command.
61+
62+
5463
## Step 1: Upgrade to Python 3
5564

5665
Airflow 1.10 will be the last release series to support Python 2. Airflow 2.0.0 will require Python 3.6+.
@@ -102,6 +111,15 @@ The most important step in this transition is also the easiest step to do in pie
102111
using the [backport providers](./backport-providers.rst) service. In your own time, you can transition to using these backport-providers
103112
by pip installing the provider via `pypi` and changing the import path.
104113

114+
115+
NOTE!!
116+
117+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
118+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
119+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
120+
`pip upgrade --pip==20.2.4` or, in case you use Pip 20.3, you need to add option
121+
`--use-deprecated legacy-resolver` to your pip install command.
122+
105123
For example: While historically you might have imported the DockerOperator in this fashion:
106124

107125
```python

airflow/providers/discord/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ are in `airflow.providers.discord` python package.
4747

4848
## Installation
4949

50+
5051
You can install this package on top of an existing airflow 2.* installation via
5152
`pip install apache-airflow-providers-discord`
5253

dev/provider_packages/PROVIDER_README_TEMPLATE.md.jinja2

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,14 @@ are in `{{FULL_PACKAGE_NAME}}` python package.
6060

6161
## Installation
6262

63+
NOTE!
64+
65+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
66+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
67+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
68+
`pip upgrade --pip==20.2.4` or, in case you use Pip 20.3, you need to add option
69+
`--use-deprecated legacy-resolver` to your pip install command.
70+
6371
You can install this package on top of an existing airflow 2.* installation via
6472
`pip install {{PACKAGE_PIP_NAME}}`
6573

docs/apache-airflow/installation.rst

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,15 @@ and python versions in the URL.
5050
5151
1. Installing just Airflow
5252

53+
.. note::
54+
55+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
56+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
57+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
58+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
59+
``--use-deprecated legacy-resolver`` to your pip install command.
60+
61+
5362
.. code-block:: bash
5463
5564
AIRFLOW_VERSION=1.10.13
@@ -61,6 +70,15 @@ and python versions in the URL.
6170
6271
2. Installing with extras (for example postgres, google)
6372

73+
.. note::
74+
75+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
76+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
77+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
78+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
79+
``--use-deprecated legacy-resolver`` to your pip install command.
80+
81+
6482
.. code-block:: bash
6583
6684
AIRFLOW_VERSION=1.10.13
@@ -74,11 +92,6 @@ Airflow with such extras, the necessary provider packages are installed automati
7492
PyPI for those packages). However you can freely upgrade and install provider packages independently from
7593
the main Airflow installation.
7694

77-
.. note:: Automated installation of Provider packages does not work in Airflow 2.0.0b1 - for this version
78-
you have to install provider packages manually. As of Airflow 2.0.0b2 the corresponding
79-
provider packages are installed together with the extras.
80-
81-
Read more about it in the :ref:`Provider Packages <installation:provider_packages>` section.
8295

8396
Requirements
8497
''''''''''''

docs/apache-airflow/start.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@
2020
Quick Start
2121
-----------
2222

23+
.. note::
24+
25+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
26+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
27+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
28+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
29+
``--use-deprecated legacy-resolver`` to your pip install command.
30+
31+
2332
The installation is quick and straightforward.
2433

2534
.. code-block:: bash

0 commit comments

Comments
 (0)