Realizar la integración con Deployment Manager

Deployment Manager ofrece la posibilidad de registrar una API de terceros con el servicio de Deployment Manager. Después de registrar una API como proveedor de tipos con Deployment Manager, puedes utilizar Deployment Manager para implementar recursos de API como tipos en la 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. Esta página no contiene instrucciones completas para cada paso del proceso, pero proporciona una descripción general y vínculos adicionales para obtener más información. Utiliza esta página para obtener una vista de alto nivel para agregar una API, pero consulta la documentación detallada para obtener instrucciones paso a paso.

Determinar si una API es apta para integrarse en Deployment Manager

Deployment Manager tiene determinadas expectativas con respecto a las API que intentan integrarse en esta herramienta. Específicamente, ocurre lo siguiente:

  • Deployment Manager espera una API de 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 búsqueda se resuelven correctamente. Todos los parámetros de ruta y búsqueda de la API deben existir como parte del cuerpo del recurso o existir en todos los métodos de la API, de modo que Deployment Manager pueda coincidir con el parámetro cuando un usuario lo proporcione.
  • El extremo del documento descriptor de la API debe ser accesible. Deployment Manager realiza una solicitud HTTP para obtener un documento descriptor de la API, por lo que debe estar alojado en un lugar al que Deployment Manager pueda acceder. El documento debe estar disponible de forma pública o protegido por autenticación básica.
  • En relación con el punto anterior, la API tiene autenticación básica o, si la API se está ejecutando en Google Kubernetes Engine o Google Cloud Endpoints, la API admite la autenticación de OAuth 2.0 mediante el uso de un token de acceso desde la cuenta de servicio del proyecto. Lee más sobre la autenticación.
  • Si la API es compleja, es posible que debas configurar opciones adicionales para explicarle a Deployment Manager cómo manejar un comportamiento menos obvio de la API.

Para obtener más información, lee la documentación de Requisitos de API.

Agrega la API a Deployment Manager

Después de determinar que la API coincide con los requisitos mencionados con anterioridad, agrega la API como recurso de Proveedor de tipos. Debes proporcionar un documento descriptor de la API y, de manera opcional, cualquier opción adicional de API mediante las opciones avanzadas. La adición de una API como proveedor de tipos expone todos los recursos de esa API a Deployment Manager y permite a los usuarios crear, actualizar o borrar esos recursos con Deployment Manager.

Si la API tiene patrones de API sutiles es probable que no se puedan reconocer fácilmente; también tendrás que proporcionar asignaciones de entrada a Deployment Manager para que pueda manejar las solicitudes a la API de manera adecuada. Para obtener más información, lee las Opciones de API avanzadas.

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

Una vez que una API se haya registrado con Deployment Manager, puedes crear recursos de API; para ello, llama a ese recurso de API como un tipo en la configuración.

Por ejemplo, si nombraste a tu proveedor de tipos example-directory-api y deseas crear un recurso de API conocido como 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 usa 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
    ...

Próximos pasos

¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...

Documentación de Cloud Deployment Manager