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

[Dev] Allow passing --progress=plain to archery docker build #43669

Closed
jorisvandenbossche opened this issue Aug 13, 2024 · 7 comments
Closed
Assignees
Milestone

Comments

@jorisvandenbossche
Copy link
Member

I was debugging one of our docker-compose based CI build, and building and running the docker image locally with archery docker build xxx.

As the documentation (https://arrow.apache.org/docs/dev/developers/continuous_integration/docker.html) mentions, you can specify --no-cache to archery docker run/build (which passes that to docker compose build, but while debugging, I found that additionally it would have been helpful to be able to pass --progress=plain through.

@jorisvandenbossche
Copy link
Member Author

(cc @assignUser @raulcd to check whether this makes sense, or if there are better ways to see verbose output and printing from the build stage)

@assignUser
Copy link
Member

Sounds sensible 👍

@raulcd
Copy link
Member

raulcd commented Aug 29, 2024

Probably not well documented but from my understanding archery --debug docker build xxx should pass --progress=plain to the command:

DEBUG:archery:Executing `['docker', 'compose', '--file=/home/raulcd/code/arrow/docker-compose.yml', 'build', '--build-arg', 'BUILDKIT_INLINE_CACHE=1', '--progress=plain', 'conda']`

@raulcd
Copy link
Member

raulcd commented Aug 29, 2024

ok, this was added not long ago (#40129), we should probably document it.

@jorisvandenbossche
Copy link
Member Author

That indeed seems to be what I wanted!

@jorisvandenbossche
Copy link
Member Author

I will look into adding that to the dev docs.

But the CLI help, it is actually kind of documented in the top-level one:

$ archery -h
Usage: archery [OPTIONS] COMMAND [ARGS]...

  Apache Arrow developer utilities.

  See sub-commands help with `archery <cmd> --help`.

Options:
  --debug      Increase logging with debugging output.
  ...

assuming those options listed are available for all subcommands.

But when you are looking at the specific options for docker build, that doesn't show up, so it is easy to miss:

$ archery docker build --help
Usage: archery docker build [OPTIONS] IMAGE

  Execute docker-compose builds.

Options:
  --force-pull / --no-pull        Whether to force pull the image and its
                                  ancestor images
  --use-cache / --no-cache        Whether to use cache when building the image
                                  and its ancestor images
  --use-leaf-cache / --no-leaf-cache
                                  Whether to use cache when building only the
                                  (leaf) image passed as the argument. To
                                  disable caching for both the image and its
                                  ancestors use --no-cache option.
  -h, --help                      Show this message and exit.

jorisvandenbossche added a commit to jorisvandenbossche/arrow that referenced this issue Sep 3, 2024
jorisvandenbossche added a commit that referenced this issue Sep 4, 2024
…docker (#43935)

### Rationale for this change

This feature was added in #40129, but adding it to the docker page in the developer docs for better visibility.

* GitHub Issue: #43669

Authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
@jorisvandenbossche jorisvandenbossche added this to the 18.0.0 milestone Sep 4, 2024
@jorisvandenbossche
Copy link
Member Author

Issue resolved by pull request 43935
#43935

zanmato1984 pushed a commit to zanmato1984/arrow that referenced this issue Sep 6, 2024
…about docker (apache#43935)

### Rationale for this change

This feature was added in apache#40129, but adding it to the docker page in the developer docs for better visibility.

* GitHub Issue: apache#43669

Authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
khwilson pushed a commit to khwilson/arrow that referenced this issue Sep 14, 2024
…about docker (apache#43935)

### Rationale for this change

This feature was added in apache#40129, but adding it to the docker page in the developer docs for better visibility.

* GitHub Issue: apache#43669

Authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
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

3 participants