컴포넌트 만들기
소프트웨어 카탈로그에서는 소프트웨어 템플릿을 사용해서 컴포넌트를 만들 수 있어요. 템플릿은 변수를 포함할 수 있는 코드 골격을 불러오고, 회사의 모범 사례를 반영해요. 이 글에서는 기본 제공되는 예시 템플릿을 이용해 새 컴포넌트를 만들어 카탈로그에 등록하는 방법을 설명드릴게요.
출처: 문서
본문
대상 독자: 개발자
개요
컴포넌트는 소프트웨어 템플릿을 사용해서 소프트웨어 카탈로그에서 만들 수 있어요. 템플릿은 변수를 포함할 수 있는 코드 골격을 불러오고, 회사의 모범 사례를 통합해요. 템플릿은 GitHub나 GitLab 같은 위치에 게시돼요.
독립 실행형(standalone) Backstage 애플리케이션은 간단한 Node.js 서비스를 만들고 등록하는 스캐폴더용 예시 템플릿인 Example Node.js Template을 포함해요. 직접 템플릿을 만들 수도 있어요.
사전 준비 사항
이 예시에서는 기본 Node.js 템플릿을 사용할게요. 이 템플릿은 GitHub에 저장소를 만들고, 컴포넌트가 소프트웨어 카탈로그에 통합되도록 필요한 파일을 추가해요. 저장소를 만들기 때문에 먼저 Backstage와 GitHub 간의 통합을 만들어야 해요.
독립 실행형 앱을 이미 설치했어야 해요.
GitHub Scaffolder Action 모듈을 등록해요.
GitHub Personal Access Token을 사용해서 Backstage와 GitHub 통합을 설정해요.
컴포넌트 만들기
컴포넌트를 만들려면:
Create를 선택해요.
CATEGORIES 드롭다운 목록에서 Service를 선택해요.
Owner를 선택해요. 이 예시에서는 guest를 선택할 수 있어요.
Example Node.js Template에서 Choose를 선택해요.
이 예시에서는 서비스의 Name으로 tutorial을 입력하고 NEXT를 선택해요.
Owner로 GitHub 사용자 이름을 입력해요.
Repository에 tutorial을 입력하고 REVIEW를 선택해요.
정보를 검토하고 CREATE를 선택해요.
진행 상황을 따라갈 수 있으며, 모든 단계가 끝나면 새 서비스를 저장소나 카탈로그 중 원하는 곳에서 확인할 수 있어요.
REPOSITORY를 선택하면 tutorial 저장소의 메인 브랜치에 새 컴포넌트를 위해 만들어진 catalog-info.yaml 파일과 기타 프로젝트 설정 파일이 표시돼요.
catalog-info.yaml 파일은 소프트웨어 카탈로그용 엔티티를 설명해요. 카탈로그 엔티티의 디스크립터 형식에서 추가 정보를 확인할 수 있어요.
apiVersion: backstage.io/v1alpha1kind: Componentmetadata: name: 'tutorial'spec: type: service owner: user:guest lifecycle: experimental
OPEN IN CATALOG를 선택하면 관계, 링크, 하위 컴포넌트 같은 새 컴포넌트의 세부 정보가 표시돼요.
사이드바에서 Home을 선택하면 카탈로그에 새 tutorial 컴포넌트가 표시돼요.