Managed Service Orchestrator Release 23.12 Documentation Acceptance Criteria

[kelaja]

Release Documentation 23.12

Source in Catena-X Confluence and Expert Contacts here (Source only accessible for Catena-X Consortia members in current transition phase).

• Source Code QG checks - Release 23.12 managed-service-orchestrator#84

  • Code is centrally managed in Eclipse Tractus-X repository.
  • All active and relevant Release Guidelines are fulfilled (with confirmation by DevSecOps SystemTeam).

  Artefact Repo:

  • Eclipse Tractus-X
  • FOSS Infopage(Source only accessible for Catena-X Consortia members in current transition phase)

  Best Practice

  • Consult the regular office hours as early as possible; expect optimization loops based on feedback.

  Contact:

  • DevSecOps System Team

• Architecture Documents

  • Arc42 documentation completed for relevant product version.
  • In MarkDown format. Link to document available. Must point to leading repository within Tractus-X. Process the JIRA ticket and schedule an appointment with Expert to obtain approval prior to Gate review.
  • Provide link to documentation as early as possible and mark changes to previous version (if applicable); expect optimization loops based on feedback.

  Artefact Repo:

  • GitHub Readme how-to (Source only accessible for Catena-X Consortia members in current transition phase)

  Contact:

  • SYSTEM ARCHITECT

• Administrator`s Guide (User assistance)

  • Admin Guide is available with the software at the same time
  • Admin Guide is correct and up to date; english is a must
  • The documentation is of appropriate maturity for any Operating Company with global business practice intentions.
  • In MarkDown format. Link to document available. Must point to leading repository within Tractus-X.

  Best Practice:

  • Process the issue and schedule an appointment with SYSTEM ARCHITECT to obtain approval prior to Gate review.
  • Provide link to documentation as early as possible and mark changes to previous version (if applicable); expect optimization loops based on feedback.
  • User assistance ensures that for example administrators get all the information they need to accomplish their tasks with the software. Refer to a administration guide, which covers "install/deploy, configure the software" – as appropriate for the type of software and the information needs of the target group(s)
  • UI text and embedded help complete the User assistance.

  Contact:

  • SYSTEM ARCHITECT

• End-User Manual (User assistance)

  • End-User Manual is available with the software at the same time
  • End-User Manual is correct and up to date; english is a must
  • The documentation is of appropriate maturity to be handed over from the CX Consortia to any Operations Company with global business practice intentions.

  Best Practice:

  • Process the issue and schedule an appointment with SYSTEM ARCHITECT to obtain approval prior to Gate review.
  • Provide link to documentation as early as possible and mark changes to previous version (if applicable); expect optimization loops based on feedback.
  • User assistance ensures that end users and others get all the information they need to accomplish their tasks with the software. Refer to a user guide, which covers "install/deploy, configure, and use the software" – as appropriate for the type of software and the information needs of the target group(s)
  • UI text and embedded help complete the User assistance.

  Contact:

  • SYSTEM ARCHITECT

• Interfaces Documentation

  • API documentation contains all relevant interfaces for integration testing and is completed for relevant product version.
  • Link to document available.
  • Interface contract signed by all involved parties.

  Best Practice:

  • Process the issue and schedule an appointment with SYSTEM ARCHITECT to obtain approval prior to Gate review.
  • Provide link to documentation as early as possible and mark changes to previous version (if applicable); expect optimization loops based on feedback.
  • see Open APIs

  Contact:

  • SYSTEM ARCHITECT

• UX consistency Style Guideline for User Interfaces

  • Mandatory for FrontEnd modules where the IP is Open Source or owned by Catena-X.
  • User Interfaces are in line with the Catena-X Style Guidelines
    • user interface style review has been executed (review owner: SYSTEM ARCHITECT5 UX)
    • review feedback (if existing) got incorporated
    • all findings are assessed
    • all findings (high/very high) are fixed or cleaned up (evidence by re-review)
    • approval of the application CX Style conformity is available (given by the review owner)

  Best Practice:

  • Obtain approval from Style Guideline Owner, prior to Gate review
  • use issue, include app URL & TestUser, assign to SYSTEM ARCHITECT5, expect review loop
  • Style Components
  • LINK to Style Guideline (Source only accessible for Catena-X Consortia members in current transition phase)
  • LINK to FrontEnd validations (will be added asap)
  • Please note, you can use the official public available CX shared component library (react supported) to easily develop applications that are in-line with the CX style guidelines

[MehranRoshandel]

@dvasunin please add all documents regarding TX document and version here and add the latest version once is committed by @SebastianBezold

[sharathshivprasad]

source code:
Latest release - https://github.com/eclipse-tractusx/managed-service-orchestrator/releases/tag/managed-service-orchestrator-1.5.1

Architecture Documents:
ARC 42 link - https://github.com/eclipse-tractusx/managed-service-orchestrator/blob/managed-service-orchestrator-1.5.1/docs/ARC42.md

Administrator`s Guide (User assistance):
Readme Link - https://github.com/eclipse-tractusx/managed-service-orchestrator/blob/managed-service-orchestrator-1.5.1/README.md
install.md link - https://github.com/eclipse-tractusx/managed-service-orchestrator/blob/managed-service-orchestrator-1.5.1/INSTALL.md

End-User Manual:
ARC 42 link - https://github.com/eclipse-tractusx/managed-service-orchestrator/blob/managed-service-orchestrator-1.5.1/docs/ARC42.md
Readme link - https://github.com/eclipse-tractusx/managed-service-orchestrator/blob/managed-service-orchestrator-1.5.1/README.md

Interfaces Documentation:
OpenAPI spec is available in the repository at - https://github.com/eclipse-tractusx/managed-service-orchestrator/blob/managed-service-orchestrator-1.5.1/docs/autosetup-api.yaml

UX consistency:
Not Applicable

@SebastianBezold
Please review and approve

[SebastianBezold]

source code: Latest release - https://github.com/eclipse-tractusx/managed-service-orchestrator/releases/tag/managed-service-orchestrator-1.5.1

Architecture Documents: ARC 42 link - https://github.com/eclipse-tractusx/managed-service-orchestrator/blob/managed-service-orchestrator-1.5.1/docs/ARC42.md

Administrator`s Guide (User assistance): Readme Link - https://github.com/eclipse-tractusx/managed-service-orchestrator/blob/managed-service-orchestrator-1.5.1/README.md install.md link - https://github.com/eclipse-tractusx/managed-service-orchestrator/blob/managed-service-orchestrator-1.5.1/INSTALL.md

End-User Manual: ARC 42 link - https://github.com/eclipse-tractusx/managed-service-orchestrator/blob/managed-service-orchestrator-1.5.1/docs/ARC42.md Readme link - https://github.com/eclipse-tractusx/managed-service-orchestrator/blob/managed-service-orchestrator-1.5.1/README.md

Interfaces Documentation: OpenAPI spec is available in the repository at - https://github.com/eclipse-tractusx/managed-service-orchestrator/blob/managed-service-orchestrator-1.5.1/docs/autosetup-api.yaml

UX consistency: Not Applicable

@SebastianBezold Please review and approve

Hi @sharathshivprasad,

I can only partly review things from this issue. One remark before I start. The tags you link are created by the Chart releaser. So there is no proper release tag yet. This also means, your Docker images with version 1.5.1 are missing. Could you please check if you actually did all the necessary steps for releasing?

[adkumar1]

Hi @SebastianBezold
I have raised a PR # eclipse-tractusx/managed-service-orchestrator#83
It consist of trivy security fix. If all good you can release a new version 1.5.1

[SebastianBezold]

Hi @adkumar1,
I merged the PR, created the Git tags and now the v1.5.1 Docker image tag is also available on DockerHub

There is also an open PR #81.
Could you check the contents again. At least the helm upgrade part is needed to comply with the release guidelines. I'm just not sure about the huge k8s secret manifest

[SebastianBezold]

System Team Release Guideline checks tracked in eclipse-tractusx/managed-service-orchestrator#84

[adkumar1]

Hi @SebastianBezold ,
helm upgrade part is added there in that PR. The secret part is included because earlier we were not able to deploy managed-service-orchestrator in other tools (like in argoCD). Hence we have included secret part with default values, so that we can deploy it anywhere. If someone want to change values then they can set in vault.

[SebastianBezold]

HI @adkumar1,

I merged the Helm Chart fix PR (eclipse-tractusx/managed-service-orchestrator#81) and created a fix release for the Chart.
So the current Chart Version is 1.5.2, deploying AppVersion 1.5.1. I updated the README accordingly and also introduces a CHANGELOG.md for your Chart. See [8cdee67]{eclipse-tractusx/managed-service-orchestrator@8cdee67)

The changes done in the mentioned PR now at least enable the workflow to execute the Helm tests, but it is still failing.
See workflow run logs

I created a new bug issue for that eclipse-tractusx/managed-service-orchestrator#87

Please fix the workflow run, so we can release a new patch version. You already had an exception for the last release. This time you need to get your test workflow to run successfully. This is a critical QA topic

[vialkoje]

managed service orchestrator == autosetup ??

[MehranRoshandel]

yes

[SebastianBezold]

managed service orchestrator == autosetup ??

I would really ask you to not use autosetup as name anymore. It has been renamed everywhere and only leads to confusion, if you still call it the old name.
If the renaming was a mistake, then we should consistently undo it

[SebastianBezold]

managed service orchestrator == autosetup ??

I would really ask you to not use autosetup as name anymore. It has been renamed everywhere and only leads to confusion, if you still call it the old name. If the renaming was a mistake, then we should consistently undo it

Oh now that I also had a look at the docs, I can see the whole renaming is very inconsistent.
There are multiple mentions of "autosetup". There is also an openAPI file named after autosetup.

@MehranRoshandel could you please ask the team to do the renaming consitently.
@vialkoje what do you think about that. Are there other references, that still talk about "autosetup"? Maybe even in other places as the product repo itself?

[MehranRoshandel]

Yes, I did it already in the internal communication. But Again. Please mention the new Name Managed Service Orchestrator, everywhere.

[SebastianBezold]

Hi @MehranRoshandel,

could you please ask your team to actively check for quality gate findings and fix them? They are all described as issues on your product repos. This is actually relevant for all of your repositories.
For managed-service-orchestrator there are three issues currently

[MehranRoshandel]

Actually, I do that the whole time. I am aware of the issues, and we are checking. But I have been back since yesterday. 😊 Dr. Ing. Mehran Roshandel T-Systems International GmbH PU Digital Solutions | Data Intelligence Hub Senior Product Manager Holzhauser Str. 4-8 D-13509 Berlin Tel. +49 1718672876 Email ***@***.******@***.***> Let‘s power higher performance [signature_791559559] <https://dih.telekom.com/en/> You can find the obligatory information on: www.t-systems.com/compulsory-statement<http://www.t-systems.com/compulsory-statement> Von: Sebastian Bezold ***@***.***> Gesendet: Dienstag, 21. November 2023 10:20 An: eclipse-tractusx/sig-release ***@***.***> Cc: Roshandel, Mehran ***@***.***>; Mention ***@***.***> Betreff: Re: [eclipse-tractusx/sig-release] Managed Service Orchestrator Release 23.12 Documentation Acceptance Criteria (Issue #82) Hi @MehranRoshandel<https://github.com/MehranRoshandel>, could you please ask your team to actively check for quality gate findings and fix them? They are all described as issues on your product repos. This is actually relevant for all of your repositories. For managed-service-orchestrator there are three issues currently — Reply to this email directly, view it on GitHub<#82 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AYFU5HAXT4GSP6IXIUES6QTYFRW4FAVCNFSM6AAAAAA5VHWXPCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMRQGUZDOMJQGA>. You are receiving this because you were mentioned.Message ID: ***@***.******@***.***>>

[kelaja]

no UX n/a

[SebastianBezold]

Release guildelines checked. App Release done: https://github.com/eclipse-tractusx/managed-service-orchestrator/releases/tag/v1.5.2

AppVersion 1.5.2
Chart version 1.5.3

[vialkoje]

expert approval granted for Architetcure-,Admin, user and interface doku