Commit 8e775dce authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

fix: replace deprecated Docker Hub registry FQDN

parent 9643b5e3

README.md

+6 −6
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ include: 
    # 2: set/override component inputs

    inputs:

      # ⚠ this is only an example

      image: registry.hub.docker.com/library/maven:3.8-openjdk-18

      image: docker.io/library/maven:3.8-openjdk-18

      deploy-enabled: true

```
@@ -36,7 +36,7 @@ include: 
variables:

  # 2: set/override template variables

  # ⚠ this is only an example

  MAVEN_IMAGE: registry.hub.docker.com/library/maven:3.8-openjdk-18

  MAVEN_IMAGE: docker.io/library/maven:3.8-openjdk-18

  MAVEN_DEPLOY_ENABLED: "true"

```
@@ -46,7 +46,7 @@ The Maven template uses some global configuration throughout all jobs. 


| Input / Variable                    | Description                                                                                                        | Default value |

| --------------------- |--------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|

| `image` / `MAVEN_IMAGE`             | The Docker image used to run Maven <br/>:warning: **set the version required by your project**                     | `registry.hub.docker.com/library/maven:latest` <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-MAVEN_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-MAVEN_IMAGE) |

| `image` / `MAVEN_IMAGE`             | The Docker image used to run Maven <br/>:warning: **set the version required by your project**                     | `docker.io/library/maven:latest` <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-MAVEN_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-MAVEN_IMAGE) |

| `project-dir` / `MAVEN_PROJECT_DIR` | Maven projet root directory                                                                                        | `.` |

| `cfg-dir` / `MAVEN_CFG_DIR`         | The Maven configuration directory                                                                                  | `.m2` |

| `settings-file` / `MAVEN_SETTINGS_FILE` | The Maven `settings.xml` file path                                                                             | `${MAVEN_CFG_DIR}/settings.xml` |
@@ -56,7 +56,7 @@ The Maven template uses some global configuration throughout all jobs. 
### About `$MAVEN_IMAGE`



Each job in the template will use the defined container image to provide the Maven and Java runtime to the job context.

That's why it is mandatory that you set the version of Maven as required by your project (e.g. `registry-1.docker.io/library/maven:3.9.9-eclipse-temurin-21` for Maven 3.9.9 on Eclipse Temurin JDK 21).

That's why it is mandatory that you set the version of Maven as required by your project (e.g. `docker.io/library/maven:3.9.9-eclipse-temurin-21` for Maven 3.9.9 on Eclipse Temurin JDK 21).



#### Use of the Maven Wrapper
@@ -492,9 +492,9 @@ The template uses GitLab registries and authentication defaults. See the Docker 


| Input / Variable | Description              | Default value                                     |

| -------------------------------------- | ------------------------ | ------------------------------------------------- |

| `sbom-image` / `MAVEN_SBOM_IMAGE` | The image used to perform and complete the Security Bill of Materials | `registry.hub.docker.com/anchore/syft:debug` |

| `sbom-image` / `MAVEN_SBOM_IMAGE` | The image used to perform and complete the Security Bill of Materials | `docker.io/anchore/syft:debug` |

| `sbom-opts` / `MAVEN_SBOM_OPTS` | SBOM options to complete the Security Bill of Materials  | `--override-default-catalogers rpm-db-cataloger,alpm-db-cataloger,apk-db-cataloger,dpkg-db-cataloger,portage-cataloger,nix-store-cataloger,java`          |

| `trivy-image` / `MAVEN_TRIVY_IMAGE` | The image to perform container security scanning  | `registry.hub.docker.com/aquasec/trivy:latest` |

| `trivy-image` / `MAVEN_TRIVY_IMAGE` | The image to perform container security scanning  | `docker.io/aquasec/trivy:latest` |

| `trivy-args` / `MAVEN_TRIVY_ARGS` | Additional [`trivy image` options](https://aquasecurity.github.io/trivy/latest/docs/references/configuration/cli/trivy_image/#options) | `--ignore-unfixed --pkg-types os` |



Other Trivy parameters shall be configured using [Trivy environment variables](https://aquasecurity.github.io/trivy/latest/docs/references/configuration/cli/trivy_image/#options).

kicker.json

+3 −3
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ 
    {

      "name": "MAVEN_IMAGE",

      "description": "The Docker image used to run Maven - **set the version required by your project**",

      "default": "registry.hub.docker.com/library/maven:latest"

      "default": "docker.io/library/maven:latest"

    },

    {

      "name": "MAVEN_PROJECT_DIR",
@@ -231,7 +231,7 @@ 
            {

              "name": "MAVEN_TRIVY_IMAGE",

              "description": "The docker image used to scan images with Trivy",

              "default": "registry.hub.docker.com/aquasec/trivy:latest",

              "default": "docker.io/aquasec/trivy:latest",

              "advanced": true

            },

            {
@@ -250,7 +250,7 @@ 
          "variables": [

            {

              "name": "MAVEN_SBOM_IMAGE",

              "default": "registry.hub.docker.com/anchore/syft:debug",

              "default": "docker.io/anchore/syft:debug",

              "advanced": true

            },

            {

templates/gitlab-ci-maven-jib.yml

+2 −2
Original line number Diff line number Diff line
@@ -31,12 +31,12 @@ spec: 
      default: false

    trivy-image:

      description: The docker image used to scan images with Trivy

      default: registry.hub.docker.com/aquasec/trivy:latest

      default: docker.io/aquasec/trivy:latest

    trivy-args:

      description: Additional [`trivy image` options](https://aquasecurity.github.io/trivy/latest/docs/references/configuration/cli/trivy_image/#options)

      default: --ignore-unfixed --pkg-types os

    sbom-image:

      default: registry.hub.docker.com/anchore/syft:debug

      default: docker.io/anchore/syft:debug

    sbom-opts:

      description: Options for syft used for SBOM analysis

      default: --override-default-catalogers rpm-db-cataloger,alpm-db-cataloger,apk-db-cataloger,dpkg-db-cataloger,portage-cataloger,nix-store-cataloger,java

templates/gitlab-ci-maven.yml

+1 −1
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ spec: 
    image:

      description: The Docker image used to run Maven - **set the version required by

        your project**

      default: registry.hub.docker.com/library/maven:latest

      default: docker.io/library/maven:latest

    project-dir:

      description: Maven project root directory

      default: .