Skip to main content
Version: 4.25.x.x LTS

Appendix E - Migrating instances to standalone deployments

This chapter describes how to migrate an existing nevisAuth instance based on Java EE deployment to standalone deployment.

These migration guidelines do not apply to nevisAuth instances managed by nevisAdmin 3. Refer to the nevisAdmin 3 Reference Guide, chapter Operation and Administration, for information on how to migrate nevisAuth instances managed by nevisAdmin 3.

Procedure Overview

  1. Create a new instance in standalone deployment mode.
  2. Copy the relevant configuration properties and data (in case of using the file system's out-of-context data store) from the old instance to the new instance.
  3. Test the new instance.
  4. Remove the old instance.

Detailed Migration Steps

  1. Create a new nevisAuth instance in standalone deployment mode. This instance must be bound to the same interface and use the same protocol schemes and key material as the instance you would like to replace. Make sure the new instance runs on a separate and unused port. Example command:
nevisauth inst create NEVISAUTH_SERVER_URL=http://localhost:11111 AUTH_DEPLOY_TYPE=standalone
  1. Edit the configuration files log4j.xml and nevisauth.yml in /var/opt/nevisauth/[newInstance]/conf/, to reflect your previous configuration in /var/opt/nevisauth/[oldInstance]/conf/.
  2. Standalone deployments do not require the file vmargs.conf to set the Java options. (vmargs.conf is ignored by standalone deployments) In standalone deployments, it is the file env.conf that supplies the Java options, in the following format: JAVA_OPTS="-Xmx512m -Xms512m -XX:+UseParallelGC"
  3. Do not simply overwrite the new instance's configuration files with the configuration files of the old instance. This is because the new configuration files contain some mandatory settings that are not part of the old ones. Instead, go through the properties of the old configuration files one by one. If desired, copy/paste the properties to the configuration file of the new instance.
  4. After changing the configurations, make sure that all files are owned by nvauser/nvbgroup. Example command:
chown nvauser:nvbgroup -R /var/opt/nevisauth/[newInstance]
  1. Start the new instance with the next command:
nevisauth start
  1. Ensure that the new instance is running.
  2. Configure nevisProxy (and other infrastructure elements) to use the new instance, by changing the assigned port to the port of the new nevisAuth instance.
  3. Test the functionality of your Nevis setup properly.
  4. If successfully tested, remove the old instance.