forked from apache/airflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor installation pages (apache#18282)
This PR splits ad improves the installation-related documentation for Airflow. The "installation" page had become overloaded wiht everything-but-the-kitchen-sink and it became rather difficult to navigate and link to relevant sections. Also there was not a single page where one could have an overview on different installation methods possible, cases when each instalation works best as well as understanding what is involved in following each installation method in terms of maintenance, and expectations that users should have when it comes to what Apache Airflow Community provides. The PR leaves the installation page as basically a summary of all installation methods with all above explained and links to detailed pages explaining prerequisites, dependencies, database setup and supported versions.
- Loading branch information
Showing
28 changed files
with
891 additions
and
459 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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 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 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 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 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,45 @@ | ||
.. 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. | ||
Installation from PyPI | ||
---------------------- | ||
|
||
.. contents:: :local: | ||
|
||
|
||
This page describes installations using the ``apache-airflow-providers`` package `published in | ||
PyPI <https://pypi.org/search/?q=apache-airflow-providers>`__. | ||
|
||
Installation tools | ||
'''''''''''''''''' | ||
|
||
Only ``pip`` installation is currently officially supported. | ||
|
||
While there are some successes with using other tools like `poetry <https://python-poetry.org/>`_ or | ||
`pip-tools <https://pypi.org/project/pip-tools/>`_, they do not share the same workflow as | ||
``pip`` - especially when it comes to constraint vs. requirements management. | ||
Installing via ``Poetry`` or ``pip-tools`` is not currently supported. If you wish to install airflow | ||
using those tools you should use the constraints and convert them to appropriate | ||
format and workflow that your tool requires. | ||
|
||
Typical command to install airflow from PyPI looks like below (you need to use the right Airflow version and Python version): | ||
|
||
.. code-block:: | ||
pip install "apache-airflow-providers-celery" --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-2.1.4/constraints-3.6.txt" | ||
This is an example, see :doc:`apache-airflow:installation/installing-from-pypi` for more examples, including how to upgrade the providers. |
This file contains 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 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 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
Oops, something went wrong.