Confluence

Puedes usar el conector de Confluence para realizar operaciones de inserción, eliminación, actualización y lectura en Confluence.

Antes de comenzar

Antes de usar el conector de Confluence, realiza las siguientes tareas:

• En tu proyecto de Google Cloud, haz lo siguiente:
  • Asegúrate de que la conectividad de red esté configurada. Para obtener información sobre los patrones de red, consulta Conectividad de red.
  • Otorga el rol de IAM roles/connectors.admin al usuario que configure el conector.
  • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

  • Habilita los siguientes servicios:
    • secretmanager.googleapis.com (API de Secret Manager)
    • connectors.googleapis.com (API de conectores)

    Para comprender cómo habilitar servicios, consulta Habilita servicios.

  Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

   Ir a la página Conexiones

2. Haz clic en + CREAR NUEVO para abrir la página Crear conexión.
3. En la sección Ubicación, elige la ubicación para la conexión.
   1. Región: selecciona una ubicación de la lista desplegable.

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

   2. Haz clic en SIGUIENTE.
4. En la sección Detalles de la conexión, completa lo siguiente:
   1. Conector: Selecciona Confluence en la lista desplegable de conectores disponibles.
   2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
   3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de las conexiones no pueden superar los 49 caracteres.
   4. De manera opcional, ingresa una Descripción para la instancia de conexión.
   5. De manera opcional, habilita Cloud Logging y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en Error.
   6. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
   7. De manera opcional, selecciona Incluir espacios archivados para incluir contenido de espacios archivados en el resultado. El valor predeterminado es falso.
   8. De manera opcional, ingresa una clave de espacio para que la búsqueda muestre contenido solo de este espacio específico.
   9. De manera opcional, configura los parámetros de nodo de conexión:
      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

   Nota: Puedes personalizar los valores de los nodos de conexión solo si eres un cliente de pago por uso.
   10. De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
   11. Haga clic en SIGUIENTE.
5. En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
   1. Tipo de destino: Selecciona un Tipo de destino.
      • Selecciona Dirección de host en la lista para especificar el nombre de host o la dirección IP del destino.
      • Si deseas establecer una conexión privada a tus sistemas de backend, selecciona Adjunto de extremo en la lista y, luego, selecciona el archivo adjunto de extremo requerido en la lista Adjunto de extremo.
        Nota: Para comprender cómo crear un adjunto de extremo, consulta Adjunto de servicio de PSC y Adjunto de extremo. Después de crear el archivo adjunto del extremo, este aparecerá en la lista Adjunto de extremo.

      Si deseas establecer una conexión pública a tus sistemas de backend con seguridad adicional, puedes configurar direcciones IP salientes estáticas para tus conexiones y, luego, configurar tus reglas de firewall para incluir en la lista de entidades permitidas solo las direcciones IP estáticas específicas.

      Para ingresar destinos adicionales, haz clic en +AGREGAR DESTINO.

   2. Haga clic en SIGUIENTE.
6. En la sección Autenticación, ingresa los detalles de autenticación.
   1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

      El conector de Confluence admite los siguientes tipos de autenticación:

      • Básico
      • APIToken
      • OAuth2.0

   Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

   2. Haga clic en SIGUIENTE.
7. Revisa: Revisa tus detalles de conexión y autenticación.
8. Haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

• Básica
  • Nombre de usuario: La cuenta de usuario de Confluence que se usa para la autenticación.
  • Contraseña: Es la contraseña asociada con la cuenta.
• APIToken
  • Nombre de usuario: Es el nombre de usuario de Confluence que se usó para crear el token de API.
  • Token de API: La contraseña del nombre de usuario es un token de API. Selecciona el Secret de Secret Manager que contiene el token de API asociado con el nombre de usuario de Confluence.
• Código de autorización de OAuth 2.0
  • ID de cliente: Es el ID de cliente que proporciona tu aplicación externa.
  • Permiso: Alcance del permiso. El permiso offline_access se debe usar con el conector de Confluence. Para obtener más información sobre los permisos de Confluence, consulta Permisos de Confluence.
  • Secreto del cliente: Selecciona el secreto de Secret Manager. Debes crear el secreto de Secret Manager antes de configurar esta autorización.
  • Versión del secreto: La versión del secreto de Secret Manager para el secreto del cliente.

  Para el tipo de autenticación Authorization code, después de crear la conexión, debes realizar algunos pasos adicionales para configurar la autenticación. Para obtener más información, consulta Pasos adicionales después de la creación de la conexión.

  Nota: Si usas el tipo de autenticación Authorization code y realizaste cambios de configuración en tu aplicación de Confluence, debes volver a autorizar tu conexión de Confluence. Para comprender cómo volver a autorizar, consulta la página sobre cómo volver a autorizar el código de autorización.

Pasos adicionales después de la creación de la conexión

Si seleccionaste OAuth 2.0 - Authorization code para la autenticación, debes seguir estos pasos adicionales después de crear la conexión:

1. En la página Conexiones, busca la conexión recién creada.

   Ten en cuenta que el Estado del nuevo conector será Se requiere autorización.

2. Haz clic en Se requiere autorización.

   Se mostrará el panel Editar autorización.

3. Copia el valor del URI de redireccionamiento en tu aplicación externa.
4. Verifica los detalles de la autorización.
5. Haz clic en Autorizar.

   Si la autorización se realiza correctamente, el estado de la conexión se establecerá como Activa en la página Conexiones.

Cómo volver a autorizar el código de autorización

Si usas el tipo de autenticación Authorization code y realizaste cambios de configuración en tu aplicación de Confluence, debes volver a autorizar tu conexión de Confluence. Para volver a autorizar una conexión, sigue estos pasos:

1. Haz clic en la conexión requerida en la página Conexiones.

   Se abrirá la página de detalles de la conexión.

2. Haz clic en Editar para editar los detalles de la conexión.
3. Verifica los detalles de OAuth 2.0: Código de autorización en la sección Autenticación.

   Si es necesario, realiza los cambios necesarios.

4. Haz clic en Guardar. Esto te llevará a la página de detalles de la conexión.
5. Haz clic en Editar autorización en la sección Autenticación. Se mostrará el panel Autorizar.
6. Haz clic en Autorizar.

   Si la autorización se realiza correctamente, el estado de la conexión se establecerá como Activa en la página Conexiones.

Limitaciones del sistema

El conector de Confluence puede procesar 28 transacciones por segundo por nodo y limita las transacciones que superen este límite. De forma predeterminada, Integration Connectors asignan 2 nodos (para una mejor disponibilidad) a una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

Nota: La cantidad de nodos de Integration Connectors se ajustará automáticamente de forma dinámica según tu uso. Sin embargo, si deseas reservar capacidad para volúmenes grandes sin esperar al ajuste de escala automático, puedes ajustar el valor mínimo de nodos para una conexión. Se requieren más nodos para procesar más transacciones para una conexión. Por el contrario, se requieren menos nodos si una conexión procesa menos transacciones. Para configurar los valores del nodo, haz lo siguiente:

• Si eres cliente de pago por uso, configura el valor mínimo y máximo de los nodos en la página de edición de la conexión.
• Si eres cliente con suscripción, comunícate con el equipo de asistencia.

Las transacciones máximas que puede controlar un nodo dependen de varios factores. Por lo tanto, antes de ajustar los nodos mínimos para obtener una mejor capacidad de procesamiento, te recomendamos que verifiques si tus sistemas de backend están configurados de manera óptima para controlar el tráfico requerido.

Usa la conexión de Confluence en una integración

Después de crear la conexión, estará disponible en la integración de Apigee y en la Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

• Para comprender cómo crear y usar la tarea Connectors en la integración de Apigee, consulta Tarea Connectors.
• Para comprender cómo crear y usar la tarea Connectors en Application Integration, consulta Tarea Connectors.

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

Nota: Puedes ver las entidades, operaciones y acciones de un conector en la tarea de conectores.

• Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

  Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

• Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Lista
  • Obtén
  • Crear
  • Actualizar
  • Borrar

  Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, estas operaciones no compatibles no se incluyen en la lista Operations.

• Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Por lo general, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Nota: Todas las entidades y acciones tendrán un esquema asociado. Por ejemplo, un esquema de acción tendrá los detalles de los parámetros, como los nombres de los parámetros y su tipo de datos correspondiente. La conexión recupera el esquema (metadatos) de las entidades y las acciones durante el tiempo de ejecución desde tu backend. Si hay actualizaciones en el esquema, estas no se reflejarán automáticamente en tus conexiones existentes. Debes actualizar el esquema de forma manual. Para actualizar el esquema de una conexión, abre la página Detalles de la conexión de la conexión y, luego, haz clic en Actualizar esquema de conexión.

Acciones

El conector de Confluence proporciona acciones como DownloadAttachment y UploadAttachment. Para comprender cómo configurar las acciones, consulta Ejemplos de acciones.

Ejemplos de acciones

En esta sección, se describe cómo realizar algunas de las acciones de este conector.

Ejemplo: Descargar archivo adjunto

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción DownloadAttachment y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

     {
       "AttachmentId": "xyz"
     }

Ejemplos de operaciones de entidades

Ejemplo: Muestra todas las solicitudes

En este ejemplo, se enumeran todas las solicitudes de la entidad Requests.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Solicitudes en la lista Entity.
3. Selecciona la operación LIST y haz clic en Listo.

Ejemplo: Cómo obtener un usuario a partir de un ID de cuenta específico

En este ejemplo, se obtiene el usuario con AccoundId como 6035864ce2020c0070b5285b de la entidad Users.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Users en la lista Entity.
3. Selecciona la operación LIST y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en filterClause y, luego, ingresa AccountId=6035864ce2020c0070b5285b en el campo Default Value.

   Aquí, AccountId es el valor de clave primaria de la entidad Users.

Ejemplo: Páginas de lista

En este ejemplo, se muestran las páginas de la entidad Pages.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Pages en la lista Entity.
3. Selecciona la operación LIST y haz clic en Listo.

Ejemplo: Get Pages

En este ejemplo, se obtiene un registro de página de la entidad Pages.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Pages en la lista Entity.
3. Selecciona la operación GET y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en entityId y, luego, ingresa 123 en el campo Default Value.

   Aquí, 123 es un identificador único para la entidad Pages del recurso.

Ejemplo: Crea páginas

En este ejemplo, se crea un registro de página en la entidad Pages.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Pages en la lista Entity.
3. Selecciona la operación CREATE y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

   {
         "SpaceId": "12345",
         "Status": "Current",
         "Title": "FROM XYZ",
         "Storage": "XYZ1234"
       }
   

Example - Update Pages

This example updates a page record in the Pages entity.

1. In the Configure connector task dialog, click Entities.
2. Select Pages from the Entity list.
3. Select the UPDATE operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
       "Title": "Update abc"
       }

5. En la sección Task Input de la tarea Connectors, haz clic en entityId y, luego, ingresa 12345 en el campo Default Value.

Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá la respuesta de la operación de actualización.

{
    "Id": 1234
    }

Ejemplo: Borra una página

En este ejemplo, se borra una página de la entidad Pages.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Pages en la lista Entity.
3. Selecciona la operación DELETE y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en entityId y, luego, ingresa 123 en el campo Default Value.

   Como alternativa, si la entidad tiene claves primarias compuestas en lugar de especificar entityId, puedes establecer filterClause. Por ejemplo, Id='123'.

Usa Terraform para crear conexiones

Puedes usar el recurso de Terraform para crear una conexión nueva.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.

Para ver una plantilla de Terraform de ejemplo para la creación de conexiones, consulta la plantilla de ejemplo.

Cuando crees esta conexión con Terraform, debes establecer las siguientes variables en tu archivo de configuración de Terraform:

Nombre del parámetro	Tipo de datos	Obligatorio	Descripción
proxy_enabled	BOOLEAN	Falso	Selecciona esta casilla de verificación para configurar un servidor proxy para la conexión.
proxy_auth_scheme	ENUM	Falso	Es el tipo de autenticación que se usará para autenticarse en el proxy de ProxyServer. Los valores admitidos son: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Es un nombre de usuario que se usará para autenticarse en el proxy de ProxyServer.
proxy_password	SECRET	Falso	Es una contraseña que se usará para autenticarse en el proxy de ProxyServer.
proxy_ssltype	ENUM	Falso	Es el tipo de SSL que se usará para conectarse al proxy de ProxyServer. Los valores admitidos son: AUTO, ALWAYS, NEVER, TUNNEL

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?

• Obtén información para suspender y reanudar una conexión.
• Obtén información para supervisar el uso de los conectores.
• Obtén información para ver los registros de los conectores.