Feat/dockerhub images release

.github/workflows/build-docker-all.yaml

@@ -22,20 +22,23 @@ on:
 jobs:
   build-docker-pool:
     uses: ./.github/workflows/build-docker.yaml
+    secrets: inherit
     with:
       imageName: pool
       dockerfilePath: ./bpdm-pool/Dockerfile
       push: ${{ github.event_name != 'pull_request' }}
 
   build-docker-gate:
     uses: ./.github/workflows/build-docker.yaml
+    secrets: inherit
     with:
       imageName: gate
       dockerfilePath: ./bpdm-gate/Dockerfile
       push: ${{ github.event_name != 'pull_request' }}
 
   build-docker-bridge-dummy:
     uses: ./.github/workflows/build-docker.yaml
+    secrets: inherit
     with:
       imageName: bridge-dummy
       dockerfilePath: ./bpdm-bridge-dummy/Dockerfile

.github/workflows/build-docker.yaml

@@ -18,15 +18,15 @@ on:
 
 
 env:
-  # Use docker.io for Docker Hub if empty
-  REGISTRY: ghcr.io
-  # github.repository as <account>/<repo>
-  IMAGE_NAME: ${{ github.repository }}/${{ inputs.imageName }}
+  IMAGE_NAMESPACE: "tractusx"
+  IMAGE_NAME: ${{ inputs.imageName }}
+
 jobs:
-  build-docker:
+  docker:
     runs-on: ubuntu-latest
     permissions:
       packages: write
+
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -37,27 +37,42 @@ jobs:
         uses: docker/metadata-action@v4
         with:
           images: |
-            ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+            ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}
+          # Automatically prepare image tags; See action docs for more examples.
+          # semver patter will generate tags like these for example :1 :1.2 :1.2.3
           tags: |
             type=ref,event=branch
             type=ref,event=pr
             type=semver,pattern={{version}}
             type=semver,pattern={{major}}
             type=semver,pattern={{major}}.{{minor}}
 
-      - name: Log into registry ${{ env.REGISTRY }}
+      - name: DockerHub login
         if: github.event_name != 'pull_request'
         uses: docker/login-action@v2
         with:
-          registry: ${{ env.REGISTRY }}
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
+          # Use existing DockerHub credentials present as secrets
+          username: ${{ secrets.DOCKER_HUB_USER }}
+          password: ${{ secrets.DOCKER_HUB_TOKEN }}
 
       - name: Build and push
         uses: docker/build-push-action@v3
         with:
           context: .
-          push: ${{ inputs.push }}
-          file: ${{ inputs.dockerfilePath }}
+          # Build image for verification purposes on every trigger event. Only push if event is not a PR
+          push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      # https://github.com/peter-evans/dockerhub-description
+      # Important step to push image description to DockerHub
+      - name: Update Docker Hub description
+        if: github.event_name != 'pull_request'
+        uses: peter-evans/dockerhub-description@v3
+        with:
+        # readme-filepath defaults to toplevel README.md, Only necessary if you have a dedicated file with your 'Notice for docker images'
+        # readme-filepath: path/to/dedicated/notice-for-docker-image.md
+          username: ${{ secrets.DOCKER_HUB_USER }}
+          password: ${{ secrets.DOCKER_HUB_TOKEN }}
+          repository: ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}
+          readme-filepath: "DOCKER_NOTICE.md"

INSTALL.md

@@ -6,25 +6,31 @@ This file contains information on how to configure and run the BPDM applications
 
 BPDM Pool is a SpringBoot Kotlin software project managed by Maven.
 
-The project can be run with the following command: `mvn clean spring-boot:run`
+To run the project first you need to install it from the parent pom, go to the root folder and run `mvn clean install`
+
+Then depending on which module you want to start go to the module subfolder you like to run and use the following command: `mvn spring-boot:run`
 
 ### Prerequisites
 
 * Maven
 * JDK17
-* PostgreSQL 14.2
-* OpenSearch 2.1.0
+* Docker and Docker Compose
 * Keycloak 17.0.0 (with enabled `auth` profile)
-* Connection to an SaaS for the sharing process (with enabled `saas` profile)
 
-When running, the project requires a Postgresql database and an Opensearch instance to be available to connect to.
+When running, the project requires a PostgreSQL database and an OpenSearch instance to be available to connect to. You can set up these dependencies manually, or you can use the provided `docker-compose` file which will start the necessary dependencies for you.
+
+To use Docker Compose, navigate to the project directory and run the following command:
+```bash
+docker-compose up
+```
+
 Per default configuration the application expects postgres to run on `localhost` on port `5432`.
 Opensearch needs to run on `localhost` on port `9200` on default.
 
-You can find and edit the default configuration for the Pool in the `application.properties`,  `application-auth.properties` and `application-saas.properties`
+You can find and edit the default configuration for the Pool in the `application.properties`,  `application-auth.properties`
 files in the `resources` folder.
 
