potiuk commented on a change in pull request #7832: Add production image support URL: https://github.com/apache/airflow/pull/7832#discussion_r402411621
########## File path: IMAGES.rst ########## @@ -0,0 +1,430 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +.. contents:: :local: + +Airflow docker images +===================== + +Airflow has two images (build from Dockerfiles): + +* CI image (Dockerfile.ci) - used for running tests and local development +* Production image (Dockerfile) - used to run production-ready Airflow installations + +Image naming conventions +======================== + +The images are named as follows: + +``apache/airflow:<BRANCH_OR_TAG>-python<PYTHON_MAJOR_MINOR_VERSION>[-ci][-manifest]`` + +where: + +* BRANCH_OR_TAG - branch or tag used when creating the image. Examples: master, v1-10-test, 1.10.10 + The ``master`` and ``v1-10-test`` labels are built from branches so they change over time. the 1.10.* and in + the future ``2.*`` labels are build from git tags and they are "fixed" once built. +* PYTHON_MAJOR_MINOR_VERSION - version of python used to build the image. Examples: 3.5, 3.7 +* The ``-ci`` suffix is added for CI images +* The ``-manifest`` is added for manifest images (see below for explanation of manifest images) + +Building docker images +====================== + +The easiest way to build those images is to use `<BREEZE.rst>`_. + +You can build the CI image using this command: + +.. code-block:: + + ./breeze build-image + +You can build production image using this command: + +.. code-block:: + + ./breeze build-image --production-image + +By adding ``--python <PYTHON_MAJOR_MINOR_VERSION>`` parameter you can build the +image version for the chosen python version. Review comment: This is the same parameter as used everywhere. It's limitations are shown in BREEZE.rst, `./breeze flags` and autocomplete. tt's also verified when the value is not ok (and correct values are shown). I do not want to repeat it here again, especially that now we have one place that it is changed and Breeze documentation is generated from it. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
