perf(docker): improve pd/store/server image build cache efficiency by bitflicker64 · Pull Request #3025 · apache/hugegraph

bitflicker64 · 2026-05-13T20:38:37Z

Purpose of the PR

Main Changes

.dockerignore (new file)

Minimal, intentionally lean — only Docker-specific extras (.git, .github, compose files, docs)
Most patterns already covered by .gitignore, not duplicated per maintainer guidance

All 4 Dockerfiles

Added COPY --parents **/pom.xml ./ before COPY . . — pom layer only invalidates on pom changes, not source changes
Added --mount=type=cache,target=/root/.m2 on mvn package — deps cached across repeated builds
Removed vim, cron, service cron start, rm /var/lib/dpkg/info/libc-bin.*, dead code from runtime stage

Note: dependency:go-offline not used — inter-module deps like hg-pd-client aren't on Maven Central and would cause it to fail.

Verifying these changes

Need tests and can be verified as follows:

docker build -f hugegraph-pd/Dockerfile -t hugegraph-pd:cache-test .
docker build -f hugegraph-store/Dockerfile -t hugegraph-store:cache-test .
docker build -f hugegraph-server/Dockerfile -t hugegraph-server:cache-test .
docker build -f hugegraph-server/Dockerfile-hstore -t hugegraph-server-hstore:cache-test .

Does this PR potentially affect the following parts?

Documentation Status

Doc - No Need

codecov · 2026-05-13T21:40:57Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 1.56%. Comparing base (e108076) to head (0952764).
⚠️ Report is 1 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (e108076) and HEAD (0952764). Click for more details.

HEAD has 1 upload less than BASE

Flag BASE (e108076) HEAD (0952764)

3 2

Additional details and impacted files

@@             Coverage Diff              @@
##             master   #3025       +/-   ##
============================================
- Coverage     35.85%   1.56%   -34.30%     
+ Complexity      338      43      -295     
============================================
  Files           802     781       -21     
  Lines         67995   65524     -2471     
  Branches       8902    8457      -445     
============================================
- Hits          24381    1026    -23355     
- Misses        41008   64412    +23404     
+ Partials       2606      86     -2520

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull request overview

This PR aims to improve Docker build cache efficiency for HugeGraph PD, Store, and Server images by adding Docker context filtering and BuildKit/Maven cache-related Dockerfile changes.

Changes:

Adds a new root .dockerignore.
Updates four Dockerfiles to use a pom-only copy layer and Maven cache mounts.
Removes some runtime packages and cleanup/startup commands from image build stages.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 15 comments.

Show a summary per file

File	Description
`.dockerignore`	Adds Docker build-context exclusions.
`hugegraph-pd/Dockerfile`	Refactors PD image build layers and runtime dependency install.
`hugegraph-store/Dockerfile`	Refactors Store image build layers and runtime dependency install.
`hugegraph-server/Dockerfile`	Refactors Server image build layers and runtime dependency install.
`hugegraph-server/Dockerfile-hstore`	Refactors hstore Server image build layers and runtime dependency install.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+# Copy pom files first — layer is only invalidated when pom files change,
+# keeping the Maven cache mount warm across source-only changes.
+COPY --parents **/pom.xml ./
 ARG MAVEN_ARGS



- Add .dockerignore to reduce build context noise (defer to .gitignore, add **/target/ and Docker-specific extras explicitly) - Refactor all 4 Dockerfiles: pom-first COPY layer + BuildKit .m2 cache mount - Add # syntax=docker/dockerfile:1 for compatibility with older Docker versions - Restore cron in runtime stage to preserve optional monitor support - Remove dead code: vim, service cron start, rm libc-bin hack, set -x, pwd&&cd - Update server-ci.yml ubuntu-22.04 -> ubuntu-latest (resolves existing TODO)

imbajin

Direction is right but a few blockers remain. See inline for net-new findings; +1'd Copilot's threads on the labs syntax / pom-only layer / root-pom glob (those are correct). Body-level: README/BUILDING should also note the new BuildKit ≥ 0.20 requirement, and removing vim is a behavioral change worth calling out in the commit body for ops folks who exec into containers.

imbajin · 2026-05-14T14:20:21Z

+# NOTE: This file intentionally stays minimal.
+**/target/
+# Most patterns (IDE files, build artifacts, logs, OS files) are already
+# covered by .gitignore. Only Docker-specific extras are listed here.


‼️ The premise here is incorrect — Docker's build context exclusion does not inherit .gitignore. As a result, locally-extracted release dirs (apache-hugegraph-*/, measured at ~790 MB on a normal dev checkout), .idea/, node_modules/, logs/, *.iml, *.class, gen-java/, upload-files/, .vscode/, *.tar.gz, dist/, build/ all leak into every build's context, defeating the cache work in this PR (and risking IDE / secret leakage into image layers).

Suggested change

# covered by .gitignore. Only Docker-specific extras are listed here.

**/target/

# IMPORTANT: .dockerignore does NOT inherit .gitignore — patterns must be restated.

# Pre-extracted release dirs / archives

apache-hugegraph-*/

**/*.tar

**/*.tar.gz*

**/*.zip

**/*.war

# IDE / OS

.idea/

.vscode/

**/*.iml

**/*.iws

**/.DS_Store

# Build / runtime artifacts

**/logs/

**/*.log

**/*.class

**/gen-java/

**/upload-files/

**/dist/

**/build/

**/node_modules/

# Env files

.env.local

.env.*.local

# Git internals

.git

.gitignore

.gitattributes

.github

# Compose / docs not needed in build context

**/docker-compose*.yml

