Skip to content

Include quarkus-container-image and README in the binary distributions #1493

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

Merged
merged 1 commit into from
May 1, 2025
Merged

Include quarkus-container-image and README in the binary distributions #1493

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions quarkus/admin/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ distributions {
from(project.layout.buildDirectory.dir("quarkus-app"))
from("distribution/NOTICE")
from("distribution/LICENSE")
from("distribution/README.md")
}
}
}
Expand Down
331 changes: 237 additions & 94 deletions quarkus/admin/distribution/LICENSE
View file
Open in desktop

Large diffs are not rendered by default.

68 changes: 34 additions & 34 deletions quarkus/admin/distribution/NOTICE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This binary artifact bundles the following projects with NOTICE:

--------------------------------------------------------------------------------

Group: info.picocli Name: picocli Name: 4.7.6
Group: info.picocli Name: picocli Name: 4.7.7

NOTICE:
| This project includes one or more documentation files from OpenJDK, licensed under GPL v2 with Classpath Exception.
Expand Down Expand Up @@ -454,9 +454,9 @@ NOTICE:

--------------------------------------------------------------------------------

Group: io.micrometer Name: micrometer-commons Version: 1.14.5
Group: io.micrometer Name: micrometer-core Version: 1.14.5
Group: io.micrometer Name: micrometer-observation Version: 1.14.5
Group: io.micrometer Name: micrometer-commons Version: 1.14.6
Group: io.micrometer Name: micrometer-core Version: 1.14.6
Group: io.micrometer Name: micrometer-observation Version: 1.14.6

NOTICE:
| Micrometer
Expand Down Expand Up @@ -1163,36 +1163,36 @@ NOTICE:

--------------------------------------------------------------------------------

Group: software.amazon.awssdk Name: apache-client Version: 2.31.26
Group: software.amazon.awssdk Name: arns Version: 2.31.26
Group: software.amazon.awssdk Name: auth Version: 2.31.26
Group: software.amazon.awssdk Name: aws-core Version: 2.31.26
Group: software.amazon.awssdk Name: aws-query-protocol Version: 2.31.26
Group: software.amazon.awssdk Name: aws-xml-protocol Version: 2.31.26
Group: software.amazon.awssdk Name: checksums Version: 2.31.26
Group: software.amazon.awssdk Name: checksums-spi Version: 2.31.26
Group: software.amazon.awssdk Name: crt-core Version: 2.31.26
Group: software.amazon.awssdk Name: endpoints-spi Version: 2.31.26
Group: software.amazon.awssdk Name: http-auth Version: 2.31.26
Group: software.amazon.awssdk Name: http-auth-aws Version: 2.31.26
Group: software.amazon.awssdk Name: http-auth-aws-eventstream Version: 2.31.26
Group: software.amazon.awssdk Name: http-auth-spi Version: 2.31.26
Group: software.amazon.awssdk Name: http-client-spi Version: 2.31.26
Group: software.amazon.awssdk Name: iam-policy-builder Version: 2.31.26
Group: software.amazon.awssdk Name: identity-spi Version: 2.31.26
Group: software.amazon.awssdk Name: json-utils Version: 2.31.26
Group: software.amazon.awssdk Name: metrics-spi Version: 2.31.26
Group: software.amazon.awssdk Name: netty-nio-client Version: 2.31.26
Group: software.amazon.awssdk Name: profiles Version: 2.31.26
Group: software.amazon.awssdk Name: protocol-core Version: 2.31.26
Group: software.amazon.awssdk Name: regions Version: 2.31.26
Group: software.amazon.awssdk Name: retries Version: 2.31.26
Group: software.amazon.awssdk Name: retries-spi Version: 2.31.26
Group: software.amazon.awssdk Name: s3 Version: 2.31.26
Group: software.amazon.awssdk Name: sdk-core Version: 2.31.26
Group: software.amazon.awssdk Name: sts Version: 2.31.26
Group: software.amazon.awssdk Name: third-party-jackson-core Version: 2.31.26
Group: software.amazon.awssdk Name: utils Version: 2.31.26
Group: software.amazon.awssdk Name: apache-client Version: 2.31.30
Group: software.amazon.awssdk Name: arns Version: 2.31.30
Group: software.amazon.awssdk Name: auth Version: 2.31.30
Group: software.amazon.awssdk Name: aws-core Version: 2.31.30
Group: software.amazon.awssdk Name: aws-query-protocol Version: 2.31.30
Group: software.amazon.awssdk Name: aws-xml-protocol Version: 2.31.30
Group: software.amazon.awssdk Name: checksums Version: 2.31.30
Group: software.amazon.awssdk Name: checksums-spi Version: 2.31.30
Group: software.amazon.awssdk Name: crt-core Version: 2.31.30
Group: software.amazon.awssdk Name: endpoints-spi Version: 2.31.30
Group: software.amazon.awssdk Name: http-auth Version: 2.31.30
Group: software.amazon.awssdk Name: http-auth-aws Version: 2.31.30
Group: software.amazon.awssdk Name: http-auth-aws-eventstream Version: 2.31.30
Group: software.amazon.awssdk Name: http-auth-spi Version: 2.31.30
Group: software.amazon.awssdk Name: http-client-spi Version: 2.31.30
Group: software.amazon.awssdk Name: iam-policy-builder Version: 2.31.30
Group: software.amazon.awssdk Name: identity-spi Version: 2.31.30
Group: software.amazon.awssdk Name: json-utils Version: 2.31.30
Group: software.amazon.awssdk Name: metrics-spi Version: 2.31.30
Group: software.amazon.awssdk Name: netty-nio-client Version: 2.31.30
Group: software.amazon.awssdk Name: profiles Version: 2.31.30
Group: software.amazon.awssdk Name: protocol-core Version: 2.31.30
Group: software.amazon.awssdk Name: regions Version: 2.31.30
Group: software.amazon.awssdk Name: retries Version: 2.31.30
Group: software.amazon.awssdk Name: retries-spi Version: 2.31.30
Group: software.amazon.awssdk Name: s3 Version: 2.31.30
Group: software.amazon.awssdk Name: sdk-core Version: 2.31.30
Group: software.amazon.awssdk Name: sts Version: 2.31.30
Group: software.amazon.awssdk Name: third-party-jackson-core Version: 2.31.30
Group: software.amazon.awssdk Name: utils Version: 2.31.30

