chore(Linux): factorise jdk in docker-bake.hcl #401

lemeurherve · 2024-05-08T15:22:06Z

This PR factorises the JDK in docker bake file, resulting in a more concise definition of images and ensuring tagging consistency, with one block defining Alpine images, another defining Debian images, and lastly the remaining one for the special Debian 21 preview image.

~~I titled this PR "chore/breaking" as it depends:~~

If this PR is released first, it will be a breaking change as it will change the JDK of the short tags to Java 17, closing The Linux short tags are targeting Java 11 #399 and superseding breaking(Linux): short tags targeting Java 17 instead of Java 11 #400
~~If this PR is released after breaking(Linux): short tags targeting Java 17 instead of Java 11 #400, there will be no change to the resulting images and tags.~~

EDIT: No longer a breaking change with 427788c

Note that we can still target a single image even with this factorisation:

docker buildx bake --file docker-bake.hcl alpine_21 --print

{
  "group": {
    "default": {
      "targets": [
        "alpine_21"
      ]
    }
  },
  "target": {
    "alpine_21": {
      "context": ".",
      "dockerfile": "alpine/Dockerfile",
      "args": {
        "ALPINE_TAG": "3.19.1",
        "JAVA_VERSION": "21.0.3_9"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3-alpine-jdk21",
        "docker.io/jenkins/ssh-agent:1.2.3-alpine3.19-jdk21",
        "docker.io/jenkins/ssh-agent:alpine-jdk21",
        "docker.io/jenkins/ssh-agent:latest-alpine-jdk21",
        "docker.io/jenkins/ssh-agent:alpine3.19-jdk21",
        "docker.io/jenkins/ssh-agent:latest-alpine3.19-jdk21"
      ],
      "platforms": [
        "linux/amd64",
        "linux/arm64"
      ]
    }
  }
}

Testing done

Verified that the output of docker buildx bake --file docker-bake.hcl linux --print with VERSION=1.2.3 & ON_TAG=true is equivalent to the one of #400:

#400

