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는 그대로 씁니다. 소유권은 넘어오지 않으며, 얻는 것은 두 개의 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 두 개는 병합되지 않고 이름이 변경되며, 어느 것이 변경되었는지는 가져오기 결과가 알려줍니다.

Components

Component는 이를 소유한 System 아래의 컨테이너가 되며, 소유 관계는 spec.system 또는 partOf 관계에서 해석됩니다. spec.type도 매핑되어 service는 서비스로, website는 웹 앱으로, 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를 하나의 JSON 배열로 반환합니다.

FileCode

Backstage 형식 선택

Archyl의 가져오기 대화 상자에서 "Backstage" 탭을 선택하세요. Backstage가 내보낸 entities 배열을 가공 없이 그대로 받습니다.

entities.json 업로드 또는 붙여넣기

파일을 업로드하거나 내용을 붙여넣은 뒤 검증하세요. 가져오기를 확정하기 전에 Archyl이 JSON의 오류를 알려줍니다.

가져온 뒤 경고를 확인하기

Archyl이 모델을 구성하고, 생성한 시스템, 컨테이너, API 계약, 관계의 개수와 이름을 변경해야 했던 모든 엔티티를 보고합니다. 소유자는 나중에 지정하세요. Backstage의 Group과 User는 가져오지 않습니다.

CircleCheckBig

Activity

드리프트 감지

문서가 실제 코드베이스를 얼마나 정확하게 반영하는지 보여주는 0-100% 건강 점수를 받으세요. 드리프트가 누적되기 전에 감지합니다.

규정 준수 규칙

아키텍처 규칙을 정의하고 자동 검사를 실행하여 시스템이 정의된 가드레일 내에 있도록 보장합니다.