Learn how to migrate an existing Standard Stack installation to version 2021.05 on Kubernetes.
If you have an existing Standard Stack installation, you'll need to migrate it to version 2020.11 before you install 2021.05.
The 2020.11 release is the last Standard Stack release that runs on bare metal. It’s designed to be the springboard for the containerized environment. When you migrate to 2021.11, you'll transition Acrolinx to a state that's easy to containerize. This moves most persistent-state data that isn’t stored in an external database into the configuration directory.
Some local databases will still live in the installation directory. If they don’t exist in the configuration directory, you'll need to move them there manually. They include:
Once you've moved them, restart the Acrolinx Platform.
Make sure that your system meets the system requirements form Standard Stack. If your current host isn’t powerful enough, you don’t need to move the whole 2020.11 installation. Instead, just copy the configuration directory to the new machine. If you already have a dedicated user called
acrolinx, the configuration directory is located at
/home/acrolinx/config. You'll need to create this user if you don't have it.
Before you install K3s and the Acrolinx Platform, prepare the host environment as described below.
It’s best to have two users in your K3s / Acrolinx Platform setup. This is because the K3s installation and startup require superuser privileges that the second user doesn’t need. You should have:
A privileged user who:
executes the cluster setup via kubectl.
An ordinary user (called
owns the configuration directory on the host system,
runs containers inside the cluster.
Need to create a user?
To create a new user, do the following:
Add a group called
sudo groupadd acrolinx
sudo useradd -g acrolinx acrolinx
You’ll store most of your Acrolinx settings in a dedicated directory known as the configuration directory. This is located at
Don't already have a dedicated directory on the host system? Keep reading to learn how to create a new one. If you're an existing user, you'll find information on how to rename your existing directory.
If want to install Acrolinx from scratch, dedicate an empty directory on the host system to the platform configuration.
sudo su - acrolinx cd mkdir config exit
If you have an existing installation, you’ll need to rename the configuration directory. Here’s an easy way to do it:
sudo mv /home/acrolinx/.config/Acrolinx/ServerConfiguration /home/acrolinx/config
If you plan to migrate to a new machine, just copy the old configuration directory to the new host as follows:
kubectl cp -n acrolinx acrolinx-core-server-0:/opt/guidance/<path> /home/acrolinx/config/<path>
For example, if the path in the old docs was
<INSTALL_DIR>\data\common\term_help_template.vm, you'd use:
kubectl cp -n acrolinx acrolinx-core-server-0:/opt/guidance/data/common/term_help_template.vm /home/acrolinx/config/data/common
The main configuration for the Acrolinx Platform still lives in the configuration directory. There were no major changes to the overall format of the configuration. However, starting with 2021.05 you can't customize a number of platform settings. Make sure you remove the following settings from your configuration files in case they’re configured there:
You can also get rid of the following files:
Since the Acrolinx Platform now runs inside containers, you can't access the database via the
localhost host name. If you run your database on the same host as the Acrolinx Platform, you'll need to do the following to keep using it:
Configure your database to allow access from sources other than local host.
Change the settings in your
server/bin/persistence.properties. To do this, replace
localhostin the different
*.jdbcUrlsettings with the host name of your database / Acrolinx Platform host.
Acrolinx now secures end-user communication via TLS. This means you’ll need to remove or disable NGINX on the Acrolinx Platform host when you migrate. For more information, visit Secure End-User Communication with Acrolinx.
Once you've prepared the configuration on the host machine, follow these steps: