컴포넌트 등록하기
이 가이드는 다른 위치에서 Backstage 데이터를 수동으로 가져오는 방법을 안내해요. 이를 자동으로 처리해 주는 통합도 존재해요. 이 글에서는 소프트웨어 카탈로그에 컴포넌트를 수동으로 등록하는 방법을 설명드릴게요.
출처: 문서
본문
대상 독자: 개발자
엔티티 파일은 YAML 형식으로 저장돼요. YAML에 익숙하지 않다면 여기에서 더 배울 수 있어요. 카탈로그 엔티티의 디스크립터 형식에서 YAML 엔티티 파일 형식에 대한 추가 정보를 확인할 수 있어요.
개요
이 가이드는 다른 위치에서 Backstage 데이터를 수동으로 가져오는 방법을 안내해요. 이를 자동으로 처리해 주는 통합도 존재해요.
컴포넌트를 등록할 때 다음을 수행할 수 있어요:
기존 엔티티 파일에 연결: 파일을 분석해서 어떤 엔티티가 정의되어 있는지 확인하고, 해당 엔티티를 스캐폴드된 Backstage 앱 카탈로그에 추가해요. 예를 들어 https://github.com/backstage/backstage/blob/master/catalog-info.yaml.
저장소에 연결: 저장소에 있는 모든 catalog-info.yaml 파일을 발견하고, 정의된 엔티티를 스캐폴드된 Backstage 앱 카탈로그에 추가해요. 예를 들어 https://github.com/backstage/backstage.
엔티티가 발견되지 않으면 저장소에 예시 catalog-info.yaml 파일을 추가하는 Pull Request가 생성돼요. Pull Request가 병합되면 스캐폴드된 Backstage 앱 카탈로그가 정의된 모든 엔티티를 불러와요.
사전 준비 사항
- 독립 실행형 앱을 이미 설치했어야 해요.
컴포넌트 등록하기
소프트웨어 카탈로그에 컴포넌트를 수동으로 등록하려면:
Create를 선택해요.
REGISTER EXISTING COMPONENT를 선택해요.
템플릿을 작성해요.
독립 실행형 Backstage 애플리케이션에는 템플릿 하나가 포함되어 있어요. 이 예시에서는 엔티티 파일의 저장소 URL인 https://github.com/backstage/backstage/blob/master/catalog-info.yaml을 입력해요. 이 URL은 Backstage 데모 사이트 카탈로그에서 사용돼요.
ANALYZE를 선택해요.
ANALYZE의 변경 사항이 올바르다면 IMPORT를 선택해요.
엔티티가 성공적으로 가져와졌다면 세부 정보가 표시돼요.
Home을 선택해서 소프트웨어 카탈로그에서 새 엔티티를 확인해요.