Skip to content

Add muti-platform Docker images staging in the release guide #2039

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add muti-platform Docker images staging in the release guide #2039

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions site/content/release-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,15 @@ Next, you have to close the staging repository:
4. At the top, select "Close" and follow the instructions
5. In the comment field, use "Apache Polaris x.y.z RCi"

### Build and staging Docker images

You can now publish Docker images on DockerHub:

```
./gradlew :polaris-server:assemble :polaris-server:quarkusAppPartsBuild --rerun -Dquarkus.container-image.build=true -Dquarkus.container-image.push=true -Dquarkus.docker.buildx.platform="linux/amd64,linux/arm64" -Dquarkus.container-image.tag=x.y.z-rci
Copy link
Member

Choose a reason for hiding this comment

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

What are the machine's requirements for "buildx"? Docker? Podman?

Copy link
Member Author

Choose a reason for hiding this comment

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

Docker (we use quarkus-container-image-docker dependency by default).

Copy link
Member

Choose a reason for hiding this comment

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

Hm, not sure Docker's a great implied requirement due to the licensing implications that it brings for most devs.

Copy link
Member Author

Choose a reason for hiding this comment

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

Podman also supports multi-platform images "natively" (without buildx). If we want to use podman, we should update the dependency here: https://github.com/apache/polaris/blob/main/runtime/server/build.gradle.kts#L55 (to use podman instead of docker).

Copy link
Contributor

Choose a reason for hiding this comment

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

FYI, last time I tried multi-arch builds with podman, the resulting manifests were corrupted. But, maybe it's fixed/improved now.

Copy link
Member

Choose a reason for hiding this comment

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

I suspect, it's not an issue (license wise) to use Docker buildx in ASF GH workflows. Just for potentially for devs locally.

Copy link
Contributor

@MonkeyCanCode MonkeyCanCode Jul 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Yes. podman can do multi-arch build without buildx now a day (I used it at work as well). Due to the above concern with licensing around docker, does it makes sense to deprecate docker and promo podman instead? Also, for buildx on docker with Mac/Windows, additional steps are needed on the build machines other than the additional parameters specify above.

One more catch with podman is it will add container registry info (by default docker.io) to the image name. When building with docker, we will get apache/polaris:xxxx. However, if we build with podman, it will then become docker.io/apache/polaris:xxxx. In case if we want to promo podman as oppose to docker, we shoild container add additional parameter to set registry info as part of the image build (so both docke/podman will produce same images name) then update our docs accordingly.

./gradlew :polaris-admin:assemble :polaris-admin:quarkusAppPartsBuild --rerun -Dquarkus.container-image.build=true -Dquarkus.container-image.push=true -Dquarkus.docker.buildx.platform="linux/amd64,linux/arm64" -Dquarkus.container-image.tag=x.y.z-rci
```

### Start the vote thread

The last step for a release candidate is to create a VOTE thread on the dev mailing list.
Expand Down Expand Up @@ -239,8 +248,10 @@ The release tarball, signature, and checksums are here:

Helm charts are available on:
* https://dist.apache.org/repos/dist/dev/incubator/polaris/helm-chart
NB: the docker images (polaris-server and polaris-admin) will be
published on DockerHub once release vote passes.

Docker images:
Copy link
Member

Choose a reason for hiding this comment

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

Since those are multiplatform images, probably worth to add a link to Dockerhub

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point, I will.

* docker pull apache/polaris:x.y.z-rci
* docker pull apache/polaris-admin-tool:x.y.z-rci

You can find the KEYS file here:
* https://downloads.apache.org/incubator/polaris/KEYS
Expand Down
Loading