003 - 플러그인 설치하기
이제 동작하는 Backstage 앱이 있으니, Backstage 생태계에서 가장 가치 있는 부분인 플러그인을 살펴볼게요! 이 글에서는 Backstage 플러그인이 무엇인지, 그리고 설치 방법을 설명드릴게요.
출처: 문서
본문
이제 동작하는 Backstage 앱이 있으니, Backstage 생태계에서 가장 가치 있는 부분인 플러그인을 살펴볼게요!
Backstage 플러그인이란 무엇인가요?
Backstage 플러그인은 보통 프론트엔드와 백엔드 기능으로 구성돼요. Backstage 플러그인의 예로는 소프트웨어 카탈로그, 검색, 소프트웨어 템플릿 플러그인이 있어요! 각 플러그인은 잘 격리된 일련의 집중된 기능을 제공해요. 예를 들어 소프트웨어 카탈로그는 엔티티 수집 엔진, 엔티티 정보를 가져오기 위한 최적화된 쿼리 계층, 엔티티 목록과 상세 기능을 제공하는 일련의 UI 요소를 포함해요. 일부 플러그인은 기존 플러그인 수준 기능을 보완하고 특정 사용 사례에 맞게 커스터마이징하는 모듈을 허용해요. 좋은 예는 공통 소스에서 카탈로그로 데이터를 수집할 수 있게 해주는 카탈로그 프로세서 모듈이에요.
Backstage 플러그인 명명
backstage-cli new 명령은 예상되는 명명 규칙으로 플러그인을 자동으로 스캐폴드해요. 아래에서는 외부 플러그인을 설치하는 사용자를 위해 명명 규칙을 설명해요.
일반적으로 여러 패키지가 합쳐져 단일 "플러그인"이 돼요. 공통 명명 표준(ADR-11에 상세히 설명)은 플러그인 x에 대해 아래와 같이 보여줘요:
x: 주요 프론트엔드 진입점으로, 플러그인의 프론트엔드 전용 코드를 포함해요.
x-backend: 주요 백엔드 진입점으로, 백엔드 전용 코드를 포함해요.
x-backend-module-y: 플러그인 x를 위한 선택적 백엔드 모듈 y로, 백엔드 전용 코드를 포함해요.
x-node: 백엔드 플러그인 x의 소비자를 위한 공유 유틸리티로, 프론트엔드에서는 사용하면 안 돼요.
x-react: 프론트엔드 플러그인 x의 소비자를 위한 공유 유틸리티로, 백엔드에서는 사용하면 안 돼요.
x-common: 플러그인 x의 소비자를 위한 공유 유틸리티로, 백엔드와 프론트엔드에서 사용할 수 있어요.
모든 플러그인이 이 모든 패키지를 필요로 하지는 않아요. x와 x-backend 패키지만으로 시작해서 거기서부터 확장하는 것을 권장해요.
플러그인을 어떻게 설치하나요?
위에서 언급했듯이 플러그인 설치에는 프론트엔드와 백엔드 두 부분이 있어요. 프론트엔드에서 이상한 오류가 발생하지 않도록 백엔드 플러그인 설치부터 시작하는 것을 권장해요.
두 경우 모두 플러그인의 설치 문서를 찾아야 해요. 대부분의 플러그인에서 이것은 해당 플러그인의 README.md 파일에서 확인할 수 있어요. 예를 들어 소프트웨어 카탈로그 플러그인의 설치 지침은 백엔드 플러그인 README와 프론트엔드 플러그인 README에서 확인할 수 있어요.
백엔드 플러그인 설치하기
일반적으로 백엔드 플러그인 설치는 정말 간단해요. packages/backend/src/index.ts 파일의 다른 항목들 옆에 다음을 추가하기만 하면 돼요:
backend.import(`@scope/package`);
파일을 저장하면 핫 리로드가 트리거되고, 그렇게 하면 새 플러그인을 바로 사용할 수 있게 돼요. 고급 사례에서는 플러그인에 대해 설정해야 하는 필수 구성이 있을 수 있어요. 그 구성은 플러그인의 README에 문서화되어 있을 거예요(또는 있어야 해요).
찾고 있는 추가 기능을 플러그인에서 제공하기 위해 백엔드 모듈을 추가해야 할 수도 있어요. 백엔드 모듈은 맞춤 기능을 제공할 수 있는 백엔드 코드의 추가 확장이에요. 좋은 예는 GitHub, LDAP, AWS 소프트웨어 엔티티 지원을 추가하는 카탈로그 프로세서 모듈이에요. 모듈은 백엔드 플러그인과 정확히 같은 방식으로 설치돼요. 모듈을 설치하려면 추가 구성이 필요할 수도 있고, 이것도 플러그인의 README에 문서화되어 있어야 해요.
프론트엔드 플러그인 설치하기
프론트엔드 플러그인은 여러 진입점을 가지므로, 설치 방법은 플러그인의 문서를 따라야 해요.
새 프론트엔드 시스템이 이것을 크게 단순화해요! 업데이트를 눈여겨보세요.
플러그인 찾기
오픈소스 커뮤니티에는 이미 많은 일반적인 요구를 해결하는 플러그인이 있어요. 직접 만들기 전에 플러그인 디렉터리를 먼저 살펴보는 것을 권장해요!
커뮤니티에서 유지보수하는 다른 플러그인은 커뮤니티 플러그인 저장소에서 찾을 수 있어요!
다음 단계
직접 플러그인을 작성하고 싶어 안달이 났다면 plugins 골든 패스로 이동할 수 있어요. Backstage 앱을 장기적으로 유지보수하는 방법에 대한 더 많은 정보를 얻기 위해, 이 골든 패스로 돌아와 완료하도록 메모해 두는 것을 권장해요.
나머지 분들은 Backstage 앱을 최신 상태로 유지하는 방법을 살펴볼게요!