[backstage][catalog] overview

what is Catalog?

중앙화된 시스템으로, 생태계에 있는 모든 소프트웨어(서비스, 웹사이트, 라이브러리, 데이터파이프라인 등)의 소유권과 메타데이터를 추적 및 관리합니다.

카탈로그는 코드와 함께 저장되는 메타데이터 YAML파일이라는 개념을 중심으로 구축되며 이 파일들은 수집되어 backstage에서 시각화됩니다.

핵심 개념 요약

• 중앙화된 관리 - 흩어진 소프트웨어 정보를 한곳에서 관리
• 소유권 추적 - 각 소프트웨어가 누구의 것인지 명확히 파악
• yaml 파일 - 코드 저장소에 함꼐 보관되는 메타데이터 정의파일
• 자동 수집 및 시각화 - yaml 파일을 읽어 backstage UI에서 보여줌

Getting Started

/catalog로 들어가면 볼 수 있거나 공식문서따라 했다면 http://localhost:3000 에서 확인할 수 있다.

Adding components to the catalog

소프트웨어 카탈로그의 원천은 소스컨트롤에 저장된 메타데이터 YAML파일이다.
저장소에는 하나 또는 여러개의 메타데이터 파일이 포함될 수 있으며, 보통 저장소 루트에 위치하지만 어디에 두어도 상관없다.

컴포넌트를 추가하는 방법은 3가지 방법이 있다.
1. 수동으로 컴포넌트 등록

• /create 페이지에서 REGISTERING COMPONENT 버튼 클릭
• 소스 컨트롤에 있는 YAML 파일의 전체 URL 입력
• 자사가 관리하지 않는 소프트웨어도 등록 가능

2. backstage를 통해 새 컴포넌트 등록

• Backstage Software Templates으로 만든 소프트웨어는 카탈로그에 자동 등록

• catalog.yaml 설정 파일에 URL을 직접 명시해서 등록 가능

핵심요약

backstage는 여러 인프라 도구를 하나의 개발자 포털로 통합하여, 팀이 여러 UI를 왔다갔다 인지적 부담을 줄여주는것이 핵심 목적이다.