**/docker-compose*.yaml

**/*.md

docs/

imbajin · 2026-05-14T14:20:21Z

  build-server:
-    # TODO: we need test & replace it to ubuntu-24.04 or ubuntu-latest
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest


⚠️ Two concerns on this line:

Scope creep: bumping ubuntu-22.04 → ubuntu-latest is unrelated to the Docker cache work in this PR. The original # TODO was a deliberate guard (Ubuntu 24.04 changed default Java, removed legacy packages). Suggest reverting in this PR and splitting into a focused follow-up.

ubuntu-latest drifts when GitHub flips the alias — pin explicitly:

Suggested change

runs-on: ubuntu-latest

runs-on: ubuntu-24.04

Flagging here since it's the only CI file touched: there is no CI workflow that exercises any Dockerfile (verified — zero docker build references under .github/workflows/). PR's verification is "run docker build locally". Future regressions will ship silently. Consider adding a build-only smoke job:

docker-build: runs-on: ubuntu-24.04 strategy: matrix: dockerfile: - hugegraph-pd/Dockerfile - hugegraph-store/Dockerfile - hugegraph-server/Dockerfile - hugegraph-server/Dockerfile-hstore steps: - uses: actions/checkout@v4 - uses: docker/setup-buildx-action@v3 - run: docker buildx build -f ${{ matrix.dockerfile }} --load .

Reverted it back , I was mainly testing what would break with ubuntu-latest. Also added smoke test 🫡

imbajin · 2026-05-14T14:20:21Z

       dumb-init \
       procps \
       curl \
       lsof \


🧹 Pre-existing issue (not a regression from this PR, but worth fixing while in the area): the cron package stays installed in the runtime image (~3 MB), but no cron daemon is ever started — dumb-init only execs docker-entrypoint.sh. This means start-hugegraph.sh -m true silently fails to fire its scheduled monitor job, even though crontab_append returns success. Either:

Drop cron entirely (saves ~3 MB and removes the false impression that monitor mode works), or

Start cron in docker-entrypoint.sh (cron & before the server start) so the feature actually works.

Same applies to Dockerfile-hstore and the PD / Store Dockerfiles.

removed cron from the runtime images for now since properly enabling it would expand the scope of this PR. happy to work on enabling this feature later in a follow up pr if u want

- remove ineffective pom-only COPY optimization - remove unused cron package from runtime images - keep vim for container debugging workflows - add Maven cache mounts for faster rebuilds - expand .dockerignore to exclude IDE files, archives, logs, generated artifacts, and local build outputs - simplify Docker build flow and reduce unnecessary build context size

…u-latest- back

bitflicker64 · 2026-05-15T13:40:26Z

**/dist/matches org/apache/hugegraph/dist/ a real Java source package directory.

The full path that gets excluded is:

hugegraph-server/hugegraph-dist/src/main/java/org/apache/hugegraph/dist/

The last path component is dist, so **/dist/ matches it and wipes the entire org.apache.hugegraph.dist package from the Docker build context before mvn package ever runs. so used **/target/dist/ instead

perf(docker): improve pd/store/server image build cache efficiency

c6e75ca

dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. ci-cd Build or deploy perf labels May 13, 2026

imbajin requested a review from Copilot May 14, 2026 10:22

Copilot started reviewing on behalf of imbajin May 14, 2026 10:22 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

bitflicker64 requested a review from Copilot May 14, 2026 12:33

imbajin reviewed May 14, 2026

View reviewed changes

bitflicker64 added 5 commits May 15, 2026 17:04

ci(docker): add build smoke job for Dockerfile changes

2ddb092

added todo # TODO: we need test & replace it to ubuntu-24.04 or ubunt…

0952764

…u-latest- back

ci(docker): remove blocked buildx action from smoke workflow

2f879b5

changed **/dist/ to **/target/dist/

484b981

bitflicker64 requested a review from imbajin May 16, 2026 06:57

-# covered by .gitignore. Only Docker-specific extras are listed here.
+**/target/
+# IMPORTANT: .dockerignore does NOT inherit .gitignore — patterns must be restated.
+# Pre-extracted release dirs / archives
+apache-hugegraph-*/
+**/*.tar
+**/*.tar.gz*
+**/*.zip
+**/*.war
+# IDE / OS
+.idea/
+.vscode/
+**/*.iml
+**/*.iws
+**/.DS_Store
+# Build / runtime artifacts
+**/logs/
+**/*.log
+**/*.class
+**/gen-java/
+**/upload-files/
+**/dist/
+**/build/
+**/node_modules/
+# Env files
+.env.local
+.env.*.local
+# Git internals
+.git
+.gitignore
+.gitattributes
+.github
+# Compose / docs not needed in build context
+**/docker-compose*.yml
+**/docker-compose*.yaml
+**/*.md
+docs/

Conversation

bitflicker64 commented May 13, 2026

Purpose of the PR

Main Changes

Verifying these changes

Does this PR potentially affect the following parts?

Documentation Status

Uh oh!

codecov Bot commented May 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

imbajin left a comment

Choose a reason for hiding this comment

Uh oh!

imbajin May 14, 2026

Choose a reason for hiding this comment

Uh oh!

imbajin May 14, 2026

Choose a reason for hiding this comment

Uh oh!

bitflicker64 May 15, 2026

Choose a reason for hiding this comment

Uh oh!

imbajin May 14, 2026

Choose a reason for hiding this comment

Uh oh!

bitflicker64 May 15, 2026

Choose a reason for hiding this comment

Uh oh!

bitflicker64 commented May 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov Bot commented May 13, 2026 •

edited

Loading