BackstageカタログをArchylにインポート: BackstageからC4へ

Backstage Software CatalogをたどれるC4モデルに変換。System、Component、Resource、インラインAPI specをentities.jsonからインポート。オーナーシップはBackstageに残ります。

backstage

Backstage

Backstage インポート

Backstage カタログを Archyl にインポート

Backstage は稼働しているものを一覧にします。Archyl は同じカタログをたどれる C4 モデルに変えます。System はシステムに、Component と Resource はコンテナになり、API エンティティはコントラクトになって、その spec はそのまま保持され、提供側と利用側のサービスにリンクされます。Backstage はそのまま使い続けられます。オーナーシップは引き継がれず、得られるのは 2 つの C4 レベルです。

Backstage カタログを Archyl にインポート | Backstage から C4 へ

Backstage Software Catalog をたどれる C4 アーキテクチャモデルに変換。System、Component、Resource、インライン API spec を entities.json からインポート。オーナーシップは Backstage に残ります。

Backstage から C4, Backstage カタログインポート, Backstage カタログエクスポート, Backstage アーキテクチャ図, Backstage software catalog C4 モデル, Backstage アーキテクチャドキュメント

Systems

すべての System エンティティが、説明とタグを保ったまま C4 のソフトウェアシステムになります。namespace をまたいで同名の System が 2 つある場合はマージではなくリネームされ、どれがリネームされたかはインポート結果で通知されます。

Components

Component は、それを所有する System の配下のコンテナになります。所有関係は spec.system または partOf リレーションから解決されます。spec.type もマッピングされ、service はサービス、website は Web アプリ、cronworkflow はワーカー、library はライブラリになります。

Database

Resources

Resource もコンテナになり、型は spec.type から決まります。RDS インスタンスと Valkey クラスタはデータベースに、Kafka トピックと SQS キューはメッセージキューに、S3 バケットはファイルストレージになります。

FileText

API spec

API エンティティは Archyl の API コントラクトになります。インラインの spec.definition はそのまま保持され、HTTP、gRPC、GraphQL、async のいずれかに分類され、提供側と利用側のコンテナにリンクされます。

ArrowLeftRight

Relations

dependsOn、consumesApi、producesTo、consumesFrom、versionedIn は型付きのリレーションになります。Backstage はほとんどの relations を双方向に出力しますが、インポートはそのうち片方のみを保持します。consumesApi のエッジは API を経由して、実際にそれを提供しているコンテナまで解決されます。

Namespace と lifecycle

metadata.tags はそのまま引き継がれ、namespace、lifecycle、type もプレフィックス付きのタグとして加わります。Backstage で整えたグルーピングがアーキテクチャモデルでも残ります。

カタログをエクスポート

Backstage の catalog API を呼び出し、レスポンスを保存してください。entities エンドポイントは、把握しているすべての System、Component、Resource、API を 1 つの JSON 配列として返します。

FileCode

Backstage フォーマットを選択

Archyl のインポートダイアログで "Backstage" タブを選択してください。Backstage が出力した entities 配列を、加工なしでそのまま受け付けます。

entities.json をアップロードまたは貼り付け

ファイルをアップロードするか内容を貼り付けて、検証してください。インポートを確定する前に、Archyl が JSON のエラーを報告します。

インポートして、警告を読む

Archyl がモデルを構築し、作成したシステム、コンテナ、API コントラクト、リレーションの数と、リネームせざるを得なかったエンティティをすべて報告します。オーナーはインポート後に割り当ててください。Backstage の Group と User はインポートされません。

CircleCheckBig

Activity

ドキュメントが実際のコードベースをどれだけ正確に反映しているかを示す 0-100% のヘルススコアを取得。ドリフトが蓄積する前に検出します。

コンフォーマンスルール

アーキテクチャルールを定義し、自動チェックを実行して、システムが定義されたガードレール内に収まることを確保します。

ChartColumn

DORA メトリクス

デプロイ頻度、リードタイム、変更失敗率、復旧時間をアーキテクチャの健全性と合わせて追跡します。