Need to update documentation to include more details on the internal workings, what is include in the build, how to install. The following is a start.
[ ] record Production deployment
[x] record Dev deployment
[x] add following to release notes
Context
OAI provider is a Java module that extends Fcrepo and integrates with Modeshape and Fcrepo (i.e, at a level below the web API). The Maven build infrastructure packages the OAI Provider modules/jar with the complete Fcrepo WAR file. To install the OAI Provider means that the Fcrepo WAR file within Tomcat is replaced.
ModeShape index as defined by the start-up parameters -Dfcrepo.modeshape.configuration (e.g., dockerfile ) and ModeShape performance parameters (e.g., cacheSize and node property index)
pre-defined namespaces otherwise Fcrepo startup errors on Modeshape index due to undefined namespaces
ModeShape Lucene libraries to support Modeshape index on multi-valued properties as the local index provider for "multi-value properties, this provider will only store & use the first value." reference and reference
What is required to deploy the OAI Provider?
Need to update documentation to include more details on the internal workings, what is include in the build, how to install. The following is a start.
Context
OAI provider is a Java module that extends Fcrepo and integrates with Modeshape and Fcrepo (i.e, at a level below the web API). The Maven build infrastructure packages the OAI Provider modules/jar with the complete Fcrepo WAR file. To install the OAI Provider means that the Fcrepo WAR file within Tomcat is replaced.
What is included within an OAI Provider Release as defined by the OAI Provider Maven build?
complete release of Fcrepo
OAI Provider libraries and supporting libraries
Production config files including:
access control
ModeShape index as defined by the start-up parameters
-Dfcrepo.modeshape.configuration
(e.g., dockerfile ) and ModeShape performance parameters (e.g.,cacheSize
and node property index)pre-defined namespaces otherwise Fcrepo startup errors on Modeshape index due to undefined namespaces
parameters related to OAI Provider
fcrepo startup parameter including
-Dfcrepo.streaming.parallel=true
related to performanceModeShape Lucene libraries to support Modeshape index on multi-valued properties as the
local
index provider for "multi-value properties, this provider will only store & use the first value." reference and reference