Backstage Local 셋팅 및 설치방법

개발을 위해 먼저 Local을 셋팅하는방법을 가이드하려고합니다.. 먼저 backstage를 구동하기위해서는 사전 준비 사항이 필요합니다.

• Linux, macOS 또는 같은 유닉스 기반 운영 체제에 대한 액세스 Linux용 Windows 하위 시스템
• NodeJs 20버전 이상
• yarn 4.4.1 (권장)

저는 window WSL에서 설치하여 구동하였습니다.

 

1. Backstage App 만들기

Backstage Standalone App을 실행할려면 npx를 사용해야합니다. npx는 nodejs가 설치되어있으면 미리 설치되어있기때문에 해당 명령어를 실행하여 설치를 진행합니다.

# backstage latest app 생성
$ npx @backstage/create-app@latest
? Enter a name for the app [required] (backstage)

 

실행 처음에 해당 App에 Name을 입력하는 곳이나온다 그냥 Enter을 입력하면 backstage라는 이름으로 만들어지는 폴더가 생성이 된다. 저는 Enter를 그냥 누르고 진행했습니다. Enter를 누르면 아래와 같은 그림이 뜹니다.

yarn install을 통해 dependices를 가져오로 자동적으로 app이 생성이 됩니다. 

app 폴더에는 backstage를 구성하는 파일들이있습니다.

app
├── app-config.yaml
├── catalog-info.yaml
├── package.json
└── packages
    ├── app
    └── backend

• app-config.yaml :앱의 주요 설정 파일로, Backstage의 전반적인 설정을 정의합니다.
  • 더 자세한 설정 방법은 Configuration 가이드를 참고하세요.
• catalog-info.yaml : 소프트웨어 카탈로그 엔티티를 정의하는 파일입니다.
  • 이 파일을 활용하면 Backstage에서 관리할 서비스나 시스템을 등록할 수 있습니다.
  • 엔티티를 어떻게 정의하는지 알고 싶다면 Descriptor Format 문서를 확인하세요.
• package.json :  Backstage 프로젝트의 최상위 package.json 파일입니다.
  • 여기에서 npm 패키지를 직접 추가하면 안 됩니다.
  • 모든 패키지는 적절한 워크스페이스(예: packages/app/ 또는 packages/backend/)에 설치해야 합니다.
• packages/ : Backstage는 Lerna 기반의 모노레포 구조를 사용하며, 이 폴더 아래에서 개별 패키지(모듈)를 관리합니다.
• packages/app/ : Backstage의 프론트엔드 애플리케이션이 위치한 폴더입니다.
  • Backstage의 UI를 커스터마이징하거나 새로운 기능을 추가하려면 이 폴더에서 작업하면 됩니다.
• packages/backend/ : Backstage의 백엔드 애플리케이션이 포함된 폴더입니다.
  • 인증(Authentication), 소프트웨어 카탈로그(Software Catalog), 소프트웨어 템플릿(Software Templates), TechDocs 등을 관리합니다.
  • 새로운 플러그인을 추가하거나 API를 확장하려면 이 폴더에서 작업해야 합니다.

이와 같이 해당 폴더로 Backstage기능들을 추가하고 커스텀해볼수 있다.. 해당 부분은 차후에 글을 쓰도록 하겠다.

Backstage App 실행해보기

Backstage App이 설치가 완료되면 yarn dev를 해보자

$ yarn dev

 

localhost:3000으로 Guest로 들어갈수있는 페이지가 뜬다..

 

Enter를 입력후에 들어가보면..

Example App과 Backstage관련부분들이 뜬다.

 

 

3 . 정리 

local설치는 정말 쉽다..

설치나 연동등도 사실 공식홈에 document에 정말 친절하게 잘 되어있는거 같습니다..