{
  "group": {
    "default": {
      "targets": [
        "linux"
      ]
    },
    "linux": {
      "targets": [
        "alpine_jdk11",
        "alpine_jdk17",
        "alpine_jdk21",
        "debian_jdk11",
        "debian_jdk17",
        "debian_jdk21",
        "debian_jdk21-preview"
      ]
    }
  },
  "target": {
    "alpine_jdk11": {
      "context": ".",
      "dockerfile": "alpine/Dockerfile",
      "args": {
        "ALPINE_TAG": "3.19.1",
        "JAVA_VERSION": "11.0.23_9"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3-alpine-jdk11",
        "docker.io/jenkins/ssh-agent:1.2.3-alpine3.19-jdk11",
        "docker.io/jenkins/ssh-agent:alpine-jdk11",
        "docker.io/jenkins/ssh-agent:latest-alpine-jdk11",
        "docker.io/jenkins/ssh-agent:alpine3.19-jdk11",
        "docker.io/jenkins/ssh-agent:latest-alpine3.19-jdk11"
      ],
      "platforms": [
        "linux/amd64"
      ]
    },
    "alpine_jdk17": {
      "context": ".",
      "dockerfile": "alpine/Dockerfile",
      "args": {
        "ALPINE_TAG": "3.19.1",
        "JAVA_VERSION": "17.0.11_9"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3-alpine-jdk17",
        "docker.io/jenkins/ssh-agent:1.2.3-alpine3.19-jdk17",
        "docker.io/jenkins/ssh-agent:alpine",
        "docker.io/jenkins/ssh-agent:alpine-jdk17",
        "docker.io/jenkins/ssh-agent:latest-alpine-jdk17",
        "docker.io/jenkins/ssh-agent:alpine3.19",
        "docker.io/jenkins/ssh-agent:alpine3.19-jdk17",
        "docker.io/jenkins/ssh-agent:latest-alpine3.19",
        "docker.io/jenkins/ssh-agent:latest-alpine3.19-jdk17"
      ],
      "platforms": [
        "linux/amd64"
      ]
    },
    "alpine_jdk21": {
      "context": ".",
      "dockerfile": "alpine/Dockerfile",
      "args": {
        "ALPINE_TAG": "3.19.1",
        "JAVA_VERSION": "21.0.3_9"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3-alpine-jdk21",
        "docker.io/jenkins/ssh-agent:1.2.3-alpine3.19-jdk21",
        "docker.io/jenkins/ssh-agent:alpine-jdk21",
        "docker.io/jenkins/ssh-agent:latest-alpine-jdk21",
        "docker.io/jenkins/ssh-agent:alpine3.19-jdk21",
        "docker.io/jenkins/ssh-agent:latest-alpine3.19-jdk21"
      ],
      "platforms": [
        "linux/amd64",
        "linux/arm64"
      ]
    },
    "debian_jdk11": {
      "context": ".",
      "dockerfile": "debian/Dockerfile",
      "args": {
        "DEBIAN_RELEASE": "bookworm-20240423",
        "JAVA_VERSION": "11.0.23_9"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3-jdk11",
        "docker.io/jenkins/ssh-agent:bookworm-jdk11",
        "docker.io/jenkins/ssh-agent:debian-jdk11",
        "docker.io/jenkins/ssh-agent:jdk11",
        "docker.io/jenkins/ssh-agent:latest-bookworm-jdk11",
        "docker.io/jenkins/ssh-agent:latest-debian-jdk11",
        "docker.io/jenkins/ssh-agent:latest-jdk11"
      ],
      "platforms": [
        "linux/amd64",
        "linux/arm64",
        "linux/s390x",
        "linux/ppc64le"
      ]
    },
    "debian_jdk17": {
      "context": ".",
      "dockerfile": "debian/Dockerfile",
      "args": {
        "DEBIAN_RELEASE": "bookworm-20240423",
        "JAVA_VERSION": "17.0.11_9"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3",
        "docker.io/jenkins/ssh-agent:1.2.3-jdk17",
        "docker.io/jenkins/ssh-agent:bookworm-jdk17",
        "docker.io/jenkins/ssh-agent:debian-jdk17",
        "docker.io/jenkins/ssh-agent:jdk17",
        "docker.io/jenkins/ssh-agent:latest",
        "docker.io/jenkins/ssh-agent:latest-bookworm-jdk17",
        "docker.io/jenkins/ssh-agent:latest-debian-jdk17",
        "docker.io/jenkins/ssh-agent:latest-jdk17"
      ],
      "platforms": [
        "linux/amd64",
        "linux/arm64",
        "linux/ppc64le"
      ]
    },
    "debian_jdk21": {
      "context": ".",
      "dockerfile": "debian/Dockerfile",
      "args": {
        "DEBIAN_RELEASE": "bookworm-20240423",
        "JAVA_VERSION": "21.0.3_9"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3-jdk21",
        "docker.io/jenkins/ssh-agent:bookworm-jdk21",
        "docker.io/jenkins/ssh-agent:debian-jdk21",
        "docker.io/jenkins/ssh-agent:jdk21",
        "docker.io/jenkins/ssh-agent:latest-bookworm-jdk21",
        "docker.io/jenkins/ssh-agent:latest-debian-jdk21",
        "docker.io/jenkins/ssh-agent:latest-jdk21"
      ],
      "platforms": [
        "linux/amd64",
        "linux/arm64",
        "linux/ppc64le",
        "linux/s390x"
      ]
    },
    "debian_jdk21-preview": {
      "context": ".",
      "dockerfile": "debian/preview/Dockerfile",
      "args": {
        "DEBIAN_RELEASE": "bookworm-20240423",
        "JAVA_VERSION": "21.0.1+12"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3-jdk21-preview",
        "docker.io/jenkins/ssh-agent:bookworm-jdk21-preview",
        "docker.io/jenkins/ssh-agent:debian-jdk21-preview",
        "docker.io/jenkins/ssh-agent:jdk21-preview",
        "docker.io/jenkins/ssh-agent:latest-bookworm-jdk21-preview",
        "docker.io/jenkins/ssh-agent:latest-debian-jdk21-preview",
        "docker.io/jenkins/ssh-agent:latest-jdk21-preview"
      ],
      "platforms": [
        "linux/arm/v7"
      ]
    }
  }
}

After

