Lógica de punto final necesaria para todos los intermediarios de servicio

Los intermediarios de servicio deben proporcionar un conjunto estándar de valores de metadatos que consumen las API REST, y los intermediarios de IBM Cloud deben tener lógica para los siguientes puntos finales o vías de acceso de la API REST:

catálogo (GET)

Devuelve los metadatos de catálogo incluidos en el intermediario.

instancias de recursos (PUT)

Crea la instancia de servicio.

instancias de recursos (DELETE)

Suprime la instancia de servicio.

instancias de recursos (PATCH)

Actualiza la instancia de servicio.

Nota sobre el catálogo (GET): este punto final define el contrato entre el intermediario y la plataforma IBM Cloud en lo que respecta a los servicios y planes a los que el intermediario da soporte. Este punto final devuelve los metadatos del catálogo almacenados en tu broker. Estos valores definen el contrato mínimo entre tu servicio y la plataforma IBM Cloud. Todos los metadatos adicionales del catálogo que no sean obligatorios se almacenan en el catálogo « IBM Cloud ». Cualquier actualización de los valores de visualización del catálogo, como enlaces e iconos, debe realizarse en la IBM Cloud consola, y no alojarse en su agente. Ninguno de los metadatos almacenados en el intermediario se muestra en la consola de IBM Cloud ni en la CLI de IBM Cloud. La consola y la interfaz de línea de comandos (CLI) muestran los datos que se han configurado en Partner Center Sell y que se han almacenado en el catálogo « IBM Cloud ». En la siguiente sección se muestran los valores mínimos obligatorios que devuelve la consulta (GET) del catálogo:

{
       "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."
               }
               ]
       }]
}

Lógica de los puntos finales necesarios para servicios que se pueden enlazar

Si tu servicio puede integrarse con aplicaciones de IBM Cloud, debe proporcionar a los usuarios de tu servicio los puntos de conexión de la API y las credenciales. Un servicio que se puede enlazar debe utilizar las operaciones enlazables de la especificación Open Service Broker y debe utilizar los siguientes puntos finales o vías de acceso:

enlaces y credenciales (PUT)

Enlaza la instancia de servicio a una aplicación.

enlaces y credenciales (DEL)

Anula en enlace de la instancia de servicio de una aplicación.

Puntos finales necesarios de extensión de IBM Cloud

La especificación OSB no da soporte a un estado de instancia inhabilitado. Un estado inhabilitado incluye un pago que falta u otras situaciones que dan como resultado una suspensión de cuenta (pero que todavía no se ha cancelado) y es diferente de un estado de instancia suprimido. Con el fin de IBM Cloud dar soporte a los clientes que puedan experimentar un estado de desactivación, IBM Cloud definimos los puntos finales API ampliados que permiten desactivar y volver a activar las instancias de servicio. Se requieren las siguientes extensiones de punto final:

habilitar e inhabilitar instancias (GET)

Estado: devuelve el estado de la instancia de servicio.

habilitar e inhabilitar instancias (PUT)

Habilitar o inhabilitar una instancia de servicio.

Es responsabilidad del proveedor del servicio inhabilitar el acceso a la instancia de servicio cuando se inicia una inhabilitación del punto final y volver a habilitar dicho acceso cuando se inicia una habilitación del punto final.

X-Broker-API-Originating-Identity

El encabezado de identidad del usuario se proporciona a través de un encabezado de identidad procedente de una API. Esta cabecera de solicitud incluye la identidad de IBM Cloud IAM del usuario. La identidad IAM está codificada en formato « base64 ». IBM Cloud admite un único ámbito de autenticación: IBMid. El dominio de IBMid utiliza un ID exclusivo de IBMid (IUI) para identificar la identidad del usuario en IBM Cloud. Este IUI es una serie opaca para el proveedor del servicio.

Ejemplo:

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

Versión de la cabecera de API

La cabecera de versión de API es 2.12. Por ejemplo: X-Broker-Api-Version: 2.12.

body.context de la instancia del recurso (PUT) y body.context de la instancia del recurso (PATCH)

PUT /v2/service_instances/:resource_instance_id y PATCH /v2/service_instances/:resource_instance_id reciben el siguiente valor en body.context: { "platform": "ibmcloud", "account_id": "tracys-account-id", "crn": "resource-instance-crn" }.

Recomendaciones sobre el uso de operaciones síncronas en lugar de operaciones asíncronas

La API OSB da soporte a las modalidades de operación síncronas y asíncronas. Si las operaciones van a tardar menos de 10 segundos, debe utilizar respuestas síncronas. De lo contrario, debe utilizar la modalidad de operación asíncrona. La modalidad asíncrona requiere el punto final last_operation. Para obtener más información, consulte Obtener el estado de un suministro en curso para una instancia de servicio.

Recomendaciones para gestionar intermediarios entre ubicaciones

Es importante que los usuarios conozcan la ubicación de sus servicios de nube para saber la latencia, disponibilidad y residencia de los datos.

Al crear instancias de servicio en IBM Cloud, uno de los parámetros obligatorios que deben proporcionar los usuarios es la ubicación en la que desean que se cree dicha instancia de servicio. Algunos servicios permiten crear contenido en varias ubicaciones. Por ejemplo, un servicio de bases de datos puede admitir la creación en todas las regiones de IBM Cloud o solo en un subconjunto de ellas.

Si el servicio basado en API de terceros se implementa en otra nube y se expone en IBM Cloud, la ubicación indica la ubicación del servicio en la otra nube.

Al realizar la incorporación a IBM Cloud, debe implementar al menos un intermediario OSB. Tiene la opción de tener más de un intermediario, en función de la estrategia de despliegue y de las ubicaciones a las que desea dar soporte para el servicio. Dentro Partner Center Sell, establece la correlación entre el plan de precios y el intermediario. Las opciones habituales son definir un único agente para dar servicio a todas las ubicaciones de su servicio o definir un agente por cada ubicación; esta decisión depende del proveedor del servicio.

Para obtener una lista de las ubicaciones disponibles, consulte las Ubicaciones del catálogo global deIBM. Si tu servicio requiere que se definan más ubicaciones, consulta al equipo de incorporación de IBM Cloud.