Skip to content

Commit

Permalink
feature: TRACEFOSS-1473 merge main and add changelog info
Browse files Browse the repository at this point in the history
  • Loading branch information
ds-ext-sceronik committed Jul 11, 2023
2 parents 03539a6 + ebe6683 commit c918660
Show file tree
Hide file tree
Showing 77 changed files with 11,981 additions and 9,534 deletions.
52 changes: 52 additions & 0 deletions .github/workflows/helm-test-backwards-compatability.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Copyright (c) 2023 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License, Version 2.0 which is available at
# https://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.
#
# SPDX-License-Identifier: Apache-2.0
name: Test k8s version compatability

on:
workflow_dispatch:
inputs:
node_image_latest:
description: 'First version of kindest/node image for k8s kind cluster'
default: 'kindest/node:v1.27.3'
required: false
type: string
node_image_second_latest:
description: 'Second version of kindest/node image for k8s kind cluster'
default: 'kindest/node:v1.26.6'
required: false
type: string
node_image_third_latest:
description: 'Third version of kindest/node image for k8s kind cluster'
default: 'kindest/node:v1.25.11'
required: false
type: string

jobs:
test-latest:
uses: ./.github/workflows/helm-test.yaml
with:
node_image: ${{ github.event.inputs.node_image_latest || 'kindest/node:v1.27.3' }}

test-second-latest:
uses: ./.github/workflows/helm-test.yaml
with:
node_image: ${{ github.event.inputs.node_image_second_latest || 'kindest/node:v1.26.6' }}

test-third-latest:
uses: ./.github/workflows/helm-test.yaml
with:
node_image: ${{ github.event.inputs.node_image_third_latest || 'kindest/node:v1.25.11' }}
7 changes: 7 additions & 0 deletions .github/workflows/helm-test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ on:
paths:
- 'charts/**'
workflow_dispatch:
workflow_call: # Trigger by another workflow
inputs:
node_image:
description: 'kindest/node image for k8s kind cluster'
default: 'kindest/node:v1.27.3'
required: false
type: string

env:
REGISTRY: kind-registry:5000
Expand Down
60 changes: 60 additions & 0 deletions .github/workflows/helm-upgrade.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Copyright (c) 2023 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License, Version 2.0 which is available at
# https://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.
#
# SPDX-License-Identifier: Apache-2.0
name: Upgrade Charts

on:
pull_request:
paths:
- 'charts/traceability-foss/**'
workflow_dispatch:

jobs:
upgrade:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Kubernetes KinD Cluster
uses: container-tools/kind-action@v2

- name: Set up Helm
uses: azure/setup-helm@v3
with:
version: v3.9.3

- name: Add repos
run: |
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo add irs-helm https://eclipse-tractusx.github.io/item-relationship-service
helm repo add postgresql https://charts.bitnami.com/bitnami
helm repo add tractusx-connector https://eclipse-tractusx.github.io/charts/dev
helm repo add runix https://helm.runix.net
helm repo add tracex https://eclipse-tractusx.github.io/traceability-foss
- name: Run helm install
# Install latest released traceability-foss version
run: |
helm install tracex tracex/traceability-foss
- name: Run helm upgrade
# Upgrade the installed traceability-foss version with the locally available charts
run: |
helm dependency update charts/traceability-foss
helm upgrade tracex charts/traceability-foss
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,33 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
## [Unreleased]

### Added

### Changed

- Modified IRS Policies support to handle multiple policies

### Removed

## [5.0.0] - 2023-07-10

### Added

- Added back button in notification detailed view
- Added alert detail view
- EDC SPI Dependency for using provided models
- Added default response types to apis
- Irs policies support ( on application startup registers policies in irs instance )
- Added helm upgrade workflow to test upgradeability of the helm charts
- Added helm test backwards compatability to test the helm charts with the latest kubernetes versions

### Changed

- Changed Layout in notification detailed view
- Changed request parameter for registerjob request to irs to match requirements of irs
- Migration of edc 0.4.1 endpoints and api flow
- fixed bug where language switcher did not update to the selected language
- Changed SerialPartTypization aspect model to SerialPart
- Changed AssemblyPartRelationship aspect model to SingleLevelBomAsBuilt

### Removed

Expand Down
2 changes: 1 addition & 1 deletion DEPENDENCIES_BACKEND
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ maven/mavencentral/com.fasterxml.jackson.core/jackson-databind/2.14.2, Apache-2.
maven/mavencentral/com.fasterxml.jackson.core/jackson-databind/2.14.3, Apache-2.0, approved, #4105
maven/mavencentral/com.fasterxml.jackson.dataformat/jackson-dataformat-yaml/2.14.0, Apache-2.0, approved, #5933
maven/mavencentral/com.fasterxml.jackson.dataformat/jackson-dataformat-yaml/2.14.3, Apache-2.0, approved, #5933
maven/mavencentral/com.fasterxml.jackson.datatype/jackson-datatype-jakarta-jsonp/2.14.3, , restricted, clearlydefined
maven/mavencentral/com.fasterxml.jackson.datatype/jackson-datatype-jakarta-jsonp/2.14.3, Apache-2.0, approved, #9302
maven/mavencentral/com.fasterxml.jackson.datatype/jackson-datatype-jakarta-jsonp/2.15.1, Apache-2.0, approved, #9179
maven/mavencentral/com.fasterxml.jackson.datatype/jackson-datatype-jdk8/2.14.3, Apache-2.0, approved, #8597
maven/mavencentral/com.fasterxml.jackson.datatype/jackson-datatype-jsr310/2.14.3, Apache-2.0, approved, #4699
Expand Down
2 changes: 1 addition & 1 deletion DEPENDENCIES_FRONTEND
Original file line number Diff line number Diff line change
Expand Up @@ -1354,7 +1354,7 @@ npm/npmjs/@jridgewell/gen-mapping/0.3.3, MIT, approved, clearlydefined
npm/npmjs/@jridgewell/resolve-uri/3.0.6, MIT, approved, clearlydefined
npm/npmjs/@jridgewell/resolve-uri/3.1.0, MIT, approved, clearlydefined
npm/npmjs/@jridgewell/set-array/1.1.2, MIT, approved, clearlydefined
npm/npmjs/@jridgewell/source-map/0.3.3, MIT, approved, clearlydefined
npm/npmjs/@jridgewell/source-map/0.3.3, MIT, approved, #9304
npm/npmjs/@jridgewell/sourcemap-codec/1.4.14, MIT, approved, clearlydefined
npm/npmjs/@jridgewell/sourcemap-codec/1.4.15, MIT, approved, clearlydefined
npm/npmjs/@jridgewell/trace-mapping/0.3.18, MIT, approved, clearlydefined
Expand Down
24 changes: 16 additions & 8 deletions DOCKER_NOTICE.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,30 @@
## Notice for Docker image

This application provides container images for demonstration purposes.

DockerHub Backend: https://hub.docker.com/r/tractusx/traceability-foss

DockerHub Frontend : https://hub.docker.com/r/tractusx/traceability-foss-frontend

Eclipse Tractus-X product(s) installed within the image:

- GitHub: https://github.com/eclipse-tractusx/traceability-foss
- Project home: https://projects.eclipse.org/projects/automotive.tractusx
- Dockerfile: https://github.com/eclipse-tractusx/traceability-foss/blob/main/Dockerfile
- Dockerfile Backend: https://github.com/eclipse-tractusx/traceability-foss/blob/main/Dockerfile
- Dockerfile Frontend: https://github.com/eclipse-tractusx/traceability-foss/blob/main/frontend/Dockerfile
- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/traceability-foss/blob/main/LICENSE)

