diff --git a/doc/report/implementation.tex b/doc/report/implementation.tex index ef3b5fcd04f6a757a1ddcee3520a64839d114062..67cd4479d04ba697fdbf3280b7a3e7e585081c76 100644 --- a/doc/report/implementation.tex +++ b/doc/report/implementation.tex @@ -10,8 +10,9 @@ of the actual implementation for this project. With RDF files exported and available for download as Git repositories on MathHub, we have the goal of making the underlying data available -for use in applications. Figure~\ref{fig:components} illustrates the -implemented components and their relationships. +for use in applications. Let us first look at a high level overview of +all involved components. Figure~\ref{fig:components} illustrates each +component and the flow of data. \begin{figure}[]\begin{center} \includegraphics{figs/components} @@ -45,8 +46,8 @@ implemented components and their relationships. \end{itemize} Collecter, Importer and Endpoint provide us with an easy and automated -way of making RDF files ready for use with applications. We will now -take a look at the actual implementation created for +way of making RDF files available for use within applications. We will +now take a look at the actual implementation created for \emph{ulo-storage}. \subsection{Collecter and Importer}\label{sec:collecter} @@ -209,6 +210,27 @@ For \emph{ulo-storage}, we played around with both interfaces and chose whatever seemed more convenient at the moment. We recommend any implementors to do the same. -\subsection{Deployment} - -\emph{here be dragons} +\subsection{Deployment and Availability} + +\def\gorepo{https://gitlab.cs.fau.de/kissen/ulo-storage-collect} +\def\composerepo{https://gl.kwarc.info/supervision/schaertl_andreas/-/tree/master/experimental/compose} + +Software not only needs to get developed, but also deployed. To deploy +the combination of Collecter, Importer and Endpoint, we provide a +single Docker Compose file which starts three containers, namely +(1)~the Collecter/Importer web interface, (2)~a database server for +that web interface such that it can persist import jobs and finally +(3)~a GraphDB instance which provides us with the required +Endpoint. All code for Collecter and Importer is available in the +\texttt{ulo-storage-collect} Git repository\footnote{\url{\gorepo}} +Additional deployment files, that is Docker Compose and Dockerfiles +are stored in a separate repository\footnote{\url{\composerepo}}. + +This concludes our discussion of the implementation developed for the +\emph{ulo-storage} project. We designed a system based around (1)~a +Collecter which collects RDF triplets from third party sources, (2)~an +Importer which imports these triplets into a GraphDB database and +(3)~looked at different ways of querying a GraphDB Endpoint. All of +this is easy to deploy using a single Docker Compose file. With this +stack ready for use, we will continue with a look at some interesting +applications and queries built on top of this interface. diff --git a/doc/report/references.bib b/doc/report/references.bib index e66788b3683d51bc768350ecd3930dfc409240fa..39a883a348192f3d1ff8ab31a354f7ce09dc3b12 100644 --- a/doc/report/references.bib +++ b/doc/report/references.bib @@ -312,4 +312,5 @@ date = {2020}, urldate = {2020-08-17}, url = {http://graphdb.ontotext.com/documentation/free/graphdb-feature-comparison.html}, -} \ No newline at end of file +} +