Jira - 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.

Jira

Jira es una herramienta de gestión de proyectos para el desarrollo de software, la gestión de productos y el seguimiento de errores. Puedes usarlo Amazon Kendra para indexar tus proyectos, incidencias, comentarios, archivos adjuntos, registros de trabajo y estados de Jira.

Amazon Kendraactualmente solo es compatible con Jira Cloud.

Puedes conectarte Amazon Kendra a tu fuente de datos de Jira mediante la Amazon Kendraconsola o la JiraConfiguration API. Para ver una lista de las características admitidas por cada una, consulte Características admitidas.

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

Características admitidas

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

  • Asignaciones de campos

  • Control de acceso de usuarios

  • Filtros de inclusión/exclusión

  • Sincronizaciones completas e incrementales del contenido

  • Nube privada virtual (VPC)

Requisitos previos

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

En Jira, asegúrese de que:

  • Ha configurado credenciales de autenticación del token de la API que incluyen un ID de Jira (nombre de usuario o correo electrónico) y una credencial de Jira (token de la API de Jira). Consulte la Documentación de Atlassian sobre la administración de los tokens de API.

    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).

  • Ha apuntado la URL de la cuenta de Jira en la configuración de su cuenta de Jira. Por ejemplo, https://company.atlassian.net/.

  • Ha comprobado que cada documento es único en Jira 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. IDs Los documentos son globales en relación con un índice y deben ser únicos por índice.

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 Jira 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 existentes, puedes usar la consola para crear un nuevo IAM rol y un Secrets Manager secreto al conectar tu fuente de datos de Jira. 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 Jira, debes proporcionar los detalles necesarios de tu fuente de datos de Jira para que Amazon Kendra puedas acceder a tus datos. Si aún no has configurado Jira paraAmazon Kendra, consulta. Requisitos previos

Console

Para conectarse Amazon Kendra a Jira

  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 Jira y, a continuación, seleccione Agregar conector. Si usa la versión 2 (si corresponde), elija el Conector de Jira 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. URL de la cuenta de Jira: introduzca la URL de su cuenta de Jira. Por ejemplo: https://company.atlassian.net/.

    2. 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.

    3. AWS Secrets Managersecreto: elige un secreto existente o crea uno nuevo para almacenar tus Secrets Manager credenciales de autenticación de Jira. 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-Jira» se añade automáticamente a tu nombre secreto.

        2. En ID de Jira: introduzca el nombre de usuario o el correo electrónico de Jira.

        3. En Contraseña/token: introduzca el token de la API de Jira configurado en Jira.

      2. Guarde y agregue el secreto.

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

    5. 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 tiene una ACL para sus documentos y decide utilizarla, también puede optar por activar el rastreador de identidades para configurar el filtrado Amazon Kendra de los resultados de búsqueda según el contexto del 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.

    6. 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.

    7. Elija Siguiente.

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

    1. Seleccionar qué proyectos de Jira se van a indexar: elija rastrear todos los proyectos o proyectos específicos.

    2. Configuración adicional: especifique determinados estados y tipos de problemas. Elija rastrear los comentarios, los archivos adjuntos y los registros de trabajo. Utilice patrones de expresiones regulares para incluir o excluir contenido determinado.

    3. Modo de sincronización: elija cómo desea actualizar el índice cuando cambie el contenido del origen de datos. Al sincronizar la 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.

      • 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 de lo nuevo y modificado: se indexa solo el contenido nuevo y modificado cada vez que el origen de datos se sincroniza con el índice. Amazon Kendra puede utilizar el mecanismo del origen de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido modificado desde la última sincronización.

      • 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. Campos de fuente de datos predeterminados: seleccione entre los campos de fuente de datos predeterminados Amazon Kendra generados que desee asignar a su í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 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 Amazon Kendra a Jira

Debes especificar lo siguiente mediante la JiraConfiguration API:

  • URL del origen de datos: especifique la URL de su cuenta de Jira. Por ejemplo, company.atlassian.net.

  • 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 de tu cuenta de Jira. El secreto se almacena en una estructura JSON con las siguientes claves:

    {
    "jiraId": "Jira user name or email",
    "jiraCredential": "Jira API token"
}

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

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

  • Nube privada virtual (VPC): especifique VpcConfiguration como parte de la configuración del origen de datos. Consulte Configuración de Amazon Kendra para utilizar una VPC.

  • Registro de cambios: si Amazon Kendra debe utilizar el mecanismo de registro de cambios del origen de datos de Jira para determinar si un documento debe actualizarse en el índice.

    nota

    Utilice el registro de cambios si no quiere que Amazon Kendra digitalice todos los documentos. Si tu registro de cambios es grande, es posible que tardes Amazon Kendra menos en escanear los documentos de la fuente de datos de Jira que en procesar el registro de cambios. Si está sincronizando el origen de datos de Jira con su índice por primera vez, se escanean todos los documentos.

  • Filtros de inclusión y exclusión: puede especificar si desea incluir o excluir determinados archivos.

    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.

  • Comentarios, archivos adjuntos y registros de trabajo: puede especificar si desea rastrear determinados comentarios, archivos adjuntos y registros de trabajo de los problemas.

  • Proyectos, problemas y estados: puedes especificar si deseas rastrear determinados proyectos IDs, tipos de problemas y estados.

  • Filtrado de contexto de usuario y control de acceso: si hay una lista de control de acceso (ACL) para los documentos, Amazon Kendra la rastreará. 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.

  • Asignaciones de campos: elija asignar los campos del origen de datos de Jira 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 los 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.

Más información

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