이 튜토리얼에서는 통합 및 커넥터를 사용하여 Cloud Pub/Sub 메시지 게시를 트리거하는 샘플 통합을 만드는 방법을 보여줍니다. 이 튜토리얼에서는 Apigee 통합에 대한 실무 지식이 있다고 가정합니다.
이 예시에서 API 엔드포인트를 호출하면 Cloud Pub/Sub 주제에 대해 메시지 게시가 트리거됩니다. 아래 단계에서는 성공적인 통합 실행을 위해 필요한 API 트리거 및 Pub/Sub 연결을 구성하는 방법을 설명합니다.
시작하기 전에
이 튜토리얼을 시작하기 전에 Google Cloud 로그인 사용자 인증 정보 및 조직 세부정보를 확인합니다. 이 정보는 커넥터 UI에 액세스하기 위해 필요합니다. Apigee 사용자 인증 정보는 Apigee Integration 디자이너 내에서 커넥터 태스크에 액세스하기 위해 필요합니다. 추가적인 기본 요건 단계는 아래에 설명되어 있습니다.
-
처음으로 연결을 만들려면 먼저 다음 단계를 완료합니다.
- 새 Apigee 인스턴스를 만듭니다. 프로비저닝 UI를 사용하여 새 Apigee 인스턴스를 프로비저닝할 수 있습니다.
커넥터를 지원하는 리전의 목록은 지원되는 커넥터 리전을 참조하세요.
- Apigee Integration 및 커넥터 기능이 Apigee 구독에 부여되었는지 확인합니다.
- 다음 명령어를 사용하여 Apigee Integration 및 커넥터 기능을 사용 설정합니다.
curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H \ "content-type:application/json" \ "https://apigee.googleapis.com/v1/organizations/PROJECT_ID:setAddons" -XPOST \ -d '{"addonsConfig": {"integrationConfig": {"enabled": true}, "connectorsPlatformConfig": {"enabled": true}}}'
- 서비스 계정이 없으면 서비스 계정을 만듭니다.
서비스 계정은 인증을 거쳐야 하며 Google API의 데이터에 액세스할 수 있는 승인을 받은 사람이 아닌 사용자를 나타내는 특별한 유형의 Google 계정입니다. 서비스 계정이 없으면 서비스 계정을 만들어야 합니다. 자세한 내용은 서비스 계정 만들기를 참조하세요.
- 새 Apigee 인스턴스를 만듭니다. 프로비저닝 UI를 사용하여 새 Apigee 인스턴스를 프로비저닝할 수 있습니다.
- 통합에 사용할 Pub/Sub 연결을 만들기 전에 다음을 수행합니다.
- Cloud 콘솔에서 Integration Connectors > 연결 페이지로 이동한 다음 Google Cloud 프로젝트를 선택하거나 만듭니다.
- + 새로 만들기를 클릭하여 연결 만들기 페이지를 엽니다.
-
연결을 구성합니다.
- 연결 만들기 섹션에서 다음을 완료합니다.
- 커넥터: 사용 가능한 커넥터 드롭다운 목록에서 Cloud Pub/Sub를 선택합니다.
- 커넥터 버전: 사용 가능한 버전의 드롭다운 목록에서 커넥터 버전을 선택합니다.
- 연결 이름 필드에서 연결 인스턴스의 이름을 입력합니다.
연결 이름은 다음 기준을 충족해야 합니다.
- 연결 이름에 문자, 숫자, 하이픈을 사용할 수 있습니다.
- 문자는 소문자여야 합니다.
- 연결 이름은 문자로 시작하고 문자 또는 숫자로 끝나야 합니다.
- 연결 이름은 63자를 초과할 수 없습니다.
- 선택적으로 연결 인스턴스에 대한 설명을 입력합니다.
- 서비스 계정: 필수 역할이 있는 서비스 계정을 선택합니다.
- 프로젝트 ID: Pub/Sub 인스턴스가 있는 Google Cloud 프로젝트의 ID입니다.
- 주제 ID: 메시지를 게시할 주제의 이름입니다.
- 선택적으로 + 라벨 추가를 클릭하여 키/값 쌍의 형식으로 연결에 라벨을 추가합니다.
- 다음을 클릭합니다.
- 위치: 연결 위치를 선택합니다.
- 리전 드롭다운 목록에서 Apigee를 사용할 수 있는 위치를 선택합니다.
커넥터가 지원되는 리전은 다음과 같습니다.
지원되는 모든 리전 목록은 위치를 참조하세요.
- 다음을 클릭합니다.
- 리전 드롭다운 목록에서 Apigee를 사용할 수 있는 위치를 선택합니다.
-
인증: Cloud Pub/Sub 연결에서 지원되는 인증 유형입니다.
- AUTH_TYPE_UNSPECIFIED
사용할 인증을 기반으로 세부정보를 입력합니다.
- AUTH_TYPE_UNSPECIFIED
- 다음을 클릭합니다.
- 검토: 연결 및 인증 세부정보를 검토합니다.
- 연결 만들기 섹션에서 다음을 완료합니다.
- 만들기를 클릭합니다.
- Apigee UI로 이동하고 연결이 생성된 것과 동일한 프로젝트에 로그인합니다.
- 개발 > 통합을 클릭합니다.
- 새로 만들기를 클릭합니다.
- 통합 만들기 대화상자에 이름과 설명을 입력합니다.
- 만들기를 클릭하여 통합 디자이너를 엽니다.
- 통합 디자이너에서 + 태스크/트리거 추가를 클릭하여 태스크를 보고 선택 대화상자를 트리거합니다.
- 트리거를 클릭하여 사용 가능한 트리거를 봅니다.
- API 트리거 요소를 디자이너로 드래그합니다.
- Apigee UI로 이동하고 로그인합니다.
- UI 왼쪽 상단의 드롭다운 메뉴를 사용해 조직을 선택합니다.
- 개발 > 통합을 클릭합니다.
- 통합 목록에서 수정할 통합을 검색하거나 선택하고 통합 디자이너를 클릭하여 엽니다.
- +태스크/트리거 추가 > 태스크를 클릭하여 사용 가능한 태스크 목록을 봅니다.
- 커넥터 태스크 요소를 통합 디자이너로 드래그합니다.
- 디자이너에서 커넥터 태스크 요소를 클릭하여 커넥터 태스크 구성 창을 확인합니다.
- 선택적으로 를 클릭하여 태스크 이름을 수정합니다. 이렇게 하면 일반적인 커넥터의 태스크 이름을 해당 통합과 관련된 이름으로 변경할 수 있습니다.
- 구성 섹션의 구성 탭에서 태스크 구성 버튼을 클릭하여 커넥터 태스크 구성 창을 엽니다.
- 연결 열에서 사용 가능한 연결 목록 중에서 이전 단계에서 만든 Pub/Sub 연결을 선택합니다.
- 연결을 선택하면 유형 열이 표시됩니다. 이 예시에서는 작업을 선택한 후 사용 가능한 작업 목록에서 publishMessage를 선택합니다.
- 항목은 연결된 애플리케이션 또는 서비스에서 커넥터 인터페이스를 통해 통합에 노출될 수 있는 객체 또는 속성 컬렉션으로 이해될 수 있습니다. Pub/Sub 연결은 항목을 노출하지 않습니다.
- 작업은 커넥터 인터페이스를 통해 통합에 제공되는 첫 번째 클래스 함수입니다. 함수는 연결된 애플리케이션 또는 서비스에서 정의되며, 하나의 항목 또는 여러 항목에서 수행될 수 있는 변경 또는 일련의 변경을 정의합니다. Pub/Sub 연결에 사용 가능한 하나의 작업이 있습니다.
- 완료를 클릭하여 연결 구성을 완료하고 창을 닫습니다.
- Pub/Sub 연결을 위한 커넥터 태스크 구성 창에는 또한 연결에 사용하도록 이전 단계에서 선택한 항목 및 작업 또는 작업에 의해 자동으로 생성된 태스크 입력 변수 및 태스크 출력 변수가 표시됩니다. 이러한 변수는 후속 태스크에 대한 입력 또는 현재 통합에 구성된 조건으로 액세스될 수 있습니다.
태스크 입력을 구성하려면 다음 안내를 따르세요.
- 커넥터 입력 페이로드 변수 캡슐을 클릭하여 변수 구성 창을 엽니다.
- 기본값 필드에
{"message": "test message from integration platform"}
텍스트를 입력합니다. - 통합의 입력으로 사용 체크박스를 선택합니다.
- 저장을 클릭합니다.
태스크에서 오류를 처리하도록 다양한 재시도 전략을 구성할 수 있습니다. 재시도 전략을 사용하면 오류가 발생한 경우 태스크를 재실행하는 방법을 지정할 수 있습니다. 자세한 내용은 오류 처리 전략을 참조하세요.
- API 트리거 요소에서 제어 지점 위로 마우스를 가져간 후 선을 클릭하고 커넥터 태스크 요소의 제어 지점으로 드래그하여 API 트리거 요소에서 커넥터 요소로 에지 연결을 추가합니다. 제어 지점과 에지 선이 노란색으로 변경됩니다. 에지는 API 트리거 태스크에서 커넥터 태스크로의 제어 흐름을 나타냅니다.
- 통합 디자이너 툴바에서 게시 버튼을 클릭합니다.
- 테스트를 클릭하여 통합을 트리거하고 실행합니다. 그러면 통합 테스트 창이 열리고 이전 단계에서 설정한 입력 변수(메시지)가 표시됩니다. 원하는 경우 입력 변수를 여기에서 수정할 수 있습니다.
- 통합 테스트를 클릭합니다.
- 성공하면 통합 테스트 창에 해당 통합의 입력 및 출력 변수 페이로드의 값과 함께 성공 메시지가 표시됩니다.
- 닫기를 클릭하여 통합 테스트 창을 닫습니다.
- Pub/Sub 페이지로 이동 Pub/Sub 주제를 선택한 후 메시지 보기를 클릭하여 통합에서 전송한 메시지 수신을 확인합니다.
- Apigee Integration 로그를 검사하여 지정된 통합의 상태를 확인합니다. 로그를 보려면 다음 안내를 따르세요.
- 통합 디자이너의 툴바에서 로그를 클릭합니다.
- 실행 로그 페이지에서 통합 실행 시도에 대한 세부정보를 볼 수 있습니다.
각 항목에는 다음을 포함하여 실행 시도에 대한 세부정보가 포함됩니다.
- 통합 이름
- 실행 ID
- 상태
- 시작 시간
- 기간
- 통합 ID
- 트리거 ID
- 실행된 통합 옆의 확장 화살표(>)를 클릭하여 통합에 있는 태스크 및 변수의 확장된 목록과 태스크 상태 및 변수 페이로드를 확인합니다.
- Apigee에서 지원되는 커넥터 목록 참조
- 연결 만들기 및 관리 방법 알아보기
필수 서비스 사용 설정
커넥터를 사용하려면 다음 Google 서비스를 사용 설정해야 합니다.
이름 | 제목 |
apigee.googleapis.com |
Apigee API |
secretmanager.googleapis.com |
Secret Manager API |
connectors.googleapis.com |
Connectors API |
이러한 서비스가 이전에 프로젝트에 대해 사용 설정되지 않았으면 연결 만들기 페이지에서 연결을 만들 때 서비스를 사용 설정하라는 메시지가 표시됩니다.
Pub/Sub 연결 만들기
연결을 구성하려면 다음 안내를 따르세요.
새 통합 만들기
새 통합을 만들려면 다음 단계를 수행합니다.
API 트리거 추가
트리거는 통합을 구성하는 태스크의 시퀀스를 시작하는 데 필요합니다. 사용 가능한 모든 트리거를 사용하여 통합을 시작할 수 있습니다. 이 튜토리얼에서는 API 트리거를 사용하여 통합 실행을 직접 호출합니다.
신규 또는 기존 통합에 API 트리거를 추가하려면 다음 단계를 따르세요.
이 트리거에는 추가 구성이 필요하지 않습니다. API 트리거 ID를 보려면 통합 디자이너에서 API 트리거 요소를 클릭합니다. 구성 패널에는 api_trigger/TRIGGER_NAME
형식의 머신 생성 ID인 트리거 ID가 표시됩니다.
태스크 추가 및 구성
태스크는 변수를 입력으로 사용하고 변수를 출력으로 생성할 수 있는 실행 가능한 단계 집합입니다. 트리거와 마찬가지로 사용 가능한 모든 태스크를 통합에 사용할 수 있습니다.
이 튜토리얼에서는 커넥터 태스크가 사용됩니다. 태스크의 구성 세부정보는 아래 단계에서 설명합니다.
Pub/Sub 연결과 함께 커넥터 만들기 태스크 구성
Pub/Sub 연결을 사용하도록 Apigee Integration에서 커넥터 태스크를 구성하려면 다음 안내를 따르세요.
통합 테스트
새 통합을 테스트하려면 다음 단계를 따르세요.
통합의 성공 여부를 확인하려면 다음 단계를 따르세요.
축하합니다. Apigee Integration에서 Pub/Sub 연결을 만들고 성공적으로 테스트했습니다.