Skip to content
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

Add information for users who ask for requirements #32262

Merged
merged 3 commits into from
Jul 1, 2023

Conversation

potiuk
Copy link
Member

@potiuk potiuk commented Jun 29, 2023

This change is based on a number of discussions with the users asking what are the minimum requirements for Airflow to run.

While we cannot give precise answer, we should also make the users aware that simple answers are not possible, and that when they are deciding to install airflow and manage it on their own, they also take the responsibility to monitor and adjust the resources they need based on the monitoring they have to run.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@potiuk
Copy link
Member Author

potiuk commented Jun 29, 2023

This one is an effort to have a place where we can sand our users when they ask "what are minimum requirements".

As there is not an easy answer, I kept on answering various users different variants of the answer "why it is impossible". This is an attempt to make a distilled answer that resonated with many users - they don't realise that in the modern computing and especially when you have complex system like Airflow running on top of multi-layer deployment tooling you cannot just have "min requirements" that you will set in advance - you should approach it differently and this is an attempt to explain it.

Comments are welcome!

docs/apache-airflow/installation/index.rst Outdated Show resolved Hide resolved
docs/apache-airflow/installation/index.rst Outdated Show resolved Hide resolved
docs/apache-airflow/installation/index.rst Outdated Show resolved Hide resolved
This change is based on a number of discussions with the users asking
what are the minimum requirements for Airflow to run.

While we cannot give precise answer, we should also make the users
aware that simple answers are not possible, and that when they are
deciding to install airflow and manage it on their own, they also
take the responsibility to monitor and adjust the resources they
need based on the monitoring they have to run.
@potiuk potiuk force-pushed the update-requirements-information branch from 537b24e to 17ee7d1 Compare June 30, 2023 09:24
@potiuk potiuk changed the title Add information for users who ask for requirements of Airflow in prod… Add information for users who ask for requirements Jun 30, 2023
@potiuk
Copy link
Member Author

potiuk commented Jun 30, 2023

Thanks @Adaverse -> looking for more inputs/comments. BTW. Maybe there are other ways we can give a helpful advice to our users without explicitly stating requirements (which is impossible).

docs/apache-airflow/installation/index.rst Outdated Show resolved Hide resolved
docs/apache-airflow/installation/index.rst Outdated Show resolved Hide resolved
The requirements that Airflow might need depend on many factors, including (but not limited to):
* The deployment your Airflow is installed with (see above ways of installing Airflow)
* The requirements of the Deployment environment (for example Kubernetes, Docker, Helm, etc.) that
are completely independent from Airflow (for example DNS resources, sharing the nodes/resources
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we're missing to close the ( opened here

docs/apache-airflow/installation/index.rst Outdated Show resolved Hide resolved
docs/apache-airflow/installation/index.rst Outdated Show resolved Hide resolved
docs/apache-airflow/installation/index.rst Outdated Show resolved Hide resolved
docs/apache-airflow/installation/index.rst Outdated Show resolved Hide resolved
docs/apache-airflow/installation/index.rst Outdated Show resolved Hide resolved
Co-authored-by: Pankaj Koti <pankajkoti699@gmail.com>
@potiuk
Copy link
Member Author

potiuk commented Jun 30, 2023

Applied @pankajkoti review

@potiuk potiuk merged commit f6db66e into apache:main Jul 1, 2023
@potiuk potiuk deleted the update-requirements-information branch July 1, 2023 21:56
@potiuk potiuk added this to the Airlfow 2.6.3 milestone Jul 1, 2023
@ephraimbuddy ephraimbuddy added the type:doc-only Changelog: Doc Only label Jul 6, 2023
ephraimbuddy pushed a commit that referenced this pull request Jul 6, 2023
* Add information for users who ask for requirements

This change is based on a number of discussions with the users asking
what are the minimum requirements for Airflow to run.

While we cannot give precise answer, we should also make the users
aware that simple answers are not possible, and that when they are
deciding to install airflow and manage it on their own, they also
take the responsibility to monitor and adjust the resources they
need based on the monitoring they have to run.

* Apply suggestions from code review

Co-authored-by: Pankaj Koti <pankajkoti699@gmail.com>

* Update docs/apache-airflow/installation/index.rst

---------

Co-authored-by: Pankaj Koti <pankajkoti699@gmail.com>
(cherry picked from commit f6db66e)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:Scheduler including HA (high availability) scheduler kind:documentation type:doc-only Changelog: Doc Only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants