Confluence Connector V1.0 - Amazon Kendra
Características admitidasRequisitos previosInstrucciones de conexiónMás información

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Confluence Connector V1.0

Confluence es una herramienta colaborativa de gestión del trabajo diseñada para compartir, almacenar y trabajar en la planificación de proyectos, el desarrollo de software y la gestión de productos. Puedes usarlo Amazon Kendra para indexar tus espacios de Confluence, páginas (incluidas las páginas anidadas), blogs y comentarios y archivos adjuntos de páginas y blogs indexados.

nota

El conector V1.0 de Confluence finalizó en 2023. ConfluenceConfiguration API Recomendamos migrar al conector V2.0/de Confluence o usarlo. TemplateConfiguration API

Para solucionar problemas del conector de fuente de datos de Amazon Kendra Confluence, consulte. Solución de problemas con los orígenes de datos

Características admitidas

Amazon Kendra El conector de fuente de datos de Confluence admite las siguientes funciones:

  • Asignaciones de campo

  • Control de acceso de usuarios

  • Filtros de inclusión/exclusión

  • (Solo para Confluence Server) Nube privada virtual () VPC

Requisitos previos

Antes de poder utilizarla Amazon Kendra para indexar tu fuente de datos de Confluence, realiza estos cambios en tu Confluence y en tus cuentas. AWS

En Confluence, asegúrese de que:

  • Has concedido Amazon Kendra permisos para ver todo el contenido de tu instancia de Confluence de la siguiente manera:

    • Convirtiéndose Amazon Kendra en miembro de un confluence-administrators grupo.

    • Ha otorgado permisos de administrador del sitio para todos los espacios, blogs y páginas existentes.

  • Copiaste la URL de tu instancia de Confluence.

  • Para los usuarios SSO (inicio de sesión único): se activó la página Mostrar al iniciar sesión para el nombre de usuario y la contraseña al configurar los métodos de autenticación de Confluence en Confluence Data Center.

  • Para Confluence Server

    • Ha apuntado sus credenciales de autenticación básica, que incluyen el nombre de usuario y la contraseña de su cuenta administrativa de Confluence para conectarse a Amazon Kendra.

      nota

      Le recomendamos que actualice o modifique con regularidad las credenciales y el secreto. Por su propia seguridad, proporcione solo el nivel de acceso necesario. No se recomienda volver a utilizar las credenciales y los datos secretos en varios orígenes de datos ni en las versiones 1.0 y 2.0 del conector (si procede).

    • Opcional: ha generado un token de acceso personal en la cuenta de Confluence para conectarse a Amazon Kendra. Para obtener más información, consulte la Documentación de Confluence sobre la generación de tokens de acceso personal.

  • Para Confluence Cloud

    • Ha apuntado sus credenciales de autenticación básica, que incluyen el nombre de usuario y la contraseña de su cuenta administrativa de Confluence para conectarse a Amazon Kendra.

  • Ha comprobado que cada documento es único en Confluence y en otros orígenes de datos que vaya a utilizar para el mismo índice. Cada origen de datos que desee utilizar para un índice no debe contener el mismo documento en varios orígenes de datos. IDsLos documentos son globales para un índice y deben ser únicos por índice.

En el tuyo Cuenta de AWS, asegúrate de tener:

  • Creó un Amazon Kendra índice y, si lo usaAPI, anotó el ID del índice.

  • Creó un IAM rol para la fuente de datos yAPI, si lo usó, anotó el ARN IAM rol.

    nota

    Si cambias el tipo de autenticación y las credenciales, debes actualizar tu IAM rol para acceder al ID AWS Secrets Manager secreto correcto.

  • Guardaste tus credenciales de autenticación de Confluence en un AWS Secrets Manager secreto y, si las API usaste, ARN anotaste el secreto.

    nota

    Le recomendamos que actualice o modifique con regularidad las credenciales y el secreto. Por su propia seguridad, proporcione solo el nivel de acceso necesario. No se recomienda volver a utilizar las credenciales y los datos secretos en varios orígenes de datos ni en las versiones 1.0 y 2.0 del conector (si procede).

Si no tienes un IAM rol o secreto existente, puedes usar la consola para crear un nuevo IAM rol y un Secrets Manager secreto al conectar tu fuente de datos de Confluence. Amazon Kendra Si utilizas elAPI, debes proporcionar el IAM rol y el ARN Secrets Manager secreto existentes, así como un ID de índice.

Instrucciones de conexión

Para conectarte Amazon Kendra a tu fuente de datos de Confluence, debes proporcionar los detalles de tus credenciales de Confluence para Amazon Kendra poder acceder a tus datos. Si aún no has configurado Confluence para consultarlo. Amazon Kendra Requisitos previos

