Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Updating 2.0 docs#11842

Merged
dimberman merged 3 commits intoapache:masterfrom
astronomer:updating-2.0-docs
Oct 27, 2020
Merged

Updating 2.0 docs#11842
dimberman merged 3 commits intoapache:masterfrom
astronomer:updating-2.0-docs

Conversation

@dimberman
Copy link
Contributor

This PR creates a one-stop document for users looking to update to Airflow 2.0. This ensures that instead of needing to read through the entire changelog, these users can follow a simple set of steps to prepare for the upgrade.


^ 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.

@dimberman
Copy link
Contributor Author

cc: @vikramkoka @paolaperaza

Copy link
Contributor

@yangrong688 yangrong688 left a comment

Choose a reason for hiding this comment

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

Hi, @dimberman , I found some formatting issues and need to be fixed.

@houqp
Copy link
Member

houqp commented Oct 26, 2020

I remember we are unifying roles in RBAC between web UI and stable API, will that be managed automatically without manual actions from user?

@dimberman
Copy link
Contributor Author

#11842 (comment)

cc: @jhtimmins for this question

@ryw ryw self-requested a review October 27, 2020 14:31
UPDATING.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

not sure we should include "a1" here

Copy link

@paolaperaza paolaperaza left a comment

Choose a reason for hiding this comment

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

@dimberman I just took a first pass at this! Feel free to take or leave suggestions - my comments are mostly copy/grammar/formatting related 😊

Thanks so much for putting this together - a lotta stuff in here! Appreciate it.

Choose a reason for hiding this comment

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

@dimberman Should we change this header to # Upgrade to Airflow 2.0+? It's in the file name, but might be good to reiterate in this H1 here as well.

Choose a reason for hiding this comment

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

Airflow 2.0.0 will only support Python 3.6 and up. > Airflow 2.0.0 will require Python 3.6+.

Choose a reason for hiding this comment

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

Should we link to info on this Operator?

Choose a reason for hiding this comment

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

I presume we wanted to specify versions here!

For a list of breaking changes between python 2 and python > For a list of breaking changes between Python 2 and Python 3, please refer to this handy blog from the CouchBaseDB team.

Choose a reason for hiding this comment

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

To minimize upgrade friction for Airflow 1.10, we are releasing a "bridge" release that has multiple critical features that can prepare users to upgrade without disrupting existing workflows.

-->

To minimize friction for users upgrading from Airflow 1.10 to Airflow 2.0 and beyond, a "bridge" release and final 1.10 version will be made available. Airflow 1.10.13 includes support for various critical features that make it easy for users to test DAGs and make sure they're Airflow 2.0 compatible without forcing breaking changes and disrupting existing workflows. We strongly recommend that all users upgrading to Airflow 2.0 first upgrade to Airflow 1.10.13.

Features in 1.10.13 include:

Choose a reason for hiding this comment

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

Add link to Stable API reference doc?

Choose a reason for hiding this comment

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

Exception from DAG callbacks used to crash scheduler. In order to make
scheduler more robust, we have changed this behavior to log the exception
instead. On top of that, a new dag.callback_exceptions counter metric has
been added to help better monitor callback exceptions.

-->

Exception from DAG callbacks used to crash the Airflow Scheduler. As part of our efforts to make the Scheduler more performant and reliable, we have changed this behavior to log the exception
instead. On top of that, a new dag.callback_exceptions counter metric has
been added to help better monitor callback exceptions.

Choose a reason for hiding this comment

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

--> ### Airflow CLI changes in 2.0

Choose a reason for hiding this comment

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

This could be its own section, for example

UPDATING.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Does deleting this records mean that we won't use UPDATING.md from 2.0 onward?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think that once 2.0 comes out we should create a new UPDATING.md and maybe move UPDATING to "UPDATING-1.0.md"

Copy link
Member

Choose a reason for hiding this comment

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

Those should be in "Appendix" or "reference" section IMHO. or maybe steps should be grouped under the "Migration steps" .

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@potiuk good point. I added an extra level to the TOC and set up an appendix segment. We can even make the primary segments short and link to appendix as needed.

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
airflow generate_pod_template -o <output file path>
```shell script
airflow generate_pod_template -o <output file path>
` ``

Copy link
Member

Choose a reason for hiding this comment

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

can't add ``` :(

Copy link
Member

Choose a reason for hiding this comment

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

Same here ```shell script would be nice

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Note that this backport-provider is *not* the same as the actual provider in 2.0. We have tested these operators for backwards
Note that the backport provider packages are just backports of the provider packages compatible with Airflow 2.0. Those provider packages are installed automatically when you install airflow with extras. For example
pip install airflow[docker]
automatically installs the `apache-airflow-providers-docker` package.
But you can manage/upgrade remove provider packages separately from the airflow core.

@potiuk
Copy link
Member

potiuk commented Oct 27, 2020

Some initial review

@potiuk
Copy link
Member

potiuk commented Oct 27, 2020

(did not have yet time to do it all)

@ryw
Copy link
Member

ryw commented Oct 27, 2020

@dimberman I'd say address comments then get this merged today, then everyone can improve sections in smaller PRs.

Copy link
Contributor Author

@dimberman dimberman left a comment

Choose a reason for hiding this comment

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

@ryw good call. I'll address comments, merge today, and we can clean up in smaller PRs.

@dimberman dimberman merged commit c204a2e into apache:master Oct 27, 2020
@dimberman dimberman deleted the updating-2.0-docs branch October 27, 2020 19:54
@dimberman
Copy link
Contributor Author

@potiuk @ashb @kaxil I'm going by @ryw 's suggestion and merging this first draft to prevent this from becoming a monstrous PR for documentation that we need out ASAP to get people on the right track. Over the next few days we can continue PRing against this document and get it to where we want it.

@paolaperaza
Copy link

@dimberman Awesome, I'll followup with another PR then! Thanks.

michalmisiewicz pushed a commit to michalmisiewicz/airflow that referenced this pull request Oct 30, 2020
* Separate 2.0 upgrade steps into their own file

* shell script

* more changes
szn pushed a commit to szn/airflow that referenced this pull request Nov 1, 2020
* Separate 2.0 upgrade steps into their own file

* shell script

* more changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants