Integrating OpenSearch with a Git-Based Documentation System

Abstract

This master’s thesis shows the process and results of improving the search feature of a document management system by choosing and integrating a search engine component into it. The document management system has a microservices-based architecture and is built on top of a version control system instead of a conventional database. The version control system has very strict controls on the documentation data being searched, and managing access control became important to the success of the project. These architectural choices caused additional challenges that needed to be addressed. The thesis starts by giving some context about technologies that are relevant to the problem, and then its structure follows the design research method. First, the current system is introduced to give reader motivation and sense of the problem. Requirements for the solution are created based on the current architecture, features of the application, expectations about what new features users want and the constraints set by external systems and other stakeholders. These requirements include requirements for performance, security and new features that the users would likely want to have. Based on these requirements, OpenSearch was chosen as the search engine component out of free, open-source alternatives. The selected component is analyzed and its integration into the document management system as a container is designed and implemented. This integration was tested with end-to-end tests and is confirmed to satisfy the requirements.

Tämä diplomityö esittelee prosessin ja tulokset projektista, jossa dokumentaatiojärjestelmää parannetaan valitsemalla ja integroimalla siihen uusi hakukone. Dokumentaatiojärjestelmä käyttää mikropalveluarkkitehtuuria ja on rakennettu versionhallintajärjestelmän päälle tavanomaisen tietokannan sijasta. Versionhallintajärjestelmä on asettanut tiukat rajoitukset haettavan tiedon käsittelemiselle, ja lukuoikeuksien hallinnasta tuli tärkeää projektin onnistumiselle. Tämä lisäsi uuden hakuominaisuuden suunnittelun monimutkaisuutta ja asetti sille rajoitteita. Työ alkaa viitekehyksen esittelyllä: kertomalla teknologioista, jotka ovat oleellisia ongelman ymmärtämisen kannalta. Sen jälkeen sen rakenne noudattaa suunnittelututkimus-tutkimusmenetelmää. Ensin nykyinen järjestelmä esitellään, jotta lukija saa motivaation ja kuvan ongelmasta. Vaatimukset ratkaisulle luodaan järjestelmän nykyisten ominaisuuksien, nykyisen arkkitehtuurin, sekä sen perusteella, mitä ominaisuuksia käyttäjien ennakoidaan haluavan. Täytyi myös ottaa huomioon, mitä rajoituksia ulkoiset järjestelmät ja muut sidosryhmät asettavat hakukoneominaisuudelle. Vaatimuksissa on suorituskykyä, turvallisuutta ja uusia ominaisuuksia koskevia vaatimuksia. Vaatimusten perusteella hakukonekomponentiksi valittiin, joukosta ilmaisia, avoimen lähdekoodin vaihtoehtoja, OpenSearch. Valittu hakukonekomponentti analysoitiin ja sen integrointi dokumentaatiojärjestelmään suunniteltiin ja toteutettiin, ja toteutuksen toimivuus testattiin.