Confluence Connector V2.0 - Amazon Kendra
Características admitidasRequisitos previosInstrucciones de conexió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 V2.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, páginas (incluidas las páginas anidadas), blogs, comentarios y archivos adjuntos de páginas y blogs indexados de Confluence.

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

Características admitidas

Amazon KendraEl conector de fuente de datos de Confluence admite las siguientes funciones:

  • Asignaciones de campos

  • Control de acceso de usuarios

  • Patrones de inclusión/exclusión

  • Sincronizaciones completas e incrementales del contenido

  • Nube privada virtual (VPC)

Requisitos previos

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

En Confluence, asegúrese de que:

  • Ha copiado la URL de la instancia de Confluence. Por ejemplo:https://example.confluence.com, ohttps://www.example.confluence.com/, o. https:// atlassian.net/ La URL de la instancia de Confluence se debe conectar a Amazon Kendra.

    Si utilizas Confluence Cloud, la URL de tu host debe terminar en. atlassian.net/

    nota

    No se admiten los siguientes formatos de URL:

    • https://example.confluence.com/xyz

    • https://www.example.confluence.com//wiki/spacekey/xxx

    • https://atlassian.net/xyz

    nota

    (local o en el servidor) Amazon Kendra comprueba si la información de punto final incluida AWS Secrets Manager es la misma que la información de punto final especificada en los detalles de configuración de la fuente de datos. Esto ayuda a evitar el problema del suplente confuso, que es un problema de seguridad en el que un usuario no tiene permiso para realizar una acción, pero utiliza Amazon Kendra como proxy para acceder al secreto configurado y realizar la acción. Si más adelante cambia la información de punto de conexión, debe crear un nuevo secreto para sincronizar esta información.

  • Configure las credenciales de autenticación básica que contienen un nombre de usuario (ID de correo electrónico para iniciar sesión en Confluence) y una contraseña (token de API de Confluence como contraseña). Consulte Administración de tokens de API para la cuenta de Atlassian.

    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: credenciales OAuth 2.0 configuradas que contienen una clave de aplicación de Confluence, un secreto de la aplicación de Confluence, un token de acceso de Confluence y un token de actualización de Confluence para poder conectarte a tu instancia de Confluence. Amazon Kendra Si el token de acceso caduca, puede usar el token de actualización para regenerar el token de acceso y actualizar el par de tokens. También puede repetir el proceso de autorización. Para obtener más información sobre los tokens de acceso, consulta Administrar los tokens de acceso. OAuth

  • (Solo para Confluence Server/Data Center) Opcional: se configuró un token de acceso personal (PAT) en Confluence. Consulte Uso de tokens de acceso personal.

En el tuyoCuenta de AWS, asegúrate de tener:

  • Creó un Amazon Kendra índice y, si usa la API, anotó el ID del índice.

  • Creó un IAM rol para su fuente de datos y, si usa la API, anotó el ARN del 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.

  • Ha guardado sus credenciales de autenticación de Confluence en un secreto de AWS Secrets Manager y, si utiliza la API, ha anotado el ARN del 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 un 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 utiliza la API, debe proporcionar el ARN de un IAM rol y un Secrets Manager secreto existentes y un ID de índice.

Instrucciones de conexión

Para conectarte Amazon Kendra a tu fuente de datos de Confluence, debes proporcionar los detalles necesarios de tu fuente de datos de Confluence para que Amazon Kendra puedas 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 Amazon Kendraconsola Consola de administración de AWS y ábrela.

  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, seleccione el Conector de Confluence y, a continuación, seleccione Agregar conector. Si usa la versión 2 (si corresponde), elija el Conector de Confluence con la etiqueta “V2.0”.

  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 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: incluye etiquetas opcionales para buscar y filtrar tus recursos o realizar un seguimiento de tus AWS costes.

    5. Elija Siguiente.

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

    1. En Fuente, selecciona Confluence Cloud o Confluence Center. Server/Data

    2. URL de Confluence: introduzca la URL del host de Confluence. Por ejemplo, https://example.confluence.com.

    3. Ubicación del certificado SSL (solo para Confluence Server/Data Center): opcional: introduce la Amazon S3 ruta del archivo de certificado SSL para Confluence Server.

    4. (Solo para Confluence Server/Data Center) Proxy web: opcional: introduce el nombre del servidor del proxy web (sin el https:// protocolo http:// OR) y el número de puerto (puerto utilizado por el protocolo de transporte de URL del host). El número de puerto debe ser un valor numérico entre 0 y 65535.

    5. Autorización: active o desactive la información de la lista de control de acceso (ACL) para los documentos, si tiene una ACL y desea usarla para el control de acceso. La ACL especifica a qué documentos pueden acceder los usuarios y los grupos. La información de la ACL se utiliza para filtrar los resultados de 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.

    6. Autenticación: elige entre la autenticación básica, la autenticación Oauth 2.0 o (solo para Confluence Server/Data Center) la autenticación mediante token de acceso personal.

    7. Secreto de AWS Secrets Manager: elija un secreto existente o cree un nuevo secreto de Secrets Manager para almacenar sus credenciales de autenticación de Confluence. Si decide crear un secreto nuevo, se abrirá una ventana de secreto de AWS Secrets Manager. En la ventana, introduzca la siguiente información:

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

      2. Si usa la autenticación básica: introduzca el nombre de secreto, el nombre de usuario y la contraseña (el token de la API de Confluence es la contraseña) que ha configurado en Confluence.

        Si utilizas la autenticación OAuth2 .0: introduce el nombre secreto, la clave de la aplicación, el secreto de la aplicación, el token de acceso y el token de actualización que configuraste en Confluence.

        (Solo en Confluence Server/Data Center) Si utilizas la autenticación con token de acceso personal: introduce el nombre secreto y el token de Confluence que configuraste en tu Confluence.

      3. Guarde y agregue el secreto.

    8. Nube privada virtual (VPC): puede optar por utilizar una VPC. Si es así, debe agregar Subredes y Grupos de seguridad de VPC.

    9. Rastreador de identidades: especifique si se debe activar el rastreador de identidades de Amazon Kendra. El rastreador de identidades utiliza la información de la lista de control de acceso (ACL) de los documentos para filtrar los resultados de la búsqueda en función del acceso del usuario o del grupo a los documentos. Si tienes una ACL para tus documentos y decides utilizarla, también puedes optar por activar el rastreador de identidades para configurar el filtrado Amazon Kendra de los resultados de búsqueda por contexto de usuario. De lo contrario, si el rastreador de identidades está desactivado, todos los documentos se pueden buscar públicamente. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar información de acceso de usuarios y grupos para filtrar el contexto de los usuarios.

    10. IAMrol: elija un IAM rol existente o cree uno nuevo IAM para acceder a las credenciales del repositorio y al contenido del índice.

      nota

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

    11. Elija Siguiente.

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

    1. En Ámbito de sincronización, en Sincronizar contenido: elija sincronizar desde los siguientes tipos de contenido: páginas, comentarios de página, archivos adjuntos de página, blogs, comentarios de blog, archivos adjuntos de blog, espacios personales y espacios archivados.

      nota

      Los comentarios de página y los archivos adjuntos de página solo se pueden seleccionar si elige sincronizar las Páginas. Los comentarios de blog y los archivos adjuntos de blog solo se pueden seleccionar si elige sincronizar los Blogs.

      importante

      Si no especifica un patrón de regex de la tecla espacio en la Configuración adicional, se rastrearán todas las páginas y blogs de forma predeterminada.

    2. En Configuración adicional, en Tamaño máximo de archivo: especifique el límite de tamaño de archivo MBs que se Amazon Kendra rastreará. Amazon Kendrarastreará solo los archivos que se encuentren dentro del límite de tamaño que usted defina. El tamaño de archivo predeterminado es de 50 MB. El tamaño máximo del archivo debe ser mayor que 0 MB y menor o igual que 50 MB.

      En Patrones de regex de espacios: especifique si desea incluir o excluir espacios específicos del índice mediante:

      • Tecla espaciadora (por ejemplo,my-space-123)

        nota

        Si no especifica un patrón de regex de la tecla de espacio, se rastrearán todas las páginas y blogs de forma predeterminada.

      • URL (por ejemplo,.*/MySite/MyDocuments/)

      • Tipo de archivo (por ejemplo,.*\.pdf, .*\.txt)

      En Patrones de regex de títulos de entidades: especifique patrones de expresiones regulares para incluir o excluir determinados blogs, páginas, comentarios y archivos adjuntos por título.

      nota

      Si quiere incluir o excluir el rastreo de una página o subpágina específica, puede usar los patrones de regex del título de la página.

    3. Modo de sincronización: elija cómo desea actualizar el índice cuando cambie el contenido del origen de datos. Al sincronizar el origen de datos con Amazon Kendra por primera vez, todo el contenido se rastrea y se indexa de forma predeterminada. Debe ejecutar una sincronización completa de los datos si la sincronización inicial falló, incluso si no selecciona la sincronización completa como opción de modo de sincronización.

      • Sincronización completa: se vuelve a indexar todo el contenido, reemplazando el contenido existente cada vez que el origen de datos se sincronice con el índice.

      • Sincronización nueva, modificada o eliminada: indexe solo el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendrapuede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

    4. En Programación de ejecución de sincronización, en Frecuencia: elija la frecuencia con la que desea sincronizar el contenido del origen de datos y actualizar el índice.

    5. Elija Siguiente.

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

    1. Seleccione uno de los campos de fuente de datos predeterminados Amazon Kendra generados que desee asignar a su índice. Para agregar campos de origen de datos personalizados, cree un nombre de campo de índice para asignarlos y el tipo de datos del campo.

    2. Elija 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 conectarte Amazon Kendra a Confluence

Debe especificar un JSON del esquema del origen de datos mediante la API TemplateConfiguration. Debe proporcionar la siguiente información:

  • Origen de datos: defina el tipo de origen de datos como CONFLUENCEV2 cuando utilice el esquema JSON TemplateConfiguration. Además, defina el origen de datos como TEMPLATE al llamar a la API CreateDataSource.

  • URL del host: especifique la instancia de URL del host de Confluence. Por ejemplo, https://example.confluence.com.

  • Modo de sincronización: especifique cómo Amazon Kendra debe actualizar el índice cuando cambie el contenido del origen de datos. Cuando sincronizas tu fuente de datos Amazon Kendra por primera vez, todo el contenido se rastrea e indexa de forma predeterminada. Debe ejecutar una sincronización completa de los datos si la sincronización inicial falló, incluso si no selecciona la sincronización completa como opción de modo de sincronización. Puede elegir entre las siguientes opciones:

    • FORCED_FULL_CRAWL para volver a indexar todo el contenido, reemplazando el contenido existente cada vez que el origen de datos se sincronice con el índice.

    • FULL_CRAWLpara indexar solo el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendrapuede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • Tipo de autenticación: especifique el tipo de autenticación, ya sea Basic, OAuth2 o Personal-token (solo Confluence Server).

  • (Opcional, solo para Confluence Server) Ubicación del certificado SSL: especifique el S3bucketName y s3certificateName que utilizó para almacenar su certificado SSL.

  • Nombre secreto de recurso de Amazon (ARN): proporciona el nombre de recurso de Amazon (ARN) de un Secrets Manager secreto que contenga las credenciales de autenticación que configuraste en Confluence. Si utiliza la autenticación básica, el secreto se almacena en una estructura JSON con las siguientes claves: 

    {
    "username": "email ID or user name",
    "password": "Confluence API token"
}

    Si utilizas la autenticación OAuth 2.0, el secreto se almacena en una estructura JSON con las siguientes claves:

    {
    "confluenceAppKey": "app key",
    "confluenceAppSecret": "app secret",
    "confluenceAccessToken": "access token",
    "confluenceRefreshToken": "refresh token"
}

    (Solo para el servidor Confluence) Si utiliza la autenticación básica, el secreto se almacena en una estructura JSON con las siguientes claves:

    {
    "hostUrl": "Confluence Server host URL",
    "username": "Confluence Server user name",
    "password": "Confluence Server password"
}

    (Solo para el servidor Confluence) Si utiliza la autenticación con token de acceso personal, el secreto se almacena en una estructura JSON con las siguientes claves:

    {
    "hostUrl": "Confluence Server host URL",
    "patToken": "personal access token"
}

  • IAMrol: especifica RoleArn cuándo llamas CreateDataSource para proporcionar a un IAM rol 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:

  • Nube privada virtual (VPC): especifique a VpcConfiguration cuándo llamar a CreateDataSource. Para obtener más información, consulte ¿Se está configurando Amazon Kendra para usar un Amazon VPC.

  • Tamaño de archivo: especifique el tamaño de archivo máximo que se va a rastrear.

  • Tipos de documento o contenido: especifique si se van a rastrear las páginas, los comentarios de página, los archivos adjuntos de página, los blogs, los comentarios de blog, los archivos adjuntos de blog, espacios y los espacios archivados.

  • Filtros de inclusión y exclusión: especifique si desea incluir o excluir determinados espacios, páginas o blogs y sus comentarios y archivos adjuntos.

    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.

  • Proxy web: especifique la información de su proxy web si desea conectarse a la instancia de la URL de Confluence a través de un proxy web. Puede utilizar esta opción para Confluence Server.

  • Lista de control de acceso (ACL): especifique si se va a rastrear la información de la ACL para los documentos, si tiene una ACL y desea usarla para el control de acceso. La ACL especifica a qué documentos pueden acceder los usuarios y los grupos. La información de la ACL se utiliza para filtrar los resultados de 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.

  • Rastreador de identidades: especifique si se debe activar el rastreador de identidades de Amazon Kendra. El rastreador de identidades utiliza la información de la lista de control de acceso (ACL) de los documentos para filtrar los resultados de la búsqueda en función del acceso del usuario o del grupo a los documentos. Si tienes una ACL para tus documentos y decides utilizarla, también puedes optar por activar el rastreador de identidades para configurar el filtrado Amazon Kendra de los resultados de búsqueda por contexto de usuario. De lo contrario, si el rastreador de identidades está desactivado, todos los documentos se pueden buscar públicamente. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar información de acceso de usuarios y grupos para filtrar el contexto de los usuarios.

  • 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 el origen de datos al nombre del campo del índice _document_body. Todos los demás campos son opcionales.

Para obtener una lista de otras claves JSON importantes que debe configurar, consulte el Esquema de plantilla de Confluence.

Notas

  • El token de acceso personal (PAT) no está disponible para Confluence Cloud.