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

Clearer documentation about production image usage #10363

Closed
potiuk opened this issue Aug 17, 2020 · 4 comments
Closed

Clearer documentation about production image usage #10363

potiuk opened this issue Aug 17, 2020 · 4 comments

Comments

@potiuk
Copy link
Member

potiuk commented Aug 17, 2020

Description

We have quite comprehensive documentation about Docker Images used (https://github.com/apache/airflow/blob/master/IMAGES.rst) however it can be quite overwhelming for image users who just want to use it and possibly customize the image without having to know all the internals.

There is a small section about Production Images in https://github.com/apache/airflow/#official-docker-images but it likely need to be a bit updated and possibly some information from the IMAGES.rst can be copied or moved here (and some new information added). It should be mostly focused on users, not developers of the image.

I think the content of that section could consist of:

  1. Context - what the prod image is and where it can be used + explanation that in DockerHub there is just a convenience binary and that image can (and often should) be built from the officially released sources.
  2. Naming and links to the Production Images
  3. Describe two options for the image - customization/extension
  4. Short how-to on how to build image using Breeze (this is the easiest way for now).
  5. link to https://youtu.be/wDr3Y7q2XoI - Airflow Summit 2020's "Production Docker Image" talk where context, architecture and customization/extension methods are explained.

Use case / motivation

Make it easier for casual or first-time users to understand how they can use the image.

@sanjana1604
Copy link
Contributor

@potiuk I would like to solve this issue.

@potiuk
Copy link
Member Author

potiuk commented Aug 18, 2020

Feel free :). Assigned you to it and happy to review it!

@sanjana1604
Copy link
Contributor

@potiuk need more clarification on first point (context).

@potiuk
Copy link
Member Author

potiuk commented Aug 23, 2020

@sanjana1604 The context is described mostly in http://www.apache.org/legal/release-policy.html - Apache releases software as sources, so the binaries are released mostly as convenience packaging, not the official releases. I think this can be left as TODO and I am happy to add some content there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants