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 Kendra actualmente solo es compatible con Jira Cloud.

Puedes conectarte Amazon Kendra a tu fuente de datos de Jira mediante la Amazon Kendra consola 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 Kendra El conector de fuente de datos de Jira admite las siguientes funciones:

• Registro de cambios

• Asignaciones de campo

• Filtrado de contexto de usuario

• Filtros de inclusión/exclusión

• 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 creado credenciales de autenticación del token de la API de Jira 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.

• 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. Los ID de documento son globales para un índice y deben ser únicos por índice.

En la tuya Cuenta 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 para Amazon Kendra, consulta. Requisitos previos

Console

Para conectarse Amazon Kendra a Jira

1. Inicia sesión en la Amazon Kendra consola AWS Management Console 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 Añadir fuente de datos, selecciona el conector de Jira y, a continuación, selecciona Añadir conector.

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: elige 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 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. AWS Secrets Manager secreto: 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 que creó en su cuenta de Jira.

      2. Seleccione Guardar.

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

   4. IAM rol: elige un IAM rol existente o crea uno nuevo IAM para acceder a las credenciales de tu 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 un rol existente se utiliza para un índice o para las preguntas frecuentes, elija Crear un nuevo rol para evitar errores.

   5. Elija Siguiente.

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

   1. Seleccione qué proyectos de Jira desea indexar: las entidades o los tipos de contenido de Jira que quiere rastrear.

   2. Estados, Elementos adicionales y Tipos de problemas: seleccione el contenido para ajustar el ámbito del índice.

   3. Registro de cambios: seleccione esta opción para actualizar el índice en lugar de sincronizar todos los archivos.

   4. Patrones regex: patrones de expresiones regulares para incluir o excluir determinados archivos. Puede agregar hasta 100 patrones.

   5. En Programa de ejecución de sincronización, en Frecuencia: seleccione la frecuencia con la que Amazon Kendra se sincronizará con el origen de datos.

   6. Elija Siguiente.

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

   1. En Proyecto, Problema, Comentario, Archivo adjunto y Registro de trabajo: seleccione entre los campos de origen de datos predeterminados generados por Amazon Kendra 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"
  }

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

• IAM rol: especifique RoleArn cuándo llama CreateDataSource para proporcionar un IAM rol con permisos para acceder a su Secrets Manager secreto y para llamar a las API públicas requeridas 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 se Amazon Kendra debe utilizar el mecanismo de registro de cambios de la fuente 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 el registro de cambios es grande, es posible que se tarde 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: puedes especificar si deseas 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 relacionados con los problemas.

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

• Filtrado del contexto de usuario y control de acceso:Amazon Kendra rastrea la lista de control de acceso (ACL) de sus documentos, si tiene una ACL para ellos. 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 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.

Más información

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

• Busca tus proyectos de Jira de forma inteligente con el conector de Jira Cloud Amazon Kendra