kszucs commented on a change in pull request #7021: URL: https://github.com/apache/arrow/pull/7021#discussion_r419413778
########## File path: docs/source/developers/docker.rst ########## @@ -0,0 +1,143 @@ +.. raw:: html + + <!-- + 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. + --> + +Running Docker Builds +===================== + +Most of our Linux based continuous integration tasks are decoupled from public +CI services using docker and docker-compose. Keeping the CI configuration +minimal makes local reproducibility possible. + +Usage +----- + +There are multiple ways to execute the docker based builds. The recommented is +to use the archery tool: + +Installation: + +.. code:: bash + + pip install -e dev/archery[docker] + +Execute a build: + +.. code::bash + + archery docker run conda-python + +Archery calls the following docker-compose commands: + +.. code::bash + + docker-compose pull --ignore-pull-failures conda-cpp + docker-compose build conda-cpp + docker-compose pull --ignore-pull-failures conda-python + docker-compose build conda-python + docker-compose run --rm conda-python + +To disable the image pulling: + +.. code::bash + + archery docker run --no-cache conda-python + +Which translates to: + +.. code::bash + + docker-compose build --no-cache conda-cpp + docker-compose build --no-cache conda-python + docker-compose run --rm conda-python + +To disable the cache only for the leaf image - useful to force building the +development version of a dependency: + +.. code::bash + + PANDAS=master archery docker run --no-cache-leaf conda-python + +``PANDAS`` is a build time parameter, see the defaults in the .env file. + +To entirely skip building the image: + +.. code::bash + + archery docker run --no-build conda-python + +In order to alter the runtime parameters pass environment variables to the +container in execution time: + +.. code::bash + + archery docker run -e CMAKE_BUILD_TYPE=release ubuntu-cpp + +Starting an interactive bash session for debugging: Review comment: I'm not sure what do you mean, updated to be a bit more verbose. ---------------------------------------------------------------- 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
