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

Improve message and documentation around moved data #19453

Conversation

potiuk
Copy link
Member

@potiuk potiuk commented Nov 7, 2021

In Airflow 2.2.1 we introduced a fix in #18953 where the corrupted
data was moved to a separate table. However some of our users
(rightly) might not have the context. We've never had anything
like that before, so the users who treat Airflow DB as
black-boxes might get confused on what the error means and what
they should do in this case.

You can see it in #19440 converted into discussion #19444 and #19421
indicate that the message is a bit unclear for users. This PR attempts to
improve that it adds upgrading section to our documentation and have the
message link to it so that rather than asking questions in the issues,
users can find context and answers what they should do in our docs.

It also guides the users who treat Airflow DB as "black-box" on how they
can use their tools and airflow db shell to fix the problem.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, 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 UPDATING.md.

@boring-cyborg boring-cyborg bot added area:UI Related to UI/UX. For Frontend Developers. area:webserver Webserver related Issues kind:documentation labels Nov 7, 2021
@potiuk potiuk requested a review from uranusjr November 7, 2021 11:39
@potiuk
Copy link
Member Author

potiuk commented Nov 8, 2021

Should we merge that one?

airflow/www/templates/airflow/dags.html Show resolved Hide resolved
docs/apache-airflow/installation/upgrading.rst Outdated Show resolved Hide resolved
docs/apache-airflow/installation/upgrading.rst Outdated Show resolved Hide resolved
docs/apache-airflow/installation/upgrading.rst Outdated Show resolved Hide resolved
docs/apache-airflow/installation/upgrading.rst Outdated Show resolved Hide resolved
docs/apache-airflow/installation/upgrading.rst Outdated Show resolved Hide resolved
docs/apache-airflow/installation/upgrading.rst Outdated Show resolved Hide resolved
docs/apache-airflow/installation/upgrading.rst Outdated Show resolved Hide resolved
docs/apache-airflow/installation/upgrading.rst Outdated Show resolved Hide resolved
airflow/www/templates/airflow/dags.html Outdated Show resolved Hide resolved
@jedcunningham jedcunningham added this to the Airflow 2.2.2 milestone Nov 8, 2021
@lukasnalezenec
Copy link

Hi, can we add some simple logging message to code ?

@potiuk
Copy link
Member Author

potiuk commented Nov 9, 2021

Hi, can we add some simple logging message to code ?

airflow db upgrade does not have logging. It will print the output to stdout.

@potiuk potiuk force-pushed the add-more-context-and-helpful-advice-for-post-migration-actions branch from eaf2d41 to f6e60a3 Compare November 9, 2021 20:19
@potiuk
Copy link
Member Author

potiuk commented Nov 9, 2021

Thanks for the commends @jedcunningham @uranusjr @kaxil - I think it's much better now :)

Proposal: if it won't make it in 2.2.2 (I doubt now) - then we can cherry-pick that one to v2-2-test and build docs using it so that at least the docs are published with 2.2.2 release :)

In Airflow 2.2.2 we introduced a fix in apache#18953 where the corrupted
data was moved to a separate table. However some of our users
(rightly) might not have the context. We've never had anything
like that before, so the users who treat Airflow DB as
black-boxes might get confused on what the error means and what
they should do in this case.

You can see it in apache#19440 converted into discussion apache#19444 and apache#19421
indicate that the message is a bit unclear for users. This PR attempts to
improve that it adds `upgrading` section to our documentation and have the
message link to it so that rather than asking questions in the issues,
users can find context and answers what they should do in our docs.

It also guides the users who treat Airflow DB as "black-box" on how they
can use their tools and airflow db shell to fix the problem.
@potiuk potiuk force-pushed the add-more-context-and-helpful-advice-for-post-migration-actions branch from f6e60a3 to 5ed9c43 Compare November 10, 2021 13:42
docs/apache-airflow/installation/upgrading.rst Outdated Show resolved Hide resolved
airflow/www/templates/airflow/dags.html Outdated Show resolved Hide resolved
@github-actions github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Nov 10, 2021
@github-actions
Copy link

The PR is likely OK to be merged with just subset of tests for default Python and Database versions without running the full matrix of tests, because it does not modify the core of Airflow. If the committers decide that the full tests matrix is needed, they will add the label 'full tests needed'. Then you should rebase to the latest main or amend the last commit of the PR, and push it with --force-with-lease.

@potiuk potiuk merged commit de43fb3 into apache:main Nov 10, 2021
@potiuk potiuk deleted the add-more-context-and-helpful-advice-for-post-migration-actions branch November 10, 2021 21:08
kaxil pushed a commit that referenced this pull request Nov 11, 2021
* Improve message and documentation around moved data

In Airflow 2.2.2 we introduced a fix in #18953 where the corrupted
data was moved to a separate table. However some of our users
(rightly) might not have the context. We've never had anything
like that before, so the users who treat Airflow DB as
black-boxes might get confused on what the error means and what
they should do in this case.

You can see it in #19440 converted into discussion #19444 and #19421
indicate that the message is a bit unclear for users. This PR attempts to
improve that it adds `upgrading` section to our documentation and have the
message link to it so that rather than asking questions in the issues,
users can find context and answers what they should do in our docs.

It also guides the users who treat Airflow DB as "black-box" on how they
can use their tools and airflow db shell to fix the problem.

(cherry picked from commit de43fb3)
@jedcunningham jedcunningham added the type:bug-fix Changelog: Bug Fixes label Dec 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:UI Related to UI/UX. For Frontend Developers. area:webserver Webserver related Issues kind:documentation okay to merge It's ok to merge this PR as it does not require more tests type:bug-fix Changelog: Bug Fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants