CDKサンプルにて作成されるインフラについてシステム構成図を自動生成してほしい

[koichimurakami]

MBC CQRS サーバーレス フレームワークで作成するインフラは作成するリソース数が多いため全体像を把握することが困難です。
もし可能であればCDKにて作成するリソースをシステム構成図として自動作成してもらえないでしょうか？

[baquan1708]

@koichimurakami

After research, I found 2 libraries that support genreating the infrastructure diagram from CDK: cdk-dia and pdk (pdk is inspired by cdk-dia). I've prepared two versions of it. Which diagram version should I use?

1)This diagram is genreated by [cdk-dia]. 2)This diagram is genreated by [pdk].

[koichimurakami]

@baquan1708 @Tuan-Anh-Nguyen-pionero
Managing changes using Git
Is the pipeline in an infinite loop?
Or are we worried that the deployment will fail?
I would like to avoid changing to Git if there are no changes to the API or infrastructure.
Is that possible?

[baquan1708]

@koichimurakami cc: @Tuan-Anh-Nguyen-pionero
Actually, What I meant is that the infrastructure diagram and API definition are generated locally on the developer’s computer. These changes are then committed to Git, which triggers the CodePipeline. This way, the pipeline only starts after developers intentionally push their updates to Git.

This way, there is not an infinite loop. The API Swagger file and infrastructure diagram are generated only when the local process is successful.

[koichimurakami]

@baquan1708 cc: @Tuan-Anh-Nguyen-pionero
Developers must be conscious of generating documents, and there is a possibility of making mistakes.

Some people do not update documents manually, and there may be cases where documents cannot be generated depending on the development environment such as Windows, Mac, or Linux.

That's why I want automatic generation logic.
I think it's good to commit to Git manually and do it within the development flow, but I think it would be even better if the framework had automatic generation logic.

You can download it from artifacts and commit it to Git.

[baquan1708]

@koichimurakami cc: @Tuan-Anh-Nguyen-pionero
Thank you very much for your detailed response. I now fully understand the issue, and I will proceed with implementing the automatic generation logic as discussed. The infrastructure diagram and API documentation will be auto generated and they will be uploaded to artifact.

[baquan1708]

@koichimurakami cc: @Tuan-Anh-Nguyen-pionero
I've created the PR #61. This PR auto generate diagram and store it in artifact. Could you please take a look?

I will proceed with implementing the API documentation generation in the pipeline.

[koichimurakami]

Release Info in Japanese: https://www.mbc-net.com/update-mbc-cqrs-%e3%82%b5%e3%83%bc%e3%83%90%e3%83%bc%e3%83%ac%e3%82%b9-%e3%83%95%e3%83%ac%e3%83%bc%e3%83%a0%e3%83%af%e3%83%bc%e3%82%af-ver-0-1-32-beta-cdk%e3%81%a7%e3%83%87%e3%83%97%e3%83%ad/