QG checks (Release 24.03)

[almadigabor]

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: @TomBuchertTSystems
Dev SPOC: @drcgjung
Helm Chart Version: 1.11.16
App Version: 1.11.16

Release Managemnet Reference Issue: eclipse-tractusx/sig-release#495
Parent issue: eclipse-tractusx/knowledge-agents#93

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.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.05 released image must be placed in DockerHub, remove GHCR references
• TRG 4.06 separate notice file for DockerHub has all necessary information

TRG 5 Helm

• TRG 5.01 Helm chart must be released
• 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 #178
• TRG 5.06 Application must be configurable through the Helm chart
• TRG 5.07 Dependencies are present and properly configured in the Chart.yaml
• 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 #179

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 #180
• TRG 7.03 IP checks for project content
• TRG 7.04 IP checks for 3rd party content
• 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.08 Legal notice for KIT documentation

Hints

Information Sharing

[drcgjung]

I'm not allowed to change your ticket text. Is that info enough?

Product Owner: @TomBuchertTSystems
Helm Chart Version: 1.11.16
App Version: 1.11.16

[drcgjung]

trg 7.02 - should be solved by eclipse-tractusx/knowledge-agents#96 and #182

trg 5.04 - should be solved by eclipse-tractusx/knowledge-agents#96

trg 5.11 (and partially 5.09) - we have a dependency on tractusx-edc here which also has no test/upgradability (because of dependency on external charts like vault and postgresql which are not yet included in a test scenario). That was already the case for 23.12, but this will be improved by our moving to a new deployment architecture in 24.05 (agent/data plane chart instance that registers at a siblling edc/control plane instance).

[almadigabor]

Hey @drcgjung! I've approved the 2 PRs, let me know if I can merge them. For the upgradeability: tractusx-edc does have an upgradeability workflow, maybe you could give it a try. https://github.com/eclipse-tractusx/tractusx-edc/blob/main/.github/workflows/upgradeability-test.yaml