QG checks (Release 24.08)

[evegufy]

QG checks

Please open and fill in this issue in your product repository to document the compliance with our Tractus-X Release Guideline (TRGs)

Show compliance with TRGs by referencing to a tagged link in the respective repository where possible, example: TRG 1.01 (see github.com/eclipse-tractusx/example-repo/tree/1.0.0/README.md)

Close this issue once the compliance with the TRGs has been documented

Committer(s): Helm Chart Version: App Version:

Release Management 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

• [x] TRG 1.01 appropriate README.md
• [x] TRG 1.02 appropriate install instructions either INSTALL.md or in README.md
• [x] TRG 1.03 appropriate CHANGELOG.md
• [x] TRG 1.04 editable static files

TRG 2 Git

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

TRG 3 Kubernetes

• [x] TRG 3.02 persistent volume and persistent volume claim or database dependency (subchart) are in place when needed

TRG 4 Container

• [x] TRG 4.01 semantic versioning and tagging
• [x] TRG 4.02 base image is agreed
• [x] TRG 4.03 image has USER command and Non Root Container
• [x] TRG 4.05 released image must be placed in DockerHub, remove GHCR references
• [x] TRG 4.06 separate notice file for DockerHub has all necessary information
• [x] TRG 4.07 root file system is set to read access by default, but can be overwritten by the user

TRG 5 Helm

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

TRG 6 Released Helm Chart

• [x] TRG 6.01 Released Helm Chart

TRG 7 Open Source Governance

• [x] TRG 7.01 Legal Documentation
• [x] TRG 7.02 License and copyright header
• [x] TRG 7.03 IP checks for project content
• [x] TRG 7.04 IP checks for 3rd party content
• [x] TRG 7.05 Legal information for distributions
• [x] TRG 7.06 Legal information for end user content
• [x] TRG 7.07 Legal notice for documentation
• [x] TRG 7.08 Legal notice for KIT documentation

TRG 8 Security

• [x] TRG 8.01 Mitigate high and above findings in CodeQL
• [x] TRG 8.02 Mitigate high and above findings in KICS
• [x] TRG 8.04 Mitigate high and above findings in Trivy
• [x] TRG 8.03 No secret findings by GitGuardian or TruffleHog

Hints

Information Sharing

[Phil91]

TRG 1 Documentation

TRG 1.01: https://github.com/eclipse-tractusx/ssi-authority-schema-registry/blob/v1.0.0-rc.1/README.md TRG 1.02: https://github.com/eclipse-tractusx/ssi-authority-schema-registry/blob/v1.0.0-rc.1/charts/ssi-authority-schema-registry/README.md TRG 1.03: https://github.com/eclipse-tractusx/ssi-authority-schema-registry/blob/v1.0.0-rc.1/CHANGELOG.md

TRG 2 Git

TRG 2.03: https://github.com/eclipse-tractusx/ssi-authority-schema-registry/tree/v1.0.0-rc.1 TRG 2.04: https://github.com/eclipse-tractusx/ssi-authority-schema-registry/blob/e87675a070e41b9fb275c4a67d00de7dbd6621fb/.tractusx#L21 TRG 2.05: https://github.com/eclipse-tractusx/ssi-authority-schema-registry/blob/v1.0.0-rc.1/.tractusx TRG 2.06: https://github.com/eclipse-tractusx/ssi-authority-schema-registry/security/dependabot

TRG 4 Container

TRG 4.05: service, migrations TRG 4.06: notice files TRG 4.07: migrations, service

TRG 5 Helm

TRG 5.01: chart-release, chart TRG 5.02: chart TRG 5.03: chart TRG 5.04: migrations, service TRG 5.07: dependencies TRG 5.08: chart TRG 5.09, 5.10, 5.11: chart test

TRG 6 Released Helm Chart

TRG 6.01: chart-release

TRG 7 Open Source Governance

TRG 7.01, 7.05: LICENSE, LICENSE_non_code, NOTICE, DEPENDECIES, SECURITY, CONTRIBUTING, CODE_OF_CONDUCT