Upgrading the Akula Server
This document describes how to manually upgrade an Akula Server installation by using files downloaded from the Verivo DevCenter Downloads page (you must log in to access this page).
Within the 2.5 release package download, the Akula server is simply named "server.war". Rename this file during deployment to "akula.war".
The Akula Server requires a database to store the configuration and run time information used by the server. The Akula Server includes an internal Apache Derby database that you can use to get up and running quickly in a development environment. While the Derby database is adequate for development work, it is not intended to function in a deployment environment. For deployment, Verivo recommends that you configure the Akula Server to use an external enterprise-class database, such as Microsoft SQL Server, MySQL, or Oracle.
The primary task for upgrading the Akula Server is to upgrade the database. On start up, the akula.war file automatically upgrades the database that it uses for configuration and run-time information. Therefore, most of the steps in the procedure below describe how to edit configuration files in the
AKULA_HOME directory to ensure that the akula.war file has proper access to the database to perform the upgrade.
Akula Server upgrade procedure
Back up the existing database used to store the configuration and run time information used by the Akula Server. This is the database specified in the
(If you are using an external database only) The
db_jndi_nameproperty in the
AKULA_HOME/global/context.properties file specifies the JNDI database resource for the Akula Server database. You therefore require a corresponding JNDI database resource definition on your JEE server or servlet container. For example, from the context.properties shown above, you require a resource named
If you are running the Akula Server on Tomcat, you would add the following resource definition to the Tomcat context.xml file:
The akula.war file automatically upgrades its database when you first start it. Therefore, ensure that the username specified in the JNDI database resource definition has permissions to the database so that the akula.war file can modify the database tables and table schemas.
Edit the Akula global properties file to add definitions to support features included in this version of Akula. The location and name of the file is:
AKULA_HOME/global/properties.xml. Add the following change:
This version of Akula includes an auditing mode that allows built-in Akula database auditing when it is enabled. To enable the auditing setting, add the following definition for the akula_auditing_enabled property:
For more information on using the akula_auditing_enabled key to enable or disable auditing, see "Auditing REST API."