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

Add documentation for containerized native builds on remote daemons #15591

Merged
merged 1 commit into from
Mar 12, 2021
Merged

Add documentation for containerized native builds on remote daemons #15591

merged 1 commit into from
Mar 12, 2021

Conversation

jonathan-meier
Copy link
Contributor

Doc for PR #14635.

Copy link
Contributor

@zakkak zakkak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR @jonathan-meier :)
Please see my comments for a couple of typos and a suggestion.


The reason for this is that the local build driver invoked through `Dquarkus.native.container-build=true` uses volume mounts to make the JAR available in the build container, but volume mounts do not work with remote daemons. The remote container build driver copies the necessary files instead of mounting them. Note that even though the remote driver also works with local daemons, the local driver should be preferred in the local case because mounting is usually more performant than copying.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The reason for this is that the local build driver invoked through `Dquarkus.native.container-build=true` uses volume mounts to make the JAR available in the build container, but volume mounts do not work with remote daemons. The remote container build driver copies the necessary files instead of mounting them. Note that even though the remote driver also works with local daemons, the local driver should be preferred in the local case because mounting is usually more performant than copying.
The reason for this is that the local build driver invoked through `-Dquarkus.native.container-build=true` uses volume mounts to make the JAR available in the build container, but volume mounts do not work with remote daemons. The remote container build driver copies the necessary files instead of mounting them. Note that even though the remote driver also works with local daemons, the local driver should be preferred in the local case because mounting is usually more performant than copying.


[TIP]
====
If your application JAR builds fine but you get an invalid path error for the JAR when trying to create a native executable using a container build, you're most likely using a remote daemon for your container runtime.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest including a verbatim copy of the error. This way if people search for the error search engines will direct them to this tip.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good suggestion, I reworded this part a bit to fluently include a copy of the error.

[TIP]
====
If your application JAR builds fine but you get an invalid path error for the JAR when trying to create a native executable using a container build, you're most likely using a remote daemon for your container runtime.
In this case, use the parameter `Dquarkus.native.remote-container-build=true` instead of `-Dquarkus.native.container-build=true`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In this case, use the parameter `Dquarkus.native.remote-container-build=true` instead of `-Dquarkus.native.container-build=true`.
In this case, use the parameter `-Dquarkus.native.remote-container-build=true` instead of `-Dquarkus.native.container-build=true`.

@jonathan-meier
Copy link
Contributor Author

Thanks for the feedback! I fixed the typos and addressed your suggestion.

Copy link
Contributor

@zakkak zakkak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fixes!

It looks good to me.

@jonathan-meier jonathan-meier changed the title WIP: Add documentation for containerized native builds on remote daemons Add documentation for containerized native builds on remote daemons Mar 10, 2021
@gsmet gsmet merged commit 6643c47 into quarkusio:master Mar 12, 2021
@quarkus-bot quarkus-bot bot added this to the 1.13 - master milestone Mar 12, 2021
@gsmet
Copy link
Member

gsmet commented Mar 12, 2021

Thanks!

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