-The REST API documentation can be accessed at http://localhost:8080/api/swagger-ui.
+The REST API documentation can be accessed at http://localhost:8080/ui/swagger-ui/index.html.
 
 ### Profiles
 
@@ -33,11 +39,10 @@ Here you can find core application configuration such as Swagger documentation,
 Furthermore, here you can find the configuration for the connection to the Spring datasource (currently, developed against PostgreSQL) and Opensearch.
 
 You can also run the project with Spring profiles to enable additional components on top of the default configuration.
-Currently, the BPDM Pool offers the profiles `auth` and `saas`.
+Currently, the BPDM Pool offers the profile `auth`.
 In order to run the application with a specific profile you can use the appropriate maven flag `Dspring.profiles.active`.
 
 For example, the command `mvn clean spring-boot:run -Dspring.profiles.active=auth` starts the application with additional `auth` configuration enabled.
-You can also run several profiles at once, of course: `mvn clean spring-boot:run -Dspring.profiles.active=auth,saas`.
 
 The following sections detail the configuration properties for each profile.
 
@@ -50,23 +55,14 @@ The application uses the configured auth server URL to validate incoming tokens.
 
 For authorization purposes the application checks incoming token's permissions:
 
-* add_company_data: For endpoints creating or updating business partner records including triggering imports from SaaS/exports to Opensearch
+* add_company_data: For endpoints creating or updating business partner records
 * view_company_data: For read-only endpoints of business partner data
 
 The BPDM Pool looks for these permissions in the client/resource and not on the realm level.
 
 This profile also enables/disables the login form in the auto-generated Swagger documentation.
 The Swagger login uses the client specified in the property `springdoc.swagger-ui.oauth.client-id`.
 
-### SaaS
-
-The file `application-saas.properties` enables and configures the connection to a remote SaaS for the sharing process from which the application can import
-business partner records.
-Depending on whether this component is enabled, the application offers an endpoint to import records from SaaS.
-If enabled the application requires the environment variable `BPDM_SAAS_KEY` to contain an API key with necessary privileges for accessing the specified
-storage.
-Further, you need to provide a hostname (`BPDM_SAAS_HOST`), storage ID (`BPDM_SAAS_STORAGE`) and datasource ID `BPDM_SAAS_DATASOURCE` to specify from where the records
-should be imported by the application.
 
 ### Helm Deployment
 
@@ -81,25 +77,21 @@ BPDM is a SpringBoot Kotlin software project managed by Maven and can be run wit
 
 * Maven
 * JDK17
-* Connection to an SaaS for the sharing process
 * Connection to BPDM Pool API
 * Keycloak 17.0.0 (with enabled `auth` or `pool-auth` profile)
 
-When running, the BPDM Gate requires a remote SaaS storage and datasource to exchange data with.
-The application expects the environment variables `BPDM_SAAS_HOST`, `BPDM_SAAS_KEY`, `BPDM_SAAS_STORAGE` and `BPDM_SAAS_DATASOURCE` to contain the hostname to connect to, the API key and 
-the identifiers for the storage and datasource respectively.
 
 The Gate also requires a connection to a BPDM Pool instance which is expected at `localhost` with port `8080` on default configuration.
 
 You can find and edit the default configuration for the Gate in the `application.properties`,  `application-auth.properties`
 and  `application-pool-auth.properties` files in the `resources` folder.
 
-The REST API documentation can be accessed at http://localhost:8081/api/swagger-ui.
+The REST API documentation can be accessed at http://localhost:8081/ui/swagger-ui/index.html.
 
 ### Profiles
 
 The default configuration of the application is determined by the `application.properties` file.
-Here you can find core application configuration such as Swagger documentation, SaaS and BPDM Pool connection.
+Here you can find core application configuration such as Swagger documentation and BPDM Pool connection.
 
 You can also run the project with Spring profiles to enable additional components on top of the default configuration.
 Currently, the BPDM Gate offers the profiles `auth` and `auth-pool`.

bpdm-bridge-dummy/DOCKER_NOTICE.md