NOTICE:
| AWS SDK for Java
Expand Down
56 changes: 56 additions & 0 deletions quarkus/admin/distribution/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<!--
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.
-->

# Polaris Admin Tool

The Polaris Admin Tool is a maintenance tool for performing administrative tasks on the Polaris server.

## Prerequisites

Polaris admin tool requires a Java SE 21 or higher to run.

## Getting help

To get help, simple run (in a command line where you extracted the Polaris tool archive):

```
./run.sh help
```

## Bootstrap

You can bootstrap realms and root principal credentials with:

```
./run.sh bootstrap
```

providing all required arguments.

## Purge

You can purge realms and all associated entities with:

```
./run.sh purge
```

## Documentation

For more details, please take a look on the documentation: https://polaris.apache.org/in-dev/unreleased/admin-tool/
2 changes: 1 addition & 1 deletion quarkus/run-script/scripts/run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ if [ ! -x "$JAVACMD" ] ; then
exit 1
fi

exec "${JAVACMD}" -jar "${script_dir}/quarkus-run.jar"
exec "${JAVACMD}" -jar "${script_dir}/quarkus-run.jar" $@
2 changes: 1 addition & 1 deletion quarkus/server/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ distributions {
from(project.layout.buildDirectory.dir("quarkus-app"))
from("distribution/NOTICE")
from("distribution/LICENSE")
exclude("lib/main/io.quarkus.quarkus-container-image*")
Copy link
Contributor

@adutra adutra Apr 29, 2025

Choose a reason for hiding this comment

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

FYI I tried to keep these jars excluded while still producing the Docker image during build, but my Gradle skills weren't enough 😆 – so I'm fine with this.

Copy link
Member Author

@jbonofre jbonofre Apr 29, 2025

Choose a reason for hiding this comment

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

That's not so easy with gradle for sure !

Copy link
Contributor

@flyrain flyrain Apr 29, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Would it work if we used runtimeOnly here?

  implementation("io.quarkus:quarkus-container-image-docker")

Copy link
Member Author

@jbonofre jbonofre Apr 29, 2025

Choose a reason for hiding this comment

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

The dependencies are actually already there but excluded. So it's more buildOnly more than runtimeOnly 😄

Copy link
Contributor

@adutra adutra Apr 29, 2025

Choose a reason for hiding this comment

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

runtimeOnly wouldn't work. I tried the buildOnly approach btw, but it's too convoluted.

Copy link
Contributor

@flyrain flyrain Apr 30, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

./gradlew \
  :polaris-quarkus-server:assemble \
  :polaris-quarkus-server:quarkusAppPartsBuild --rerun \
  -Dquarkus.container-image.build=true

After remove the dependency(// implementation("io.quarkus:quarkus-container-image-docker")
), this command works and built a local docker image successfully. Which docker image build will fail?

apache/polaris                            0.11.0-beta-incubating-SNAPSHOT   7e1fc7ac2034   2 minutes ago   611MB

Copy link
Contributor

@adutra adutra Apr 30, 2025

Choose a reason for hiding this comment

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

I do not see any image being created. You can double-check by changing the image name:

./gradlew \
  :polaris-quarkus-server:assemble \
  :polaris-quarkus-server:quarkusAppPartsBuild --rerun \
  -Dquarkus.container-image.build=true -Dquarkus.container-image.name=foo

After that, I do not see any image named foo on my machine.

Copy link
Contributor

@flyrain flyrain Apr 30, 2025

Choose a reason for hiding this comment

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

Can you try this? It works for me.

  runtimeOnly("io.quarkus:quarkus-container-image-docker")

Copy link
Contributor

@adutra adutra Apr 30, 2025

Choose a reason for hiding this comment

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

runtimeOnly works, yes. If everybody thinks that's the best solution, I'm +1 on that.

Copy link
Member Author

@jbonofre jbonofre May 1, 2025

Choose a reason for hiding this comment

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

For now, I would keep "simple". I propose to do another PR to improve that. Thoughts ?

from("distribution/README.md")
}
}
}
Expand Down
Loading