すべてのサービス・ブローカーに必要なエンドポイント・ロジック

サービス・ブローカーは、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 するため、サービスインスタンスを無効化および再有効化できる拡張APIエンドポイントを定義しました IBM Cloud。 以下のエンドポイント拡張が必要です：

インスタンスの有効化と無効化 (GET)

状況 - サービス・インスタンスの状態を戻します。

インスタンスの有効化と無効化 (PUT)

サービス・インスタンスを有効または無効にします。

無効化エンドポイントが開始されたときにサービス・インスタンスへのアクセスを無効化すること、および有効化エンドポイントが開始されたときにそのアクセスを再有効化することは、サービス・プロバイダーの責任で行います。

X-Broker-API-Originating-Identity

ユーザー識別子ヘッダー は、API由来の識別子ヘッダーを通じて提供されます。 この要求ヘッダーには、ユーザーの IBM Cloud IAM ID が含まれます。 IAM IDは base64 形式でエンコードされています。 IBM Cloud は、 IBMid という単一の認証領域をサポートしています。 IBMid レルムは、IBMid Unique 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 エンドポイントが必要です。 詳しくは、 サービス・インスタンスの進行中のプロビジョンの状況の取得 を参照してください。

ロケーションをまたがるブローカーの管理に関する推奨

ユーザーが、待ち時間、可用性、データ常駐のためにクラウド・サービスのロケーションを理解することは重要です。

IBM Cloud でサービスインスタンスを作成する際、ユーザーが入力する必要がある必須パラメータの一つに、そのサービスインスタンスを作成したい場所があります。 一部のサービスでは、複数の場所での作成に対応しています。 たとえば、データベースサービスは、 IBM Cloud のすべてのリージョンでの作成に対応している場合もあれば、その一部のみに対応している場合もあります。

サード・パーティーの API ベースのサービスが別のクラウドで実装されていて IBM Cloud に公開される場合、ロケーションは、そのもう一方のクラウドにおけるサービスのロケーションを示します。

IBM Cloud にオンボードする場合、少なくとも 1 つの OSB ブローカーを実装する必要があります。 デプロイメント戦略およびサービスでサポートするロケーションに応じて、複数のブローカーを持つことができます。 Partner Center Sell では、価格設定プランとブローカーの間のマッピングを確立します。 一般的な選択肢としては、サービスのすべての拠点に対応する単一のブローカーを定義するか、拠点ごとにブローカーを定義するかがあり、この選択はサービスプロバイダー次第です。

使用可能なロケーションのリストについては、 IBM グローバル・カタログのロケーションを確認してください。 ご利用のサービスでさらに多くのロケーションを定義する必要がある場合は、 IBM Cloud のオンボーディングチームにご相談ください。