Console

Para conectarse a Amazon Kendra Confluence

  1. Inicia sesión en la consola AWS de administración y abre la Amazon Kendra consola.

  2. En el panel de navegación izquierdo, elija Índices y, a continuación, elija el índice que desee usar de la lista de índices.

    nota

    Puede elegir configurar o editar los ajustes de Control de acceso de usuarios en la Configuración del índice.

  3. En la página Introducción, seleccione Agregar origen de datos.

  4. En la página Agregar origen de datos, elija el Confluence Connector V1.0 y, a continuación, elija Agregar origen de datos.

  5. En la página Especificar detalles del origen de datos, introduzca la siguiente información:

    1. En Nombre y descripción, en Nombre del origen de datos: introduzca un nombre para el origen de datos. Puede incluir guiones, pero no espacios.

    2. (Opcional) Descripción: introduzca una descripción opcional para el origen de datos.

    3. En el idioma predeterminado: elija un idioma para filtrar los documentos para el índice. A menos que especifique lo contrario, el idioma predeterminado es el inglés. El idioma especificado en los metadatos del documento anula el idioma seleccionado.

    4. En Etiquetas, para añadir una nueva etiqueta: incluya etiquetas opcionales para buscar y filtrar sus recursos o realizar un seguimiento de sus AWS costes.

    5. Elija Next (Siguiente).

  6. En la página Definir acceso y seguridad, introduzca la siguiente información:

    1. Elige entre Confluence Cloud y Confluence Server.

    2. Si eliges Confluence Cloud, introduce la siguiente información:

      1. ConfluenceURL: tu Confluence. URL

      2. AWS Secrets Manager secreto: elige un secreto existente o crea uno nuevo para almacenar tus credenciales de Secrets Manager autenticación de Confluence. Si decide crear un secreto nuevo, se abrirá una ventana de secreto de AWS Secrets Manager .

        1. Introduzca la siguiente información en la ventana Crear un secreto de AWS Secrets Manager :

          1. Nombre del secreto: un nombre para su secreto. El prefijo «AmazonKendra-Confluence» se añade automáticamente a tu nombre secreto.

          2. Para el nombre de usuario y la contraseña: introduce tu nombre de usuario y contraseña de Confluence.

          3. Seleccione Guardar autenticación.

    3. Si eliges Confluence Server, introduce la siguiente información:

      1. Confluence URL: tu nombre de usuario y contraseña de Confluence.

      2. (Opcional) Para el Proxy web, introduzca la siguiente información:

        1. Nombre de host: nombre de host de su cuenta de Confluence.

        2. Número de puerto: puerto utilizado por el protocolo de transporte del host. URL

      3. Para la autenticación, elige la autenticación básica o el token de acceso personal (solo para el servidor de Confluence).

      4. AWS Secrets Manager secreto: elige un secreto existente o crea uno nuevo para almacenar tus Secrets Manager credenciales de autenticación de Confluence. Si decide crear un secreto nuevo, se abrirá una ventana de secreto de AWS Secrets Manager .

        1. Introduzca la siguiente información en la ventana Crear un secreto de AWS Secrets Manager :

          1. Nombre del secreto: un nombre para su secreto. El prefijo «AmazonKendra-Confluence» se añade automáticamente a tu nombre secreto.

          2. Para el nombre de usuario y la contraseña: introduce los valores de las credenciales de autenticación que configuraste en Confluence. Si utilizas la autenticación básica, utiliza tu nombre de usuario (ID de correo electrónico) y contraseña (token) de Confluence. API Si utilizas un token de acceso personal, introduce los detalles del token de acceso personal que configuraste en la cuenta de Confluence.

          3. Guarda y añade tu secreto.

    4. IAM rol: elige un IAM rol existente o crea uno nuevo IAM para acceder a las credenciales del repositorio y al contenido del índice.

      nota

      IAM los roles utilizados para los índices no se pueden usar para las fuentes de datos. Si no está seguro de si se utiliza un rol existente para un índiceFAQ, o bien, elija Crear un nuevo rol para evitar errores.

    5. Elija Next (Siguiente).

  7. En la página Configurar ajustes de sincronización, introduzca la siguiente información:

    1. En Incluir espacios personales e Incluir espacios archivados: elija los tipos de espacio opcionales que desee incluir en este origen de datos.

    2. En Configuración adicional: especifique los patrones de expresión regular para incluir o excluir cierto contenido. Puede agregar hasta 100 patrones.

    3. También puede elegir Rastrear archivos adjuntos dentro de los espacios elegidos.

    4. En Sincronizar el programa de ejecución, para Frecuencia: elija la frecuencia con la Amazon Kendra que se sincronizará con la fuente de datos.

    5. Elija Next (Siguiente).

  8. En la página Establecer asignaciones de campos, especifique la siguiente información:

    1. Para espacio, página o blog: seleccione entre los campos de fuente de datos predeterminados Amazon Kendra generados o las asignaciones de campos sugeridas adicionales para agregar campos de índice.

    2. Agregar campo: para agregar campos de origen de datos personalizados para crear un nombre de campo de índice al que asignarlos y el tipo de datos del campo.

    3. Elija Next (Siguiente).

  9. En la página Revisar y crear, compruebe que la información que ha introducido es correcta y, a continuación, seleccione Añadir origen de datos. También puede elegir editar la información desde esta página. El origen de datos aparecerá en la página Orígenes de datos una vez que el origen de datos se haya agregado correctamente.

API

Para conectarse a Confluence Amazon Kendra

Debe especificar lo siguiente mediante ConfluenceConfigurationAPI:

  • Versión de Confluence: especifique la versión de la instancia de Confluence que está utilizando como CLOUD o SERVER.

  • Nombre de recurso secreto de Amazon (ARN): proporciona el nombre de recurso de Amazon (ARN) de un Secrets Manager secreto que contenga tus credenciales de autenticación de Confluence.

    Si utilizas Confluence Server, puedes usar tu nombre de usuario y contraseña de Confluence o tu token de acceso personal como credenciales de autenticación.

    Si utilizas tu nombre de usuario y contraseña de Confluence como credenciales de autenticación, guardas las siguientes credenciales como una JSON estructura secreta: Secrets Manager 

    {
    "username": "user name",
    "password": "password"
}

    Si utilizas un token de acceso personal para conectarte a Confluence Server Amazon Kendra, guardas las siguientes credenciales como una JSON estructura en tu Secrets Manager secreto:

    {
    "patToken": "personal access token"
}

    Si utilizas Confluence Cloud, utilizas tu nombre de usuario de Confluence y un API token, configurado en Confluence, como contraseña. Almacenas las siguientes credenciales como una JSON estructura en tu secreto: Secrets Manager 

    {
    "username": "user name",
    "password": "API token"
}

  • IAM rol: especifica RoleArn cuándo llamas CreateDataSource para proporcionar un IAM rol con permisos para acceder a tu Secrets Manager secreto y para llamar al público requerido APIs para el conector de Confluence y. Amazon Kendra Para obtener más información, consulte Roles de IAM para orígenes de datos de Confluence.

También puede añadir las siguientes características opcionales:

  • Proxy web: si deseas conectarte a tu URL instancia de Confluence mediante un proxy web. Puede utilizar esta opción para Confluence Server.

  • (Solo para Confluence Server) Nube privada virtual (VPC): especifícala VpcConfiguration como parte de la configuración de la fuente de datos. Consulte Configurar Amazon Kendra para usar un. VPC

  • Filtros de inclusión y exclusión: especifique patrones de expresiones regulares para incluir o excluir determinados espacios, publicaciones de blog, páginas y archivos adjuntos. Si decide indexar los archivos adjuntos, solo se indexarán los adjuntos de las páginas y blogs indexados.

    nota

    La mayoría de los orígenes de datos utilizan patrones de expresiones regulares, que son patrones de inclusión o exclusión denominados filtros. Si especifica un filtro de inclusión, solo se indexará el contenido que coincida con el filtro de inclusión. Los documentos que no coincidan con el filtro de inclusión no se indexan. Si especifica un filtro de inclusión y exclusión, los documentos que coincidan con el filtro de exclusión no se indexarán, aunque coincidan con el filtro de inclusión.

  • Asignaciones de campos: elija asignar los campos del origen de datos de Confluence a los campos de índice de Amazon Kendra . Para obtener más información, consulte Asignación de campos de origen de datos.

    nota

    El campo del cuerpo del documento o el cuerpo del documento equivalente de sus documentos es obligatorio Amazon Kendra para poder buscarlos. Debe asignar el nombre del campo del cuerpo del documento en la fuente de datos al nombre del campo de índice_document_body. Todos los demás campos son opcionales.

  • Filtrado por contexto de usuario y control de acceso:Amazon Kendra rastrea la lista de control de acceso (ACL) de sus documentos, si tiene una lista ACL de sus documentos. La ACL información se utiliza para filtrar los resultados de la búsqueda en función del acceso del usuario o su grupo a los documentos. Para obtener más información, consulte Filtrado de contexto de usuario.

Más información

Para obtener más información sobre la integración Amazon Kendra con tu fuente de datos de Confluence, consulta: