본문 바로가기
WIKI 기술 지식 베이스

연결

원문 보기 위키 갱신

연결 (실험적)

연결(connection)은 Backstage 백엔드가 외부 시스템에 도달하는 방식과 사용할 수 있는 인증 자료를 설명해요.

출처: 문서

본문

연결은 Backstage 백엔드가 외부 시스템에 도달하는 방식과 사용할 수 있는 인증 자료를 설명해요. 연결은 각 플러그인이 자체 구성을 정의하고 읽도록 요구하는 대신, 엔드포인트와 자격 증명 구성의 공유된 검증된 소스를 플러그인에 제공해요.

실험적

연결 프레임워크는 실험적이에요. 공용 런타임 경계가 완성되는 동안 그 구성과 API는 변경될 수 있어요.

연결이 유용한 이유

많은 백엔드 플러그인이 동일한 외부 시스템과 통신해요. 공유 연결이 없으면 각 플러그인이 동일한 서비스를 식별하는 값이라 해도 별도의 호스트, 기본 URL, 토큰, 또는 애플리케이션 자격 증명을 요구할 수 있어요. 이는 중복된 구성을 만들고 자격 증명 변경을 일관되게 적용하기 어렵게 만들어요.

연결은 다음을 제공해요:

  • 여러 백엔드 플러그인이 소비할 수 있는 하나의 구성 항목.

  • 각 외부 시스템에 대한 공유 정의에 대한 검증.

  • 플러그인 작성자를 위한 타입화된(t typed) 조회 쿼리와 반환 값.

  • 여러 호스트와 인증 메서드 사이의 선택.

  • 어떤 연결과 자격 증명이 보이는지에 대한 플러그인 수준 제어.

  • 자격 증명 제공자와 API 클라이언트가 기반할 수 있는 정적 데이터 계층.

연결은 정적 구성을 포함해요. API 클라이언트를 만들거나, 애플리케이션 자격 증명을 단기 토큰으로 교환하거나, 자격 증명을 갱신하거나, 외부 시스템에 도달 가능한지 테스트하지 않아요. 반환된 인증 값은 정적 구성 또는 부트스트랩 자료이지, 현재 유효한 자격 증명의 보장이 아니에요. 플러그인이나 별도의 자격 증명 공급자가 연결을 해결한 후 동적 작업을 수행해요. 연결 서비스 제한 사항을 참고하세요.

구성 요소가 함께 맞물리는 방식

프레임워크는 공유 정의를 도입자의 구성과 플러그인의 해당 구성 사용으로 분리해요:

| 부분 | 목적 | 예시 | | 연결 타입 | 한 종류의 시스템에 대한 필드, 인증 메서드, 조회 동작을 정의. | github 타입은 호스트를 받고 none, token, app 인증을 지원. | | 구성된 연결 | Backstage 구성에 하나의 외부 엔드포인트와 그 인증 항목을 제공. | 토큰이 있는 GitHub Enterprise 호스트. | | 연결 선언 | 플러그인이나 모듈이 연결 타입을 사용하려 한다는 것을 기록. | catalog 백엔드가 github를 사용한다고 선언. | | 연결 서비스 | 호출 플러그인을 위해 구성된 연결과 하나의 적격 인증 항목을 선택. | 저장소 URL 조회가 일치하는 GitHub 호스트와 인증 값을 반환. | | 소비자 | 반환된 정적 필드를 사용해 클라이언트를 구성하거나 자격 증명 공급자에 전달. | GitHub 클라이언트가 반환된 기본 URL과 토큰을 사용. |

시작 시 기본 서비스는 구성을 로드하고 검증해요. 플러그인이 ConnectionsService.find를 호출하면 서비스는 플러그인의 선언과 가시성 규칙을 적용하고, 조회 쿼리를 사용해 연결을 선택하고, 하나의 인증 항목을 선택한 다음 결과를 반환해요.

문서 지도

작업에 맞는 가이드부터 시작하세요:

  • 연결 개념은 모델을 정의하고 조회, 인증 선택, 플러그인 범위 지정, 정적 자격 증명 수명 주기 제한을 설명해요.

  • 연결 구성 및 관리 는 연결 구성을 만들고, 변경하고, 범위를 지정하고, 마이그레이션하는 방법을 보여줘요.

  • 연결 소비 는 백엔드 플러그인이 연결을 선언하고, 조회하고, 좁히고, 처리하는 방법을 보여줘요.

  • 내장 연결 타입 은 사용 가능한 타입과 그 필드, 인증 메서드, 쿼리 형태를 연결해줘요.

  • 연결 타입 생성 또는 수정 은 표준 연결 타입을 추가하고 발전시키는 프레임워크 기여 경로를 다뤄요.

Backstage 인스턴스를 구성한다면 연결 구성 및 관리 부터 시작하세요. 백엔드 플러그인을 유지 관리한다면 연결 개념 을 읽고 연결 소비 를 이어서 읽으세요.

레거시 통합에서 마이그레이션

연결 서비스는 시작 시 기존 integrations와 최상위 aws 구성을 읽고 자동으로 연결로 변환할 수 있어요. 도입자는 기존 구성을 즉시 바꿀 필요가 없어요.

자동 변환이 어떻게 작동하는지, 레거시와 명시적 항목이 공존할 때의 우선순위 규칙, 그리고 한 번에 하나씩 연결 타입을 옮기는 단계별 가이드는 레거시 통합에서 마이그레이션 을 참고하세요.

더 알아보기 (Learn more)