Logica dell'endpoint richiesta per tutti i broker dei servizi

I broker dei servizi devono fornire un insieme standard di valori di metadati che vengono utilizzati dalle API REST e i broker IBM Cloud devono avere la logica per i seguenti endpoint o percorsi dell'API REST:

catalog (GET)

Restituisce i metadati del catalogo inclusi nel tuo broker.

resource instances (PUT)

Crea la tua istanza del servizio.

resource instances (DELETE)

Elimina l'istanza del servizio.

resource instances (PATCH)

Aggiorna la tua istanza del servizio.

Nota su catalog (GET): questo endpoint definisce il contratto tra il broker e la piattaforma IBM Cloud per i servizi e i piani supportati dal broker. Questo endpoint restituisce i metadati del catalogo memorizzati nel proprio broker. Questi valori definiscono il contratto minimo tra il tuo servizio e la piattaforma IBM Cloud. Tutti i metadati aggiuntivi del catalogo che non sono obbligatori vengono memorizzati nel catalogo “ IBM Cloud ”. Qualsiasi aggiornamento dei valori di visualizzazione del catalogo, come link e icone, deve essere effettuato nella IBM Cloud console e non deve essere conservato nel proprio broker. Nessuno dei metadati archiviati nel tuo broker viene visualizzato nella console IBM Cloud o nella CLI IBM Cloud. La console e l'interfaccia a riga di comando (CLI) restituiscono i valori impostati in Partner Center Sell e memorizzati nel catalogo " IBM Cloud ". La sezione seguente illustra i valori minimi richiesti restituiti dal comando 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."
               }
               ]
       }]
}

Logica di endpoint richiesta per i servizi associabili

Se il tuo servizio può essere integrato con le applicazioni presenti su IBM Cloud, deve fornire agli utenti del servizio gli endpoint API e le credenziali. Un servizio associabile deve utilizzare le operazioni associabili nella specifica Open Service Broker e implementare i seguenti endpoint o percorsi:

bindings and credentials (PUT)

Esegue il bind della tua istanza del servizio a un'applicazione.

bindings and credentials (DEL)

Annulla il bind della tua istanza del servizio da un'applicazione.

Endpoint di estensione IBM Cloud richiesti

La specifica OSB non supporta uno stato dell'istanza disabilitato. Uno stato disabilitato include un pagamento mancante o altre situazioni che determinano una sospensione dell'account (ma non ancora l'annullamento) ed è diverso da uno stato dell'istanza eliminato. Al fine di IBM Cloud supportare i clienti che potrebbero trovarsi in uno stato di disabilitazione, IBM Cloud ha definito gli endpoint API estesi che consentono di disabilitare e riabilitare le istanze di servizio. Sono richieste le seguenti estensioni degli endpoint:

enable and disable instances (GET)

Stato - restituisce lo stato della tua istanza del servizio.

enable and disable instances (PUT)

Abilitare o disabilitare un'istanza del servizio.

È responsabilità del provider di servizi disabilitare l'accesso all'istanza del servizio quando viene avviato l'endpoint di disabilitazione e riabilitare tale accesso quando viene avviato l'endpoint di abilitazione.

X-Broker-API-Originating-Identity

L'intestazione relativa all'identità dell'utente viene fornita tramite un'intestazione di identità proveniente dall'API. Questa intestazione di richiesta include l'identità IBM Cloud IAM dell'utente. L'identità IAM è base64 codificata. IBM Cloud Supporta un unico dominio di autenticazione: IBMid. L'area di autenticazione IBMid utilizza un IUI (IBMid Unique ID) per identificare l'identità dell'utente in IBM Cloud. Questo IUI è una stringa opaca per il provider di servizi.

Esempio:

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

Versione dell'intestazione API

L' intestazione della versione API è 2.12. Ad esempio: X-Broker-Api-Version: 2.12.

resource instance (PUT) body.context and resource instance (PATCH) body.context

PUT /v2/service_instances/:resource_instance_id e PATCH /v2/service_instances/:resource_instance_id ricevono il seguente valore all'interno di body.context: { "platform": "ibmcloud", "account_id": "tracys-account-id", "crn": "resource-instance-crn" }.

Suggerimenti sull'utilizzo delle operazioni asincrone invece di quelle sincrone

L'API OSB supporta entrambe le modalità di operazione sincrone e asincrone. Se le operazioni richiedono meno di 10 secondi, è necessario utilizzare le risposte sincrone. In caso contrario, devi utilizzare la modalità di operazione asincrona. La modalità asincrona richiede l'endpoint last_operation. Per ulteriori informazioni, vedi Ottieni lo stato di un provisioning in corso per un'istanza del servizio.

Suggerimenti per la gestione dei broker nelle diverse ubicazioni

È importante che gli utenti comprendano l'ubicazione dei loro servizi cloud per la latenza, la disponibilità e la residenza dei dati.

Quando si creano istanze di servizio su IBM Cloud, uno dei parametri obbligatori che gli utenti devono specificare è la posizione in cui desiderano che venga creata l'istanza di servizio. Alcuni servizi consentono di effettuare la creazione in più sedi. Ad esempio, un servizio di database può supportare la creazione in tutte IBM Cloud le regioni oppure può supportarne un sottoinsieme.

Se il tuo servizio basato su API di terze parti è implementato in un altro cloud ed esposto in IBM Cloud, l'ubicazione indica l'ubicazione del servizio nell'altro cloud.

Durante l'onboarding in IBM Cloud, devi implementare almeno un broker OSB. Puoi avere più di un broker in base alla tua strategia di distribuzione e alle ubicazioni che desideri supportare per il tuo servizio. In Partner Center Sell, si stabilisce l'associazione tra il piano dei prezzi e il broker. Le opzioni più comuni consistono nel definire un unico broker che gestisca tutte le sedi del servizio oppure un broker per ogni sede; la scelta spetta al fornitore del servizio.

Per un elenco di ubicazioni disponibili, esamina IBM ubicazioni del catalogo globale. Se il tuo servizio richiede la definizione di più sedi, consulta il team IBM Cloud di onboarding.