@@ -0,0 +1,28 @@
+## Notice for Docker image
+
+DockerHub: [https://hub.docker.com/r/tractusx/bpdm](https://hub.docker.com/r/tractusx/bpdm)
+
+Eclipse Tractus-X product(s) installed within the image:
+
+**BPDM Bridge**
+
+Eclipse Tractus-X product(s) installed within the image:
+
+- GitHub: https://github.com/eclipse-tractusx/bpdm 
+- Project home: https://projects.eclipse.org/projects/automotive.tractusx
+- Bridge Dockerfile: https://github.com/eclipse-tractusx/bpdm/blob/main/bpdm-brige-dumy/Dockerfile 
+- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/bpdm/blob/main/LICENSE)
+
+
+**Used base image**
+
+- [eclipse-temurin:17-jre-alpine](https://github.com/adoptium/containers)
+- Official Eclipse Temurin DockerHub page: https://hub.docker.com/_/eclipse-temurin
+- Eclipse Temurin Project: https://projects.eclipse.org/projects/adoptium.temurin
+- Additional information about the Eclipse Temurin images: https://github.com/docker-library/repo-info/tree/master/repos/eclipse-temurin
+
+
+As with all Docker images, these likely also contain other software which may be under other licenses
+(such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
+
+As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

bpdm-bridge-dummy/pom.xml

@@ -76,6 +76,10 @@
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-oauth2-client</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-security</artifactId>
+		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-configuration-processor</artifactId>

bpdm-pool-api/src/main/kotlin/org/eclipse/tractusx/bpdm/pool/api/model/response/SuggestionResponse.kt → bpdm-bridge-dummy/src/main/kotlin/com/catenax/bpdm/bridge/dummy/config/BridgeAuthProperties.kt

@@ -17,14 +17,16 @@
  * SPDX-License-Identifier: Apache-2.0
  ******************************************************************************/
 
-package org.eclipse.tractusx.bpdm.pool.api.model.response
+package com.catenax.bpdm.bridge.dummy.config
 
-import io.swagger.v3.oas.annotations.media.Schema
+import org.springframework.boot.context.properties.ConfigurationProperties
+import org.springframework.context.annotation.Configuration
 
-@Schema(name = "SuggestionResponse", description = "Shows a ranked suggestion based on a given search text")
-data class SuggestionResponse(
-    @Schema(description = "The suggestion text")
-    val suggestion: String,
-    @Schema(description = "Relative relevancy score indicating quality of the match, higher is better")
-    val relevancy: Float
-)
+@Configuration
+@ConfigurationProperties(prefix = "bpdm.bridge")
+class BridgeAuthProperties {
+    var syncAuthorities: List<String> = listOf()
+
+    val syncAuthority: String
+        get() = syncAuthorities.joinToString(", ") { "ROLE_$it" }
+}

bpdm-bridge-dummy/src/main/kotlin/com/catenax/bpdm/bridge/dummy/controller/BridgeController.kt

@@ -21,6 +21,7 @@ package com.catenax.bpdm.bridge.dummy.controller
 
 import com.catenax.bpdm.bridge.dummy.service.SyncService
 import io.swagger.v3.oas.annotations.Operation
+import org.springframework.security.access.prepost.PreAuthorize
 import org.springframework.web.bind.annotation.PostMapping
 import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RestController
@@ -35,6 +36,7 @@ class BridgeController(
         summary = "Start sync between Gate and Pool"
     )
     @PostMapping("/sync")
+    @PreAuthorize("hasAnyAuthority(@bridgeAuthProperties.syncAuthority)")
     fun triggerSync() {
         syncService.sync()
     }

bpdm-bridge-dummy/src/main/kotlin/com/catenax/bpdm/bridge/dummy/dto/GateAddressInfo.kt

@@ -19,10 +19,10 @@
 
 package com.catenax.bpdm.bridge.dummy.dto
 
-import org.eclipse.tractusx.bpdm.common.dto.LogisticAddressDto
+import org.eclipse.tractusx.bpdm.gate.api.model.LogisticAddressGateDto
 
 data class GateAddressInfo(
-    val address: LogisticAddressDto,
+    val address: LogisticAddressGateDto,
     val externalId: String,
     val legalEntityExternalId: String?,
     val siteExternalId: String?,

bpdm-bridge-dummy/src/main/kotlin/com/catenax/bpdm/bridge/dummy/dto/GateLegalEntityInfo.kt

@@ -20,10 +20,12 @@
 package com.catenax.bpdm.bridge.dummy.dto
 
 import org.eclipse.tractusx.bpdm.common.dto.LegalEntityDto
+import org.eclipse.tractusx.bpdm.gate.api.model.AddressGateInputResponse
 
 data class GateLegalEntityInfo(
-    val legalNameParts: Array<String> = emptyArray(),
+    val legalNameParts: List<String> = emptyList(),
     val legalEntity: LegalEntityDto,
+    val legalAddress: AddressGateInputResponse,
     val externalId: String,
     val bpn: String?
 )

bpdm-bridge-dummy/src/main/kotlin/com/catenax/bpdm/bridge/dummy/dto/GateSiteInfo.kt

@@ -19,11 +19,13 @@
 
 package com.catenax.bpdm.bridge.dummy.dto
 
-import org.eclipse.tractusx.bpdm.common.dto.SiteDto
+import org.eclipse.tractusx.bpdm.gate.api.model.LogisticAddressGateDto
+import org.eclipse.tractusx.bpdm.gate.api.model.SiteGateDto
 
 data class GateSiteInfo(
-    val site: SiteDto,
+    val site: SiteGateDto,
     val externalId: String,
     val legalEntityExternalId: String,
+    val mainAddress: LogisticAddressGateDto,
     val bpn: String?
 )