QG X checks (Release 24.03)

[evegufy]

QG checks

Please keep this issue open until QG is concluded and will be managed by the Issue Creator!
We will inform you about finding and proposals in separated issues, this issue here is for the Overview of the Checks!

Please keep this issue open until QG is concluded!

Product Owner: @ciprianherciu
Dev SPOC: @adkumar1
Helm Chart Version: 2.1.11
App Version: 2.1.9

Release Managemnet Reference Issue:

Check of Tractus-X Release Guidelines

• Currently implemented automatic checks can be found under your product on our Release Guidelines Checks Board
• This QG Check is depending on the mandatory information from our current Release Guidelines

TRG 1 Documentation

• TRG 1.01 appropriate README.md
• TRG 1.02 appropriate install instructions either INSTALL.md or in README.md TRG 1.02: Improve INSTALL.md #97
• TRG 1.03 appropriate CHANGELOG.md
• TRG 1.04 editable static files

TRG 2 Git

• TRG 2.01 default branch is named main
• TRG 2.03 repository structure
• TRG 2.04 leading product repository
• TRG 2.05 .tractusx metafile in a proper format

TRG 3 Kubernetes

• TRG 3.02 persistent volume and persistent volume claim is used when needed

TRG 4 Container

• TRG 4.01 semantic versioning and tagging
• TRG 4.02 base image is agreed
• TRG 4.03 image has USER command and Non Root Container TRG 4.03: adjust securityContext #93
• TRG 4.05 released image must be placed in DockerHub, remove GHCR references
• TRG 4.06 separate notice file for DockerHub has all necessary information TRG 4.06: Dedicated notice for docker image #95

TRG 5 Helm

• TRG 5.01 Helm chart requirements
• TRG 5.02 Helm chart location in /charts directory and correct structure
• TRG 5.03 proper version strategy
• TRG 5.04 CPU / MEM resource requests and limits and are properly set
• TRG 5.06 Application must be configurable through the Helm chart
• TRG 5.07 Dependencies are present and properly configured in the Chart.yaml QG X checks (Release 24.03) #92 (comment)
• TRG 5.08 Product has a single deployable helm chart that contains all components
• TRG 5.09 Helm Test running properly
• TRG 5.10 Products need to support 3 versions at a time
• TRG 5.11 Upgradeability

TRG 6 Released Helm Chart

• TRG 6.01 Released Helm Chart

TRG 7 Open Source Governance

• TRG 7.01 Legal Documentation
• TRG 7.02 License and copyright header TRG 7.02: Add license and copyright header to .tractusx #96
• TRG 7.03 IP checks for project content
• TRG 7.04 IP checks for 3rd party content chore(ci): check dependencies with dash-tool #105
• TRG 7.05 Legal information for distributions
• TRG 7.06 Legal information for end user content
• TRG 7.07 Legal notice for documentation TRG 7.07: Remove file header from md file and add NOTICE as post or preamble instead #94
• TRG 7.08 Legal notice for KIT documentation

Hints

Information Sharing

[MehranRoshandel]

Hi, The Product Owner is @herciu, ***@***.***>. Dr. Ing. Mehran Roshandel

[evegufy]

Regarding TRG 5.07: could you please provide some insight into how the app manages its state? I don't see any database dependency in the Chart.yaml

[evegufy]

I created #105 for automated dependencies check.

[evegufy]

Regarding TRG 5.07: could you please provide some insight into how the app manages its state? I don't see any database dependency in the Chart.yaml

@adkumar1 @ciprianherciu could one of you, please answer that question?

[adkumar1]

there are no database dependency for this application

[dvasunin]

Regarding TRG 5.07: could you please provide some insight into how the app manages its state? I don't see any database dependency in the Chart.yaml

@adkumar1 @ciprianherciu could one of you, please answer that question?

Dear @evegufy, the SD Factory is a stateless application. State is not kept between calls, the database is not needed. Currently it is a simple converter, transforming its input to the output.

[evegufy]

@adkumar1 @dvasunin all requested changes are in main now, I'll keep this issue open until a new version has been released

[adkumar1]

There is 1 more PR #106
Can you please merge that as well

[evegufy]

@adkumar1 ok new chart version has been released, what about the docker images?

[adkumar1]

As all the changes for this release are completed, so you can create a new docker image with tag v2.1.10 & release with tag v2.1.10

[evegufy]

As all the changes for this release are completed, so you can create a new docker image with tag v2.1.10 & release with tag v2.1.10

done, I also created a new release https://github.com/eclipse-tractusx/sd-factory/releases/tag/v2.1.10