{
  "group": {
    "alpine": {
      "targets": [
        "alpine_11",
        "alpine_17",
        "alpine_21"
      ]
    },
    "debian": {
      "targets": [
        "debian_11",
        "debian_17",
        "debian_21"
      ]
    },
    "default": {
      "targets": [
        "linux"
      ]
    },
    "linux": {
      "targets": [
        "alpine",
        "debian",
        "debian_jdk21-preview"
      ]
    }
  },
  "target": {
    "alpine_11": {
      "context": ".",
      "dockerfile": "alpine/Dockerfile",
      "args": {
        "ALPINE_TAG": "3.19.1",
        "JAVA_VERSION": "11.0.23_9"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3-alpine-jdk11",
        "docker.io/jenkins/ssh-agent:1.2.3-alpine3.19-jdk11",
        "docker.io/jenkins/ssh-agent:alpine-jdk11",
        "docker.io/jenkins/ssh-agent:latest-alpine-jdk11",
        "docker.io/jenkins/ssh-agent:alpine3.19-jdk11",
        "docker.io/jenkins/ssh-agent:latest-alpine3.19-jdk11"
      ],
      "platforms": [
        "linux/amd64"
      ]
    },
    "alpine_17": {
      "context": ".",
      "dockerfile": "alpine/Dockerfile",
      "args": {
        "ALPINE_TAG": "3.19.1",
        "JAVA_VERSION": "17.0.11_9"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3-alpine-jdk17",
        "docker.io/jenkins/ssh-agent:1.2.3-alpine3.19-jdk17",
        "docker.io/jenkins/ssh-agent:alpine",
        "docker.io/jenkins/ssh-agent:alpine3.19",
        "docker.io/jenkins/ssh-agent:latest-alpine3.19",
        "docker.io/jenkins/ssh-agent:alpine-jdk17",
        "docker.io/jenkins/ssh-agent:latest-alpine-jdk17",
        "docker.io/jenkins/ssh-agent:alpine3.19-jdk17",
        "docker.io/jenkins/ssh-agent:latest-alpine3.19-jdk17"
      ],
      "platforms": [
        "linux/amd64"
      ]
    },
    "alpine_21": {
      "context": ".",
      "dockerfile": "alpine/Dockerfile",
      "args": {
        "ALPINE_TAG": "3.19.1",
        "JAVA_VERSION": "21.0.3_9"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3-alpine-jdk21",
        "docker.io/jenkins/ssh-agent:1.2.3-alpine3.19-jdk21",
        "docker.io/jenkins/ssh-agent:alpine-jdk21",
        "docker.io/jenkins/ssh-agent:latest-alpine-jdk21",
        "docker.io/jenkins/ssh-agent:alpine3.19-jdk21",
        "docker.io/jenkins/ssh-agent:latest-alpine3.19-jdk21"
      ],
      "platforms": [
        "linux/amd64",
        "linux/arm64"
      ]
    },
    "debian_11": {
      "context": ".",
      "dockerfile": "debian/Dockerfile",
      "args": {
        "DEBIAN_RELEASE": "bookworm-20240423",
        "JAVA_VERSION": "11.0.23_9"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3-jdk11",
        "docker.io/jenkins/ssh-agent:bookworm-jdk11",
        "docker.io/jenkins/ssh-agent:debian-jdk11",
        "docker.io/jenkins/ssh-agent:jdk11",
        "docker.io/jenkins/ssh-agent:latest-bookworm-jdk11",
        "docker.io/jenkins/ssh-agent:latest-debian-jdk11",
        "docker.io/jenkins/ssh-agent:latest-jdk11"
      ],
      "platforms": [
        "linux/amd64",
        "linux/arm64",
        "linux/ppc64le",
        "linux/s390x"
      ]
    },
    "debian_17": {
      "context": ".",
      "dockerfile": "debian/Dockerfile",
      "args": {
        "DEBIAN_RELEASE": "bookworm-20240423",
        "JAVA_VERSION": "17.0.11_9"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3-jdk17",
        "docker.io/jenkins/ssh-agent:1.2.3",
        "docker.io/jenkins/ssh-agent:latest",
        "docker.io/jenkins/ssh-agent:bookworm-jdk17",
        "docker.io/jenkins/ssh-agent:debian-jdk17",
        "docker.io/jenkins/ssh-agent:jdk17",
        "docker.io/jenkins/ssh-agent:latest-bookworm-jdk17",
        "docker.io/jenkins/ssh-agent:latest-debian-jdk17",
        "docker.io/jenkins/ssh-agent:latest-jdk17"
      ],
      "platforms": [
        "linux/amd64",
        "linux/arm64",
        "linux/ppc64le"
      ]
    },
    "debian_21": {
      "context": ".",
      "dockerfile": "debian/Dockerfile",
      "args": {
        "DEBIAN_RELEASE": "bookworm-20240423",
        "JAVA_VERSION": "21.0.3_9"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3-jdk21",
        "docker.io/jenkins/ssh-agent:bookworm-jdk21",
        "docker.io/jenkins/ssh-agent:debian-jdk21",
        "docker.io/jenkins/ssh-agent:jdk21",
        "docker.io/jenkins/ssh-agent:latest-bookworm-jdk21",
        "docker.io/jenkins/ssh-agent:latest-debian-jdk21",
        "docker.io/jenkins/ssh-agent:latest-jdk21"
      ],
      "platforms": [
        "linux/amd64",
        "linux/arm64",
        "linux/ppc64le",
        "linux/s390x"
      ]
    },
    "debian_jdk21-preview": {
      "context": ".",
      "dockerfile": "debian/preview/Dockerfile",
      "args": {
        "DEBIAN_RELEASE": "bookworm-20240423",
        "JAVA_VERSION": "21.0.1+12"
      },
      "tags": [
        "docker.io/jenkins/ssh-agent:1.2.3-jdk21-preview",
        "docker.io/jenkins/ssh-agent:bookworm-jdk21-preview",
        "docker.io/jenkins/ssh-agent:debian-jdk21-preview",
        "docker.io/jenkins/ssh-agent:jdk21-preview",
        "docker.io/jenkins/ssh-agent:latest-bookworm-jdk21-preview",
        "docker.io/jenkins/ssh-agent:latest-debian-jdk21-preview",
        "docker.io/jenkins/ssh-agent:latest-jdk21-preview"
      ],
      "platforms": [
        "linux/arm/v7"
      ]
    }
  }
}

