모든 서비스 브로커에 대한 필수 엔드포인트 로직

서비스 브로커는 REST API가 이용하는 메타데이터 값의 표준 세트를 제공해야 하며 IBM Cloud 브로커에는 다음 REST API 엔드포인트 또는 경로에 대한 로직이 있어야 합니다.

카탈로그(GET)

브로커에 포함된 카탈로그 메타데이터를 리턴합니다.

리소스 인스턴스(PUT)

서비스 인스턴스를 작성합니다.

리소스 인스턴스(DELETE)

서비스 인스턴스를 삭제합니다.

리소스 인스턴스(PATCH)

서비스 인스턴스를 업데이트합니다.

카탈로그(GET)에 대한 참고: 이 엔드포인트는 브로커가 지원하는 서비스 및 플랜에 대한 브로커와 IBM Cloud 플랫폼 간의 계약을 정의합니다. 이 엔드포인트는 브로커 내에 저장된 카탈로그 메타데이터를 반환합니다. 이 값들은 귀하의 서비스와 IBM Cloud 플랫폼 간의 최소 계약 조건을 정의합니다. 필수 사항이 아닌 모든 추가 카탈로그 메타데이터는 ‘ IBM Cloud ’ 카탈로그 내에 저장됩니다. 카탈로그 표시 값(링크 및 아이콘 등)에 대한 모든 업데이트는 IBM Cloud 콘솔에서 수행해야 하며, 브로커에 저장되어서는 안 됩니다. 브로커에 저장된 메타데이터는 IBM Cloud 콘솔이나 IBM Cloud CLI에 표시되지 않습니다. 콘솔과 CLI는 Partner Center Sell에서 설정되고 ‘ IBM Cloud ’ 카탈로그에 저장된 내용을 반환합니다. 다음 섹션에서는 catalog(GET)이 반환하는 최소 필수 값을 보여줍니다:

{
       "services": [{
           "id": "0bc9d744-6f8c-4821-9648-2278bf6925bb",
           "name": "ibmcloud-link",
           "description": "An IBM provided service that enables aliasing to service instances in the IBM Cloud.",
           "bindable": true,
           "plan_updateable": false,
           "plans": [
               {
                   "id": "da40662d-2f72-4a19-8c79-8c77cf285e1",
                   "name": "ibmcloud-alias",
                   "free": true,
                   "description": "The IBM Cloud alias plan used for linking."
               }
               ]
       }]
}

바인드 가능 서비스에 대한 필수 엔드포인트 로직

IBM Cloud 의 애플리케이션에 서비스를 연동할 수 있는 경우, 해당 서비스는 서비스 사용자에게 API 엔드포인트와 인증 정보를 제공해야 합니다. 바인드 가능 서비스는 Open Service Broker 스펙의 바인드 가능 조작을 사용해야 하며 다음의 엔드포인트 또는 경로를 구현해야 합니다.

바인딩 및 인증 정보(PUT)

서비스 인스턴스를 애플리케이션에 바인드합니다.

바인딩 및 인증 정보(DEL)

서비스 인스턴스를 애플리케이션에서 바인드 해제합니다.

필수 IBM Cloud 확장 엔드포인트

OSB 스펙은 사용 불가능한 인스턴스 상태를 지원하지 않습니다. 사용 안함 상태에는 누락된 지불 또는 계정 일시중단 (아직 취소되지 않음) 이 발생하고 삭제된 인스턴스 상태와 다른 기타 상황이 포함됩니다. 장애 상태를 경험할 수 있는 고객을 지원하기 IBM Cloud 위해, 서비스 인스턴스를 비활성화 및 재활성화할 IBM Cloud 수 있도록 확장된 API 엔드포인트를 정의했습니다. 다음 엔드포인트 확장이 필요합니다:

인스턴스 사용 및 사용 안함(GET)

상태 - 서비스 인스턴스의 상태를 리턴합니다.

인스턴스 사용 및 사용 안함(PUT)

