With Kubernetes, you can deploy the Acrolinx Platform from manifest files that Acrolinx provides. This makes it easier to install and operate your Standard Stack instance. Before you install, there are a few things you'll need to do to prepare your system.
Note
If you have an existing Standard Stack installation, migrate it to version 2020.11 before you get started.
You'll need to make a few changes to your system before you install.
Warning
Make sure that your host machine has internet access.
To install and maintain the Acrolinx Platform with the Helm chart, the host machine needs to connect to the following sites:
-
Acrolinx image registry at:
http://068441990362.dkr.ecr.eu-west-1.amazonaws.com
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:
installs K3s,
executes the cluster setup via kubectl.
-
An ordinary user (called
acrolinx
) who: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
acrolinx
.sudo groupadd acrolinx
-
Create the
acrolinx
user.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 /home/acrolinx/config
.
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