ELMA365 On-Premises / Install ELMA365 Standard

Install ELMA365 Standard

ELMA365 On-Premises Standard can be installed to Kubernetes-in-Docker. This installation method allows you to run a Kubernetes cluster locally using Docker containers as Kubernetes nodes.

начало внимание

If Docker is installed using a snap, you need to perform an additional step before installing ELMA365. Open the configuration file and change the locations of the ELMA365_INSTALL_DIR, ELMA365_BACKUP_DIR, and ELMA365_PRIVATE_REGISTRY_DIR (only for offline installation) folders to /mnt or /media. For example, /mnt/elma365/docker, /mnt/elma365/backup and /mnt/elma365/registry.

конец внимание

  1. Before installing ELMA365, install Docker for your operating system. Note that KinD does not support creating a Kubernetes cluster with Cgroups v2. Learn more in the documentation.
  2. To install ELMA365, run the following command:

sudo curl -fsSL -o elma365-installer-docker.sh https://dl.elma365.com/onPremise/master/latest/installer-docker && sudo chmod +x elma365-installer-docker.sh && sudo ./elma365-installer-docker.sh

  1. The first time you run the installation script, it will create the config‑elma365.txt configuration file if it doesn’t exist. You can also run the installation script with the --new-config key to create a new configuration file.
  2. Open the config-elma365.txt configuration file for editing, uncomment it, and fill in the necessary variables.

sudo nano config-elma365.txt

  1. Run the install command again using the script you downloaded earlier.

sudo ./elma365-installer-docker.sh

  1. After that, the installation process will start. It takes 10–15 minutes. If the installation is successful, the following message will appear: “The ELMA365 application was successfully installed. Visit http://ELMA365_HOST (user/pass: ELMA365_EMAIL / ELMA365_PASSWORD)” [with parameters specified in step 3].

Edit the application’s parameters

To change the application’s parameters, edit the configuration file config‑elma365.txt, uncomment is, and edit the variables you need:

sudo nano config-elma365.txt

After that, update the application using the script downloaded earlier. To do that, open the command console on the server and run the following command (optionally without the --upgrade key):

sudo ./elma365-installer-docker.sh --upgrade

Install to Kubernetes in Docker without internet access

If the server you are going to install ELMA365 to does not have internet access, you can install the system to Kubernetes in Docker in the following way:

 

  1. On a computer with internet access, run the downloader for the offline version (the size of the files is ~45 GB). Open the terminal and run the following command:

sudo curl -fsSL -o elma365-downloader-docker.sh https://dl.elma365.com/onPremise/master/latest/downloader-docker-offline && chmod +x elma365-downloader-docker.sh && ./elma365-downloader-docker.sh

  1. When all files are downloaded, copy the elma365-X.Y.Z catalog to the server the installation will run on.
  1. Before installing ELMA365, install Docker for your operating system.
  2. Open the catalog and run the following command (take note of the --offline parameter):

sudo ./elma365-installer-docker.sh --offline

  1. The first time you run the installation script, it will create the config-elma365.txt configuration file if it doesn’t exist.
  2. Open the config-elma365.txt configuration file for editing, uncomment it, fill in the necessary variables, and check the server’s IP address in the ELMA365_PRIVATE_REGISTRY_URL parameter. The private registry with Docker images will be available at this address.

To change the private registry’s port (the default port is 5000), specify it in the ELMA365_PRIVATE_REGISRTY_PORT and ELMA365_PRIVATE_REGISTRY_URL parameters.

When you specify the domain that the elma365 service will be available at in the ELMA365_HOST parameter, you may need to enable hostaliases. To do that, you need to uncomment the ELMA365_HOSTALIASES_IP parameter, specifying the system’s IP address.

sudo nano config-elma365.txt

  1. Run the installation command again using the script downloaded earlier (take note of the --offline parameter):

sudo ./elma365-installer-docker.sh --offline

  1. After that, the installation process will start. It takes 10–15 minutes. If the installation is successful, the following message will appear: “The ELMA365 application was successfully installed. Visit http://ELMA365_HOST (user/pass: ELMA365_EMAIL / ELMA365_PASSWORD)” [with parameters specified in step 6].