서비스 인스턴스를 사용 또는 사용 안함으로 설정합니다.

사용 안함 엔드포인트가 시작될 때 서비스 인스턴스에 대한 액세스를 사용 안함으로 설정하고 사용 엔드포인트가 시작될 때 해당 액세스를 다시 사용으로 설정하는 것은 서비스 제공자의 책임입니다.

X-Broker-API-Originating-Identity

사용자 식별 헤더 는 API에서 생성된 식별 헤더를 통해 제공됩니다. 이 요청 헤더는 사용자의 IBM Cloud IAM ID를 포함합니다. IAM ID는 base64 형식으로 인코딩됩니다. IBM Cloud 는 IBMid 라는 단일 인증 영역을 지원합니다. IBMid 영역은 IBM ID 고유 ID(IUI)를 사용하여 IBM Cloud에서 사용자 ID를 식별합니다. 이 IUI는 서비스 제공자에게 불투명한 문자열로 표시됩니다.

예:

X-Broker-API-Originating-Identity: ibmcloud eyJpYW1faWQiOiJJQk1pZC01MEdOUjcxN1lFIn0=
Decoded:
{"iam_id":"IBMid-50GNR717YE"}

API 버전 헤더

API 버전 헤더 는 2.12입니다. 예: X-Broker-Api-Version: 2.12.

리소스 인스턴스(PUT) body.context 및 리소스 인스턴스(PATCH) body.context

PUT /v2/service_instances/:resource_instance_id 및 PATCH /v2/service_instances/:resource_instance_id는 body.context에서 다음 값을 받습니다. { "platform": "ibmcloud", "account_id": "tracys-account-id", "crn": "resource-instance-crn" }

동기 대신 비동기 오퍼레이션 사용에 대한 권장사항

OSB API는 동기 및 비동기 모드의 오퍼레이션을 모두 지원합니다. 조작에 10초미만이 소요되는 경우 동기 응답을 사용해야 합니다. 그렇지 않으면 비동기 모드의 오퍼레이션을 사용해야 합니다. 비동기 모드에는 last_operation 엔드포인트가 필요합니다. 자세한 정보는 서비스 인스턴스에 대해 진행 중인 프로비저닝 상태 가져오기 를 참조하십시오.

위치에서 브로커를 관리하기 위한 권장사항

사용자는 대기 시간, 가용성 및 데이터 주거성(data residency)에 대한 클라우드 서비스의 위치를 이해하는 것이 중요합니다.

IBM Cloud 에서 서비스 인스턴스를 생성할 때, 사용자가 입력해야 하는 필수 매개변수 중 하나는 해당 서비스 인스턴스를 생성할 위치입니다. 일부 서비스는 여러 위치에서 생성하는 기능을 지원할 수 있습니다. 예를 들어, 데이터베이스 서비스는 ‘ IBM Cloud ’의 모든 리전에서 생성 기능을 지원할 수도 있고, 그중 일부만 지원할 수도 있습니다.

서드파티 API 기반 서비스가 다른 클라우드에서 구현되고 IBM Cloud에 노출되는 경우 위치는 다른 클라우드에 있는 서비스의 위치를 표시해야 합니다.

IBM Cloud에 온보딩하는 경우 하나 이상의 OSB 브로커를 구현해야 합니다. 배치 전략 및 서비스에 대해 지원할 위치에 따라 둘 이상의 브로커가 있을 수 있습니다. 파트너 센터 판매 내에서 가격 플랜과 브로커 간의 맵핑을 설정합니다. 일반적으로 서비스의 모든 위치를 처리할 단일 브로커를 지정하거나, 위치별로 브로커를 지정하는 두 가지 방법이 있으며, 이 선택은 서비스 제공업체의 재량에 달려 있습니다.

사용 가능한 위치 목록은 IBM 글로벌 카탈로그 위치를 검토하십시오. 서비스에 더 많은 위치를 정의해야 하는 경우, IBM Cloud 온보딩 팀에 문의하십시오.