**Used base image**
- [eclipse-temurin](https://hub.docker.com/_/eclipse-temurin)
- 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
**Used base image backend**

- [Official Eclipse Temurin DockerHub page](https://hub.docker.com/_/eclipse-temurin)
- [GitHub repo eclipse-temurin:17-jre-alpine](https://github.com/adoptium/containers)
- [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)

**Used base image frontend**

- [nginx-unprivileged](https://hub.docker.com/r/nginxinc/nginx-unprivileged)
- [Dockerfile (alpine)](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/Dockerfile-alpine.template)
- [GitHub project:](https://github.com/nginxinc/docker-nginx-unprivileged)
- [DockerHub](https://hub.docker.com/r/nginxinc/nginx-unprivileged)

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).

Expand Down
10 changes: 5 additions & 5 deletions charts/traceability-foss/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ apiVersion: v2
name: traceability-foss
description: An umbrella Helm chart for eclipse-tractusx/traceability-foss project
type: application
version: 1.3.9
appVersion: "4.1.0"
version: 1.3.10
appVersion: "5.0.0"
dependencies:
- name: frontend
repository: "file://charts/frontend"
version: 1.3.9
version: 1.3.10
- name: backend
repository: "file://charts/backend"
version: 1.3.9
version: 1.3.10
- name: postgresql
repository: https://charts.bitnami.com/bitnami
version: 11.x.x
Expand All @@ -39,7 +39,7 @@ dependencies:
condition: pgadmin4.enabled
- name: irs-helm
repository: https://eclipse-tractusx.github.io/item-relationship-service
version: 6.0.1
version: 6.1.0
condition: irs-helm.enabled
- condition: tractusx-connector.enabled
name: tractusx-connector
Expand Down
4 changes: 2 additions & 2 deletions charts/traceability-foss/charts/backend/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ apiVersion: v2
name: backend
description: A Helm chart for Traceability backend application
type: application
version: 1.3.9
appVersion: "4.1.0"
version: 1.3.10
appVersion: "5.0.0"
dependencies:
- name: postgresql
repository: https://charts.bitnami.com/bitnami
Expand Down
4 changes: 2 additions & 2 deletions charts/traceability-foss/charts/frontend/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ apiVersion: v2
name: frontend
description: A Helm chart for Traceability frontend application
type: application
version: 1.3.9
appVersion: "4.1.0"
version: 1.3.10
appVersion: "5.0.0"
4 changes: 2 additions & 2 deletions charts/traceability-foss/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ frontend:
cpu: 500m
memory: 512Mi
requests:
cpu: 500m
cpu: 125m
memory: 512Mi

nodeSelector: {}
Expand Down Expand Up @@ -222,7 +222,7 @@ backend:
cpu: 500m
memory: 512Mi
requests:
cpu: 500m
cpu: 125m
memory: 512Mi

nodeSelector: {}
Expand Down
20 changes: 10 additions & 10 deletions dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,25 +30,25 @@ In order to upload data to EDC Provider, please use [IRS project script](https:/
Sample invocation (DEV)

```
python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.3.json -s https://tracex-submodel-server.dev.demo.catena-x.net -edc https://trace-x-edc.dev.demo.catena-x.net -a https://trace-x-registry.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.4.json -s https://tracex-submodel-server.dev.demo.catena-x.net -edc https://trace-x-edc.dev.demo.catena-x.net -a https://trace-x-registry.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
```

Sample invocation (TEST)

```
python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.3.json -s https://tracex-submodel-server-test.dev.demo.catena-x.net -edc https://trace-x-test-edc.dev.demo.catena-x.net -a https://trace-x-registry-test.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.4.json -s https://tracex-submodel-server-test.dev.demo.catena-x.net -edc https://trace-x-test-edc.dev.demo.catena-x.net -a https://trace-x-registry-test.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
```

Sample invocation (E2E A)

```
python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.3.json -s https://tracex-submodel-server-e2e-a.dev.demo.catena-x.net -edc https://trace-x-edc-e2e-a.dev.demo.catena-x.net -a https://trace-x-registry-e2e-a.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.4.json -s https://tracex-submodel-server-e2e-a.dev.demo.catena-x.net -edc https://trace-x-edc-e2e-a.dev.demo.catena-x.net -a https://trace-x-registry-e2e-a.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
```

Sample invocation (E2E B)

```
python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.3.json -s https://tracex-submodel-server-e2e-b.dev.demo.catena-x.net -edc https://trace-x-edc-e2e-b.dev.demo.catena-x.net -a https://trace-x-registry-e2e-b.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.4.json -s https://tracex-submodel-server-e2e-b.dev.demo.catena-x.net -edc https://trace-x-edc-e2e-b.dev.demo.catena-x.net -a https://trace-x-registry-e2e-b.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
```

where:
Expand Down Expand Up @@ -162,7 +162,7 @@ Consists of a List of the following structured entries:
"childCatenaXId" : "urn:uuid:7eeeac86-7b69-444d-81e6-655d0f1513bd"
} ]
} ],
"urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" : [ {
"urn:bamm:io.catenax.serial_part:1.0.0#SerialPart" : [ {
"localIdentifiers" : [ {
"value" : "BPNL00000003CML1",
"key" : "manufacturerId"
Expand Down Expand Up @@ -212,10 +212,10 @@ Is achieved by defining the order of the BPNLs of the desired manufacturers. See
]
```
...AZQP -> ...3ML1 -> ...CNKC
and adding an AssemlyPartRelationship Aspect with the corresponding childCatenaXId:
and adding an SingleLevelBomAsBuilt Aspect with the corresponding childCatenaXId:
```json
{
"urn:bamm:io.catenax.assembly_part_relationship:1.1.0#AssemblyPartRelationship" : [ {
"urn:bamm:io.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt" : [ {
"catenaXId" : "urn:uuid:7eeeac86-7b69-444d-81e6-655d0f1513bd",
"childParts" : [ {
"quantity" : {
Expand Down Expand Up @@ -243,12 +243,12 @@ Is achieved through adding the SingleLevelusageBuilt - Codeblock and the corresp
[{
"catenaXId" : "urn:uuid:f11ddc62-3bd5-468f-b7b0-110fe13ed0cd",
"bpnl" : "BPNL00000003CNKC",
"urn:bamm:io.catenax.assembly_part_relationship:1.1.1#AssemblyPartRelationship": "[...]",
"urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" : "[...]"
"urn:bamm:io.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt": "[...]",
"urn:bamm:io.catenax.serial_part:1.0.0#SerialPart" : "[...]"
}, {
"catenaXId" : "urn:uuid:4e390dab-707f-446e-bfbe-653f6f5b1f37",
"bpnl" : "BPNL00000003AZQP",
"urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" : "",
"urn:bamm:io.catenax.serial_part:1.0.0#SerialPart" : "",
"urn:bamm:io.catenax.single_level_usage_as_built:1.0.1#SingleLevelUsageAsBuilt": [
{
"parentParts": [
Expand Down
2 changes: 1 addition & 1 deletion docs/src/docs/arc42/introduction-goals/requirements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
== Essential features
* List and view manufactured parts based on BoM AsBuild
* Show detailed information on manufactured parts from AAS description assets and Aspects
* Uses Submodels SerialPartTypization, AssemblyPartRelationship and Batch
* Uses Submodels SerialPart, AssemblyPartRelationship and Batch
* List and view Supplier parts (AssemblyPartRelationship) based on BoM AsBuild lifecycle
* View parts and parts relations in a visualized parts tree
* Send and receive top-down notifications (quality investigations) along the supply chain
Expand Down
4 changes: 2 additions & 2 deletions docs/src/docs/user/user-manual.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Supported languages:

== Parts
List view of the own manufactured parts and batches.
Gives detailed information on the assets registered in the Digital Twin Registry of Catena-X for the company. This includes data based on the aspect models of Use Case Traceability: SerialPartTypization, AssemblyPartRelationship, Batch.
Gives detailed information on the assets registered in the Digital Twin Registry of Catena-X for the company. This includes data based on the aspect models of Use Case Traceability: SerialPart, AssemblyPartRelationship, Batch.

image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/user-guide/parts-list-detailed-view.PNG[]

Expand Down Expand Up @@ -72,7 +72,7 @@ Once the quality investigation is created you will get a pop-up and can directly

== Other parts
List view of the supplied with parts and batches (Supplier parts).
Gives detailed information on the assets registered in the Digital Twin Registry of Catena-X for the supplier companies. This includes data that is ingested based on the aspect model AssemblyPartRelationship of the child parts for Use Case Traceability aspect models: SerialPartTypization, Batch.
Gives detailed information on the assets registered in the Digital Twin Registry of Catena-X for the supplier companies. This includes data that is ingested based on the aspect model AssemblyPartRelationship of the child parts for Use Case Traceability aspect models: SerialPart, Batch.

image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/user-guide/supplier-parts-list-detailed-view.PNG[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ entity AsBuiltAsset {
}

note right
SerialPartTypization and Batch
SerialPart and Batch
end note

enum SemanticDataModel {
BATCH,
SERIALPARTTYPIZATION
SERIALPART
}

entity AsPlannedAsset {
Expand Down
Loading

0 comments on commit c918660

Please sign in to comment.