Update

Update is similar to installation.

To update the system, go to the command console on the server and run the following command:

sudo curl -fsSL -o elma365-installer-docker.sh https://dl.elma365.com/onPremise/master/latest/installer-docker && sudo chmod +x elma365-installer-docker.sh && sudo ./elma365-installer-docker.sh

For an offline update, on a computer with internet access run the downloader for the offline version (the size of the files is ~45 GB). Open the terminal and run the following command:

sudo curl -fsSL -o elma365-downloader-docker.sh https://dl.elma365.com/onPremise/master/latest/downloader-docker-offline && chmod +x elma365-downloader-docker.sh && ./elma365-downloader-docker.sh

When all files are downloaded, copy the elma365-X.Y.Z catalog to the server the installation will run on. Then open the catalog and run the following command (take note of the --offline parameter):

sudo ./elma365-installer-docker.sh --offline

The installation script will use the existing settings in the config-elma365.txt configuration file. If this file doesn’t exist, the script will get the current parameters from the running container and create a configuration file with these parameters.

The system will ask you to confirm the action. After that, the update process will start.

Before the update, make the ELMA365 data dump. Select the [B]ackup now option by pressing the B key at the following update step:

Be sure you have made data backup before update. Choose: [B]ackup now (default), [C]ontinue, [E]xit.

The dump will be saved to a separate folder. Its name will include the system version and a timestamp, for example, /backup/ELMA365_2022.11.5-rc_2023.01.09-05.45.01.

Delete

To delete the entire installation, run the installation script with the --delete key:

sudo ./elma365-installer-docker.sh –delete

Reinstall

To reinstall ELMA365 (all data will be deleted), you need to run the installation script with the --reset key:

sudo ./elma365-installer-docker.sh –reset

Backup data

начало внимание

While creating a backup, ELMA365 services are stopped, and the application becomes unavailable.

конец внимание

To create a database backup, run the installation script with the --dump key:

sudo ./elma365-installer-docker.sh –dump

The dump will be saved to the /backup folder with a timestamp.

Restore data

To restore data, follow these steps:

  1. Install ELMA365 on a new server.
  2. Run the installation script with the --restore and --path /backup/<backup-folder-name> keys:

sudo ./elma365-installer-docker.sh --restore --path /backup/<backup-folder-name>

Troubleshooting and diagnostics

  1. Collecting diagnostic data.

To collect diagnostic data on the system, use the installation script. Open the command console on the server and run the following command using the script downloaded earlier. Use the --diag parameter:

sudo ./elma365-installer-docker.sh --diag

To save this information to the server, press S. A link to access the data will be generated.

To save the information to a file on the local drive, press F.

  1. Forming logs and checking service statuses.

To get logs from the application’s services, run the following command:

docker exec elma365 kubectl logs -l tier=elma365 --all-containers > logs.txt

To view the logs of a specific service, run the following command with the service’s name instead of [name]:

docker exec elma365 kubectl logs -l app=[name]

Example:

docker exec elma365 kubectl logs -l app=main

To view logs in real time, add the -f option.

Example:

docker exec elma365 kubectl logs -l app=main -f

To check services’ statuses, use the following command:

docker exec elma365 kubectl get pod

You will see the result as a table with a list of services. Services’ statuses need to be Running, and tasks’ statuses Completed.

Available commands

To view the list of available commands, run the installation script with the --help key:

sudo ./elma365-installer-docker.sh –help

--new-config

Create a new installation configuration file config-elma365.txt.

--diag

Collect diagnostic data.

--install

Install ELMA365.

--offline

Install ELMA365 offline.

--upgrade

Update ELMA365.

--dump

Backup the database to the folder /backup/ELMA365 with the system version and a timestamp in the name.

--restore

Restore a database backup from the archive.

--reset

Reinstall ELMA365 (all data will be deleted).

--delete

Delete ELMA365 (all data will be deleted).

 

 

Found a typo? Highlight the text, press ctrl + enter and notify us