Skip to content

Commit

Permalink
Final changes for the 2.8.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Ian Emmons committed Jun 9, 2022
1 parent a7af03c commit 204ec7c
Show file tree
Hide file tree
Showing 7 changed files with 70 additions and 11 deletions.
44 changes: 43 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,48 @@
# News

April 17, 2019: Released Parliament™ version 2.7.12. Changes of note:
**June 9, 2022:** Released Parliament™ version 2.8.1. Changes of note:

* This release includes a Docker image on Docker Hub: idemmons/parliament:2.8.1

* Introduced a clean separation between Parliament's software and data files.
The software files may now be read-only to the account under which Parliament
is running, and the data files are easily moved to a writable location
suitable for mass storage, such as an alternate partition, network mount,
NAS or SAN device. All data files, including log files, are now stored under
the directory given by the kbDirectoryPath setting in ParliamentKbConfig.txt
(default is kb-data under the installation directory).

* The startup script on Linux/UNIX properly supports systemd service installation.

* The startup script on Windows parallels the Linux/UNIX script, and is now a PowerShell script.

* Fixed an issue on UNIX/Linux platforms that prevented the Parliament daemon
from receiving SIGTERM signals, making Parliament difficult to use in a
Docker container.

* Made the bdbCacheSize configuration parameter in ParliamentKbConfig.txt
global across all graphs. Previously, a cache of this size was dedicated to
each named graph. With this change, a single cache of this size is shared by
all graphs. This is particularly beneficial to deployments that have a large
number of graphs. Also, raised the default cache size from 32 MB to 512 MB.

* Reduced the volume of logging when Parliament is running in daemon mode.

* Numerous updates to bring in line with Java 11 & 17 (but still using Java 8)

* Several documentation improvements, including a new section detailing how to secure a Parliament instance.



**May 7, 2019:** Released Parliament™ version 2.7.13. Changes of note:

* Added reserved predicates par:directType and par:directSubClassOf to speed queries for most-derived types.

* Fixed subsumption inference so that properties are always sub-properties of themselves.



**April 17, 2019:** Released Parliament™ version 2.7.12. Changes of note:

* Parliament was recently moved to this GitHub project from its long-time home on [SemWebCentral](http://parliament.semwebcentral.org/)

Expand Down
Binary file modified doc/HowToRelease.pdf
Binary file not shown.
9 changes: 7 additions & 2 deletions doc/HowToRelease.tex
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,13 @@ \section{Prepare the Dependencies Archive}



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Update README.md}

Update the What's New section of \path|README.md|.



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Tag and Publish the Release on GitHub}

Expand All @@ -268,8 +275,6 @@ \section{Tag and Publish the Release on GitHub}

Upload artifacts, including dependencies

Post what's new



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Expand Down
5 changes: 1 addition & 4 deletions doc/ReleaseNotes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,11 @@ Version 2.8.1 (2.8.0 was never released):
from receiving SIGTERM signals, making Parliament difficult to use in a
Docker container.

* Added scripts to build Docker containers to be released alongside the
standard Parliament releases.

* Made the bdbCacheSize configuration parameter in ParliamentKbConfig.txt
global across all graphs. Previously, a cache of this size was dedicated to
each named graph. With this change, a single cache of this size is shared by
all graphs. This is particularly beneficial to deployments that have a large
number of graphs. Also, raised the default cache size from 32 MB to 256 MB.
number of graphs. Also, raised the default cache size from 32 MB to 512 MB.

* Reduced the volume of logging when Parliament is running in daemon mode.
Log4j is now configured without a console logger, which means that the
Expand Down
19 changes: 16 additions & 3 deletions doc/UserGuide/DeployingAndUsing.tex
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,29 @@ \section{Deploying a \ac{pmnt} Container}
\texttt{idemmons/parliament:«version»}
\end{quote}

Before deploying this image, create a directory for \acp{pmnt} data files. A traditional choice on the local file system would be \path|/var/parliament-data| for Linux and Unix systems and \path|C:\ProgramData\parliament-data| on Windows. A location on an external storage device might also be a good choice. Whatever you choose, we will refer to this location as \texttt{«data-dir»}.
To run the container, use this command (with line breaks added for readability):
{\small
\begin{verbatim}
docker run -d -p 80:8089 --name=parliament-«version»
--mount type=volume,src=parliament-data,dst=/var/parliament-data
--env PARLIAMENT_JAVA_HEAP_SIZE=512m
--env PARLIAMENT_BDB_CACHE_SIZE=512m,1
idemmons/parliament:«version»
\end{verbatim}
}

To run the container, with options to mount the \texttt{«data-dir»} volume and map the port, use this command (with line breaks added for readability):
As given here, the mount option will create a local Docker volume called \path|parliament-data| to contain \acp{pmnt} data files and logs. Using variations of this option, you can cause the container to store the data files and logs in a broad variety of locations and file systems, such as on an external storage array. (See the Docker documentation for more information.)

Alternately, Docker can store \acp{pmnt} data files and logs in a local directory on the container's host with this syntax:
{\small
\begin{verbatim}
docker run -d -p 80:8089 --name=parliament-«version»
--mount type=volume,src=«data-dir»,dst=/var/parliament-data
--mount type=bind,src=/host/directory,dst=/var/parliament-data
--env PARLIAMENT_JAVA_HEAP_SIZE=512m
--env PARLIAMENT_BDB_CACHE_SIZE=512m,1
idemmons/parliament:«version»
\end{verbatim}
}

The two environment variables are optional. If they are left out, the default values used will be the values shown in the command line above. (See Sections~\ref{section-pmnt-startup-script} and~\ref{section-main-config} for discussions of these settings.) Table~\ref{table-pmnt-container-connect-urls} lists the endpoints exposed by the running container, as discussed in Section~\ref{section-std-server-usage}.

Expand Down
Binary file modified doc/UserGuide/ParliamentUserGuide.pdf
Binary file not shown.
4 changes: 3 additions & 1 deletion jena/docker/run-parliament-container
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
#!/bin/bash

version=2.8.1
#mount_option=type=volume,src=parliament-data
mount_option=type=bind,src=/Users/iemmons/parliament-data
image_os=ubuntu
#image_os=rhel8
#image_os=win
Expand All @@ -11,5 +13,5 @@ image_os=ubuntu

docker run -d -p 80:8089 --name=parliament-$image_os \
--env PARLIAMENT_JAVA_HEAP_SIZE=640m --env PARLIAMENT_BDB_CACHE_SIZE=1g,1 \
--mount type=volume,src=parliament-data-$image_os,dst=/var/parliament-data \
--mount $mount_option,dst=/var/parliament-data \
parliament-$version-$image_os

0 comments on commit 204ec7c

Please sign in to comment.