Integración con Deployment Manager

Deployment Manager ofrece la posibilidad de registrar una API de terceros con el servicio Deployment Manager. Después de registrar una API como proveedor de tipos en Deployment Manager, puedes usar Deployment Manager para implementar recursos de la API como tipos en tu configuración.

Este documento es una guía de una página que describe el proceso de integración de una API de terceros con Deployment Manager. En esta página no se incluyen instrucciones detalladas para cada paso del proceso, sino una descripción general y enlaces adicionales para obtener más información. En esta página se ofrece una visión general del proceso para añadir una API, pero consulta la documentación detallada para ver instrucciones paso a paso.

Determinar si una API es apta para integrarse con Deployment Manager

Deployment Manager tiene ciertas expectativas sobre cualquier API que intente integrarse con él. En concreto, este cambio afecta a las siguientes acciones:

  • Deployment Manager espera una API RESTful. Es decir, la API expone una interfaz similar a REST con métodos de creación, lectura, actualización y eliminación (CRUD).
  • Todos los parámetros de ruta y de consulta se resuelven correctamente. Todos los parámetros de ruta y de consulta de la API deben formar parte del cuerpo del recurso o estar presentes en todos los métodos de la API para que Deployment Manager pueda asociar el parámetro cuando un usuario lo proporcione.
  • Se debe poder acceder al endpoint del documento de descriptor de la API. Deployment Manager hace una solicitud HTTP para obtener el documento de descriptor de una API, por lo que el documento debe alojarse en un lugar al que pueda acceder Deployment Manager. El documento debe estar disponible públicamente o protegido mediante autenticación básica.
  • En relación con el punto anterior, la API tiene autenticación básica o, si la API se ejecuta en Google Kubernetes Engine o Google Cloud Endpoints, admite la autenticación OAuth 2.0 mediante un token de acceso de la cuenta de servicio del proyecto. Más información sobre la autenticación
  • Si tu API es compleja, puede que tengas que configurar opciones adicionales para explicar a Deployment Manager cómo gestionar un comportamiento de la API menos obvio.

Para obtener más información, consulta la documentación sobre los requisitos de la API.

Añadir tu API a Deployment Manager

Una vez que hayas determinado que tu API cumple los requisitos anteriores, añádela como recurso de proveedor de tipos. Debe proporcionar un documento de descriptor de API y, opcionalmente, cualquier opción de API adicional mediante las opciones avanzadas. Al añadir una API como proveedor de tipos, se exponen todos los recursos de esa API a Deployment Manager, lo que permite a los usuarios crear, actualizar o eliminar esos recursos con Deployment Manager.

Si tu API tiene patrones sutiles que no se pueden reconocer fácilmente, también tendrás que proporcionar asignaciones de entrada a Deployment Manager para que pueda gestionar correctamente las solicitudes de la API. Para obtener más información, consulta Opciones avanzadas de la API.

Llamar a un proveedor de tipos en archivos de configuración

Una vez que una API se ha registrado en Deployment Manager, puedes crear recursos de API llamando a ese recurso de API como un tipo en tu configuración.

Por ejemplo, si has llamado example-directory-api a tu proveedor de tipos y quieres crear un recurso de API llamado person, puedes especificar el tipo en tus configuraciones de la siguiente manera:

resources:
- name: Jane
  type: my-project/example-directory-api:person
  properties:
  - name: Jane
    website: www.example.com
    ...

Para comparar, este es el mismo proceso que se sigue para llamar a una API de Google y crear un recurso de API:

resource:
- name: example-instance
  type: compute.v1.instance
  properties:
  - machineType: n1-standard-1
    ...

Siguientes pasos