Skip to content

Rename --extras to --airflow-extras from breeze prod-image build command#42077

Merged
vincbeck merged 1 commit into
apache:mainfrom
aws-mwaa:vincbeck/extras_doc
Sep 6, 2024
Merged

Rename --extras to --airflow-extras from breeze prod-image build command#42077
vincbeck merged 1 commit into
apache:mainfrom
aws-mwaa:vincbeck/extras_doc

Conversation

@vincbeck

@vincbeck vincbeck commented Sep 6, 2024

Copy link
Copy Markdown
Contributor

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

@ferruzzi

ferruzzi commented Sep 6, 2024

Copy link
Copy Markdown
Contributor

Looks like --extras was replaced with --airflow-extras in #23562 here so rather than remove it, maybe just update the correct new flag?

@vincbeck

vincbeck commented Sep 6, 2024

Copy link
Copy Markdown
Contributor Author

Looks like --extras was replaced with --airflow-extras in #23562 here so rather than remove it, maybe just update the correct new flag?

You're right, nice catch! The difference between airflow-extras and --additional-airflow-extras is not clear to me though

@ferruzzi

ferruzzi commented Sep 6, 2024

Copy link
Copy Markdown
Contributor

The difference between airflow-extras and --additional-airflow-extras is not clear to me though

Yeah, I'm not 100% on the distinction there, but based on the documentation changes in that PR I linked I'm fairly confident that --airflow-extras was a direct replacement for -extras.

I think --additional* is supposed to append to the existing --airflow-extras, but I'm not sure.

@vincbeck vincbeck force-pushed the vincbeck/extras_doc branch from 2c06492 to e5a977a Compare September 6, 2024 18:33
@vincbeck vincbeck changed the title Remove --extras from documentation Rename --extras to --airflow-extras from breeze prod-image build command Sep 6, 2024
@vincbeck

vincbeck commented Sep 6, 2024

Copy link
Copy Markdown
Contributor Author

Fixed :)

@potiuk

potiuk commented Sep 6, 2024

Copy link
Copy Markdown
Member

Yeah, I'm not 100% on the distinction there, but based on the documentation changes in that PR I linked I'm fairly confident that --airflow-extras was a direct replacement for -extras.

I think --additional* is supposed to append to the existing --airflow-extras, but I'm not sure.

That was exactly the intention :). Any improvement to wording to explain it better is most welcome.

@ferruzzi

ferruzzi commented Sep 6, 2024

Copy link
Copy Markdown
Contributor

Some checks aren't passing, but they don't look related. Feel free to merge once those go green.

@vincbeck

vincbeck commented Sep 6, 2024

Copy link
Copy Markdown
Contributor Author

Yeah, I'm not 100% on the distinction there, but based on the documentation changes in that PR I linked I'm fairly confident that --airflow-extras was a direct replacement for -extras.
I think --additional* is supposed to append to the existing --airflow-extras, but I'm not sure.

That was exactly the intention :). Any improvement to wording to explain it better is most welcome.

I meant what is the value of having --airflow-extras and --additional-airflow-extras and not only one. What is the difference between breeze prod-image build --airflow-extras extra1 --additional-airflow-extras extra2 and breeze prod-image build --airflow-extras extra1,extra2? It is more for my curiosity than a concern :)

@potiuk

potiuk commented Sep 6, 2024

Copy link
Copy Markdown
Member

--additional is when you want to add one or two providers to the default ones

--extraa is when you want to change the base set of extras

This makes a difference for example when you build slim image. Default PROD dockerfile adds about 20 or so extras (commonly used providers - Amazon, Google, etc.) . Slim image had only the pre installed providers which means that --extras is empty.

So in short : use --additional when you want to extend 'reference' image. Use --extras when you want to slim-down the basic set of extras that the reference image has

@vincbeck

vincbeck commented Sep 6, 2024

Copy link
Copy Markdown
Contributor Author

--additional is when you want to add one or two providers to the default ones

--extraa is when you want to change the base set of extras

This makes a difference for example when you build slim image. Default PROD dockerfile adds about 20 or so extras (commonly used providers - Amazon, Google, etc.) . Slim image had only the pre installed providers which means that --extras is empty.

So in short : use --additional when you want to extend 'reference' image. Use --extras when you want to slim-down the basic set of extras that the reference image has

That makes perfect sense! Thanks!

@vincbeck vincbeck merged commit 1da4b14 into apache:main Sep 6, 2024
@vincbeck vincbeck deleted the vincbeck/extras_doc branch September 6, 2024 21:24
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.

3 participants