Introducción
Los equipos de desarrollo de software utilizan diversas herramientas en su trabajo diario. El código se almacena en repositorios Git, las especificaciones en Confluence, las tareas en Jira y la comunicación cotidiana en Slack. Cada herramienta dispone de su propia función de búsqueda, pero ante la pregunta «¿dónde fue aquella discusión?», buscar individualmente en cada herramienta resulta ineficiente.
En este artículo, construiremos un hub de conocimiento que centraliza en Fess la información de las herramientas que el equipo de desarrollo utiliza a diario, permitiendo realizar búsquedas integradas.
Lectores objetivo
Líderes de equipos de desarrollo de software y responsables de infraestructura
Personas que desean realizar búsquedas transversales en herramientas de desarrollo
Personas que desean conocer el uso básico de los plugins de data store
Escenario
Habilitaremos la búsqueda integrada de la información de un equipo de desarrollo (20 personas).
Qué es el rastreo de data store
El rastreo web y el rastreo de archivos recopilan documentos siguiendo URLs o rutas de archivos. Por otro lado, para recopilar información de herramientas SaaS se utiliza el «rastreo de data store».
El rastreo de data store obtiene datos a través de la API de cada herramienta y los registra en el índice de Fess. En Fess, se proporcionan plugins de data store para cada herramienta.
Instalación de plugins
Los plugins de data store se pueden instalar desde el panel de administración de Fess.
Seleccionar [Sistema] > [Plugins] en el panel de administración
Verificar la lista de plugins instalados
Ir a la pantalla de instalación desde el botón [Instalar] e instalar los plugins necesarios desde la pestaña [Remoto]
Para el escenario de este artículo, utilizaremos los siguientes plugins.
fess-ds-git: Rastreo de repositorios Gitfess-ds-atlassian: Rastreo de Confluence / Jirafess-ds-slack: Rastreo de mensajes de Slack
Configuración de cada fuente de datos
Configuración de repositorio Git
Rastrearemos repositorios Git para incluir código y documentos como objetivos de búsqueda.
[Rastreador] > [Data Store] > [Crear nuevo]
Nombre del handler: Seleccionar GitDataStore
Configuración de parámetros
Ejemplo de configuración de parámetros
Ejemplo de configuración de scripts
En uri se especifica la URL del repositorio, y en username / password las credenciales de autenticación. Para repositorios privados, se establece un token de acceso en password. Con include_pattern se pueden filtrar las extensiones de archivo objetivo del rastreo mediante expresiones regulares.
Configuración de Confluence
Incluiremos las páginas y artículos de blog de Confluence como objetivos de búsqueda.
[Rastreador] > [Data Store] > [Crear nuevo]
Nombre del handler: Seleccionar ConfluenceDataStore
Configuración de parámetros
Ejemplo de configuración de parámetros
Ejemplo de configuración de scripts
En home se especifica la URL de Confluence y en auth_type se selecciona el método de autenticación. Para Confluence Cloud se utiliza autenticación basic, configurando el token de API en basic.password.
Configuración de Jira
Incluiremos los tickets (Issues) de Jira como objetivos de búsqueda.
Se utiliza el handler JiraDataStore incluido en el mismo plugin fess-ds-atlassian. Con JQL (Jira Query Language) se pueden filtrar los tickets objetivo del rastreo. Por ejemplo, es posible limitar el rastreo únicamente a los tickets de un proyecto específico o solo a aquellos con un estado determinado (excluyendo los cerrados).
[Rastreador] > [Data Store] > [Crear nuevo]
Nombre del handler: Seleccionar JiraDataStore
Configuración de parámetros
Ejemplo de configuración de parámetros
Ejemplo de configuración de scripts
En issue.jql se especifica la consulta JQL para filtrar los tickets objetivo del rastreo.
Configuración de Slack
Incluiremos los mensajes de Slack como objetivos de búsqueda.
[Rastreador] > [Data Store] > [Crear nuevo]
Nombre del handler: Seleccionar SlackDataStore
Configuración de parámetros
Ejemplo de configuración de parámetros
Ejemplo de configuración de scripts
En token se especifica el token OAuth del Bot de Slack. Con channels se pueden especificar los canales objetivo del rastreo; para incluir todos los canales se establece *all. Para incluir canales privados se establece include_private=true, y es necesario que el Bot haya sido invitado a dichos canales.
Uso de etiquetas
Distinguir fuentes de información con etiquetas
Al configurar etiquetas en cada fuente de datos, se permite alternar entre las fuentes de información durante la búsqueda.
code: Código de repositorios Gitdocs: Documentos de Confluencetickets: Tickets de Jiradiscussions: Mensajes de Slack
Los usuarios pueden realizar búsquedas transversales con «Todos» y filtrar por etiqueta según sea necesario.
Mejora de la calidad de búsqueda
Uso del impulso de documentos
En un hub de conocimiento para equipos de desarrollo, no todos los documentos tienen la misma importancia. Por ejemplo, se pueden considerar las siguientes prioridades.
Documentos de Confluence (especificaciones formales y manuales de procedimientos)
Tickets de Jira (problemas actuales y tareas en curso)
Repositorios Git (código y README)
Mensajes de Slack (registros de discusiones)
Con el impulso de documentos, se puede aumentar la puntuación de búsqueda de los documentos que coincidan con condiciones específicas. Desde [Rastreador] > [Impulso de documentos] en el panel de administración, se pueden configurar valores de impulso basados en patrones de URL o etiquetas.
Uso de contenido relacionado
Al mostrar «contenido relacionado» en los resultados de búsqueda, se ayuda a los usuarios a encontrar la información que necesitan. Por ejemplo, al buscar un documento de diseño en Confluence, resulta útil que los tickets de Jira relacionados se muestren como «contenido relacionado».
Consideraciones operativas
Programación del rastreo
Se configura una frecuencia de rastreo apropiada para cada fuente de datos.
Manejo de límites de tasa de API
Las API de herramientas SaaS tienen límites de tasa. Se deben configurar intervalos de rastreo apropiados para no exceder los límites de tasa de la API. En particular, la API de Slack tiene límites de tasa estrictos, por lo que es importante dejar un margen en los intervalos de rastreo.
Gestión de tokens de acceso
La configuración de los plugins de data store requiere tokens de acceso a la API de cada herramienta. Desde el punto de vista de la seguridad, tenga en cuenta los siguientes aspectos.
Principio de mínimo privilegio: Utilizar tokens de acceso de solo lectura
Rotación periódica: Actualizar los tokens regularmente
Uso de cuentas dedicadas: Utilizar cuentas de servicio en lugar de cuentas personales
Resumen
En este artículo, construimos un hub de conocimiento que centraliza en Fess la información de las herramientas que el equipo de desarrollo utiliza a diario, permitiendo realizar búsquedas integradas.
Recopilación de datos de Git, Confluence, Jira y Slack mediante plugins de data store
Experiencia de búsqueda amigable para desarrolladores mediante etiquetas
Control de la prioridad de la información con impulso de documentos
Consideraciones operativas como límites de tasa de API y gestión de tokens
Con el hub de conocimiento del equipo de desarrollo, se logra un entorno donde es posible responder rápidamente a preguntas como «¿dónde fue aquella discusión?» o «donde esta esa especificación?».
En el próximo artículo, abordaremos la búsqueda transversal en almacenamiento en la nube.