Submitter checklist

Give feedback

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests - that demonstrates feature works or fixes the issue
Options

lemeurherve · 2024-05-10T16:04:26Z

docker-bake.hcl

-  ]
-  platforms = ["linux/amd64"]
+variable "default_jdk" {
+  default = 17


Suggested change

default = 17

default = 11

Setting the default JDK to 11 so we can introduce this pull request without any (breaking) change.

Solving #399 will then be as simple as setting this default_jdk value to 17.

Compared to the changes needed in https://github.com/jenkinsci/docker-ssh-agent/pull/400/files, this illustrates the benefit of this PR.

chore/breaking(Linux): factorise jdk in docker-bake.hcl

7c8b4ff

lemeurherve added enhancement chore breaking Breaking change alpine debian labels May 8, 2024

lemeurherve requested a review from a team as a code owner May 8, 2024 15:22

lemeurherve mentioned this pull request May 8, 2024

breaking(Linux): short tags targeting Java 17 instead of Java 11 #400

Merged

timja previously approved these changes May 8, 2024

View reviewed changes

nits & missing debian_platforms

f084584

lemeurherve dismissed timja’s stale review via f084584 May 9, 2024 09:40

timja previously approved these changes May 9, 2024

View reviewed changes

lemeurherve mentioned this pull request May 9, 2024

chore: factorise jdk in docker-bake.hcl jenkinsci/docker-agent#804

Merged

simplify

6044f4d

lemeurherve dismissed timja’s stale review via 6044f4d May 9, 2024 10:33

timja previously approved these changes May 9, 2024

View reviewed changes

lemeurherve commented May 10, 2024

View reviewed changes

lemeurherve changed the title ~~chore/breaking(Linux): factorise jdk in docker-bake.hcl~~ chore(Linux): factorise jdk in docker-bake.hcl May 10, 2024

Set jdk11 by default so no breaking chnage

427788c

lemeurherve dismissed timja’s stale review via 427788c May 10, 2024 16:04

lemeurherve removed the breaking Breaking change label May 10, 2024

timja approved these changes May 10, 2024

View reviewed changes

MarkEWaite approved these changes May 10, 2024

View reviewed changes

MarkEWaite merged commit 0f652a6 into jenkinsci:master May 10, 2024
9 checks passed

lemeurherve deleted the factorise-jdk-in-docker-bake branch May 14, 2024 22:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(Linux): factorise jdk in docker-bake.hcl #401

chore(Linux): factorise jdk in docker-bake.hcl #401

lemeurherve commented May 8, 2024 •

edited

Loading

Submitter checklist

lemeurherve May 10, 2024

lemeurherve May 10, 2024

chore(Linux): factorise jdk in docker-bake.hcl #401

chore(Linux): factorise jdk in docker-bake.hcl #401

Conversation

lemeurherve commented May 8, 2024 • edited Loading

Testing done

Submitter checklist

lemeurherve May 10, 2024

Choose a reason for hiding this comment

lemeurherve May 10, 2024

Choose a reason for hiding this comment

lemeurherve commented May 8, 2024 •

edited

Loading