본문 바로가기
WIKI 기술 지식 베이스

카탈로그 보기

원문 보기 위키 갱신

독립 실행형 Backstage 앱에 로그인하면 사이드바에서 Home이 선택되어 있고, 메인 패널에 카탈로그가 표시돼요. 이 글에서는 카탈로그에 표시되는 엔티티 유형과 각 엔티티에 제공되는 정보 및 작업에 대해 설명드릴게요.

출처: 문서

본문

대상 독자: 전체

개요

처음 독립 실행형 Backstage 앱에 로그인하면 사이드바에서 Home이 선택되어 있고, 메인 패널에 카탈로그가 표시돼요.

익숙해져야 할 네 가지 주요 엔티티가 있어요:

  • Components - 소스 제어에서 추적할 수 있고, 다른 컴포넌트가 사용할 API를 구현할 수 있는 개별 소프트웨어 조각.

  • Resources - 컴포넌트를 운영하는 데 필요한 물리적 또는 가상 인프라.

  • Systems - 하나 이상의 공개 API를 노출해서 기능을 수행하기 위해 협력하는 리소스와 컴포넌트의 집합. 소비자로부터 컴포넌트 간의 리소스와 비공개 API를 숨겨줘요.

  • Domains - 용어, 도메인 모델, 메트릭, KPI, 비즈니스 목적 또는 문서를 공유하는 시스템의 집합.

기술 개요에서 카탈로그에 표시되는 모든 유형의 엔티티에 대한 설명을 확인할 수 있어요.

참고로, 조직에서 기존 엔티티 유형 중 하나에 맞지 않는 것을 모델링해야 한다면 직접 새로운 종류의 엔티티를 만들 수도 있어요.

처음에 카탈로그는 다음 필터 설정과 일치하는 등록된 엔티티를 표시해요:

  • Kind - Component

  • Type - all

  • Owner - Owned

  • Lifecycle - 카탈로그에 있는 엔티티의 생애주기 값 목록

  • Processing Status - normal

  • Namespace - 엔티티가 속한 네임스페이스의 ID

Owner 및 Kind 필터의 초기 설정을 변경할 수 있어요.

각 엔티티의 정보 열

각 엔티티 종류마다 엔티티에 대한 정보를 표시하는 열 집합이 있어요. 예를 들어 Component의 기본 정보 집합은 다음과 같아요:

  • Name - 컴포넌트 이름

  • System - 컴포넌트가 속한 시스템을 참조하는 선택 필드

  • Owner - 컴포넌트의 소유자

  • Type - 일반적인 유형은 다음과 같지만, 조직의 필요에 맞는 새 유형을 만들 수도 있어요

  • service - 일반적으로 API를 노출하는 백엔드 서비스

  • website - 웹사이트

  • library - npm 모듈이나 Java 라이브러리 같은 소프트웨어 라이브러리

  • Lifecycle

  • experimental - 실험이나 초기 단계의 비프로덕션 컴포넌트로, 사용자가 다른 더 확립된 컴포넌트보다 이를 사용하지 않는 편이 나을 수 있거나, 신뢰성 보장이 없거나 낮음을 나타내요

  • production - 확립되고 소유되며 유지보수되는 컴포넌트

  • deprecated - 생애주기 끝에 도달했으며, 나중에 사라질 수 있는 컴포넌트

  • Description - 컴포넌트를 설명하는 선택 필드

  • Tags - 검색에 사용할 수 있는 선택 필드

  • Actions - 카탈로그 작업(Catalog Actions) 참고

열, 작업, 테이블 옵션 커스터마이징 안내에 따라 각 엔티티 종류와 연결된 열을 수정할 수 있어요.

카탈로그 작업

각 엔티티에는 사용 가능한 작업 집합이 있어요.

왼쪽부터 오른쪽으로 작업은 다음과 같아요:

  • View - 엔티티를 정의하는 catalog-info.yaml 파일을 봐요.

  • Edit - 엔티티를 정의하는 catalog-info.yaml 파일을 편집해요. 컴포넌트 업데이트하기 참고

  • Star - 엔티티를 즐겨찾기로 지정해요. 즐겨찾기한 엔티티로 카탈로그를 필터링할 수 있어요.

열, 작업, 테이블 옵션 커스터마이징은 표시되는 작업을 수정하는 방법을 설명해요.

엔티티 세부 정보 보기

메인 패널에서 엔티티를 선택하면 엔티티의 세부 정보가 표시돼요. 표시되는 세부 정보 유형은 엔티티 유형에 따라 달라져요. 예를 들어 example-website 같은 Component를 선택하면 다음 세부 정보가 표시돼요:

  • About - 설명, 소유자, 태그, 도메인 같은 엔티티 메타데이터

  • Relations - 엔티티 관계 보기 참고

  • Links - 엔티티와 연결된 링크

  • Has subcomponents - 컴포넌트가 속한 다른 컴포넌트에 대한 엔티티 참조

examples 같은 System을 선택하면 Component와 비슷하게 About, Relations, Links가 표시되지만, Has components, APIs, Has Resources도 함께 포함돼요.

더 알아보기 (Learn more)