Backstage 소프트웨어 템플릿
Backstage의 소프트웨어 템플릿(Software Templates) 부분은 Backstage 안에서 Components를 만드는 데 도움을 주는 도구입니다.
출처: 문서
본문
Backstage의 소프트웨어 템플릿 부분은 Backstage 안에서 Components를 만드는 데 도움을 주는 도구입니다. 기본적으로 코드의 스켈레톤을 로드하고, 일부 변수를 템플릿화한 다음, 템플릿을 GitHub나 GitLab 같은 위치로 게시할 수 있는 능력이 있습니다.
중요
커스텀 스캐폴더 액션을 만들 때는 액션 ID에 kebab-case 대신 camelCase를 사용하세요. 대시가 있는 액션 ID(예:
fetch-component-id)는 JavaScript 표현식에서 대시가 빼기 연산자로 평가되기 때문에${{ steps.fetch-component-id.output.componentId }}같은 템플릿 표현식이NaN을 반환하게 됩니다. 자세한 내용은 Writing Custom Actions 가이드를 참조하세요.
사전 요구 사항
이 문서들은 이미 Backstage Getting Started 섹션을 살펴봤고 Backstage를 로컬에서 실행할 수 있거나 어딘가에 배포했다고 가정합니다.
시작하기
Backstage에 가져온 소프트웨어 템플릿은 /create 아래에서 찾을 수 있습니다.
Backstage를 로컬에서 실행 중이라면 이것은 http://localhost:3000/create가 됩니다.
거기에 가면 다음과 비슷한 것을 보게 될 것입니다.
템플릿 선택
만들고 싶은 템플릿을 선택하면 다음 페이지로 이동하며, 페이지는 템플릿마다 다르게 보일 수도 있고 아닐 수도 있습니다. 각 템플릿은 서로 다른 입력 변수를 요구할 수 있고, 그것들은 내부적으로 템플릿러(templater)에 전달됩니다.
템플릿은 일반적으로 일련의 단계로 구성되며, 각 단계는 아래 이미지에서 볼 수 있듯 필요한 입력 또는 선택 입력의 자체 집합을 가질 수 있습니다. 우리는 이제 GitHub 저장소 정보를 입력하라는 프롬프트를 받고 있습니다.
검토 페이지
템플릿을 실행하기 전에 요약 페이지로 이동합니다. 템플릿을 실행하기 전에 제공한 입력을 확인할 수 있는 곳입니다.
올바른 정보를 제공했는지 다시 한번 확인하기 좋은 때이며, 필요하다면 돌아가서 입력 중 어떤 것이든 변경할 수 있게 해 줍니다.
템플릿 실행
제공한 입력이 마음에 들면 Create 버튼을 클릭해 템플릿을 실행할 수 있습니다.
성공
템플릿 실행이 끝나면 성공 페이지로 이동해 템플릿의 결과를 볼 수 있습니다.
실패
실패하면 각 섹션을 클릭해 실패한 단계의 로그를 얻을 수 있으며, 디버깅에 도움이 될 수 있습니다.
실행 중인 프로세스를 취소할 수도 있습니다. "Cancel" 버튼을 클릭하면 중단 신호(abort signal)가 작업에 보내지고 다음 단계는 모두 실행되지 않습니다. 현재 단계는 그것을 지원하는 경우에만 취소됩니다.
결과 보기
템플릿 실행이 끝나면, 그리고 위 스크린샷에서 알 수 있듯 성공하면 두 개의 링크가 제시되며, 클릭하면 우리가 만든 템플릿된 저장소로 이동합니다!
Register Existing Component 버튼 비활성화
사용자에게 Register Existing Component 버튼을 비활성화하고 싶은 상황이 있을 수 있습니다.
그렇게 하려면 app-config.yaml에서 라우트 바인딩을 비활성화할 수 있습니다.
app-config.yaml
app: routes: bindings: scaffolder.registerComponent: false
변경 후에는 더 이상 버튼이 보이지 않아야 합니다.
템플릿 작업 목록
템플릿의 각 실행은 고유한 ID로 식별되는 고유한 작업(task)으로 취급됩니다. 이전에 실행된 템플릿 작업의 목록을 보려면 "Create" 페이지로 이동해 오른쪽 상단의 컨텍스트 메뉴(세로 줄임표, 즉 'kebab menu' 아이콘이 나타냄)에서 "Task List"에 접근하세요.
처음부터 다시 시작 (Starting Over)
이전에 실행된 템플릿을 다시 실행하려면 템플릿 작업 페이지로 이동하세요. 원하는 작업을 찾아 컨텍스트 메뉴에서 "Start Over" 옵션을 선택하세요.
이 작업은 선택한 템플릿의 새 실행을 시작하며, 이전 실행과 같은 매개변수로 미리 채워지지만, 재실행 전에 그 매개변수들을 편집할 수 있습니다.
템플릿 실행이 실패한 경우 "Start Over" 옵션을 사용해 템플릿을 다시 실행할 수 있습니다. 원래 실행의 매개변수가 미리 채워지지만, 템플릿을 재시도하기 전에 필요에 따라 조정할 수 있습니다.
실제로 보고 싶나요?
Backstage 데모 사이트에는 여러분이 실행할 수 있는 템플릿이 있는데, 이 문서의 스크린샷이 바로 거기에서 찍혔습니다!