Руководство по установке Entaxy

Перед установкой Системы нужно подготовить СУБД для работы с ней.

Подготовка заключается в создании пользователя СУБД и создании баз данных.

Для работы с СУБД используется инструмент psql с правами администратора. Для запуска инструмента выполнить следующие команды:

sudo su - postgres
psql

После запуска инструмента выполняются следующие действия:

Создание пользователя:

CREATE USER entaxy WITH ENCRYPTED PASSWORD 'entaxy';

Создание баз данных

CREATE DATABASE cache;
CREATE DATABASE storage;

Назначение прав пользователю entaxy на только что созданные базы cache и storage:

GRANT ALL ON DATABASE cache TO entaxy;
GRANT ALL ON DATABASE storage TO entaxy;

После создания пользователя и БД выйти из инструмента psql с помощью ввода команды \q

После выхода из инструмента для работы с PostgresPro 11 Standard Edition psql требуется выйти из консоли пользователя postgres. Для этого выполнить команду:

exit

Для установки OpenJDK 11 перейдите в каталог, где вы сохранили дистрибутив Java. Например, /home/<username>/distrib/openjdk, создайте каталог /opt/openjdk и распакуйте в него дистрибутив OpenJDK 11.

cd /home/<username>/distrib/openjdk
sudo mkdir -p /opt/openjdk
sudo tar xvf <название установочного файла Java>.tar.gz -C /opt/openjdk

На распакованные файлы необходимо назначить права пользователя root:

sudo chown -R root:root /opt/openjdk
sudo chmod 755 /opt/openjdk/jdk-11.0.11

Перед настройкой конфигурации nginx необходимо его установить командой:

sudo apt install nginx

После установки удалить конфигурацию nginx по умолчанию. Далее в домашней директории - например, /home/<username>/distrib/nginx/sites-available/ создать файл конфигурации nginx entaxy.conf подставив свои параметры:

upstream esb {
   server ip_address:8181;
}

server {
    listen <port>;
    server_name _;

    location / {
        auth_basic "Secured area";
        auth_basic_user_file /etc/nginx/htpasswd;

        proxy_pass http://esb;
        proxy_redirect off;
        proxy_ssl_verify off;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-ForwardedUser $remote_user;
        proxy_pass_header ENTAXY_TrueSet;
        proxy_pass_header ENTAXY_EndpointName;
        proxy_pass_header ENTAXY_ConnectorType;
        proxy_pass_header ENTAXY_ConnectorName;
        proxy_pass_header ENTAXY_Source;
        proxy_pass_header ENTAXY_SourceType;
        proxy_pass_header ENTAXY_Destination;
        proxy_pass_header ENTAXY_DestinationType;
        proxy_pass_header ENTAXY_Priority;
        proxy_pass_header ENTAXY_ContentType;
        proxy_pass_header ENTAXY_EmptyContent;

        client_max_body_size 1G;
        proxy_buffering off;
        proxy_request_buffering off;
        keepalive_timeout 5;
    }
}

Скопируйте созданный entaxy.conf в директорию /etc/nginx/sites-available, затем требуется создать символьную ссылку на конфигурацию в каталоге разрешённых конфигураций:

sudo rm -rf /etc/nginx/sites-enabled/default
sudo cp /home/<username>/distrib/nginx/sites-available/entaxy.conf /etc/nginx/sites-available
sudo ln -s /etc/nginx/sites-available/entaxy.conf /etc/nginx/sites-enabled/entaxy.conf

После установки новой конфигурации и её разрешения, необходимо перезагрузить конфигурацию nginx командой:

sudo nginx -t (1)
sudo systemctl reload nginx (2)

Затем необходимо создать файл паролей Basic аутентификации htpasswd в каталоге /opt/nginx

В Entaxy используется Basic аутентификация для всех запросов, приходящих на балансировщик, функции которого выполняет nginx. Аутентификация производится средствами самого nginx.

В качестве базы для хранения пользователей nginx использует файл в специальном формате htpasswd.

Для того чтобы вновь созданные пользователи в Системе могли аутентифицироваться, необходимо передать информацию о них в файл htpasswd. Для этого используется специальный скрипт, который отрабатывает по расписанию. Сам скрипт нужно предварительно скачать (htpasswd-checker.sh) и затем вставить в любой каталог, например, в /opt/htpasswd-checker:

sudo mkdir -p /opt/htpasswd-checker/log
sudo cp /home/<username>/distrib/nginx/htpasswd /etc/nginx
sudo cp /home/<username>/distrib/script/htpasswd-checker.sh /opt/htpasswd-checker
sudo chown -R root:root /opt/htpasswd-checker

Так же требуется проверить адреса серверов кластера, публикующих сервис для работы с файлом htpasswd (сервера с karaf) для ключа KARAF_HOST_NAMES:

KARAF_HOST_NAMES=("http://192.168.122.93:9091" "http://192.168.122.94:9091")

Затем создать расписание запуска для cron:

sudo crontab -e

В открывшемся редакторе добавить запись:

* * * * * /opt/htpasswd-checker/htpasswd-checker.sh

Создать пользователя artemis, под которым будет работать Artemis. При создании пользователя создаётся домашний каталог пользователя /opt/artemis, в котором будет установлен сам Artemis:

sudo useradd -d /opt/artemis -m -r artemis -s /usr/sbin/nologin

Перейти в каталог где вы сохранили дистрибутив Artemis. Например, /home/<username>/distrib/artemis. Распаковать дистрибутив Artemis в домашний каталог Artemis и назначить распакованным файлам права пользователя artemis:

cd /home/<username>/distrib/artemis
sudo tar xvf <название установочного файла Artemis>.tar.gz -C /opt/artemis
sudo cp -a /opt/artemis/apache-artemis-<номер вашей версии>/. /opt/artemis/
sudo rm -rf /opt/artemis/apache-artemis-<номер вашей версии>
sudo chown -R artemis:artemis /opt/artemis

Создать каталог для брокера:

sudo mkdir -p /opt/artemis/brokers
sudo chown artemis:artemis /opt/artemis/brokers

Создать брокер:

sudo su -s /bin/sh -c \
    "export JAVACMD=/opt/openjdk/jdk-11.0.11/bin/java; \
    export ARTEMIS_HOME=/opt/artemis; \
    /opt/artemis/bin/artemis create \
    --name entaxy-broker \
    --user artemis \
    --password artemis \
    --require-login \
    /opt/artemis/brokers/entaxy-broker" \
    artemis

Создать файл сервиса /etc/systemd/system/entaxy@artemis.service:

[Unit]
Description=Artemis ActiveMQ Message Broker
After=syslog.target network.target

[Service]
Type=forking
ExecStart=/opt/artemis/brokers/entaxy-broker/bin/artemis-service start
ExecStop=/opt/artemis/brokers/entaxy-broker/bin/artemis-service stop

User=artemis
Group=artemis

[Install]
WantedBy=multi-user.target

Отредактировать переменную окружения JAVA_HOME для сервиса брокера:

sudo systemctl edit entaxy@artemis.service

При выполнении предыдущей команды откроется текстовый редактор, в который надо добавить следующее содержимое, после чего сохранить файл:

[Service]
Environment="JAVA_HOME=/opt/openjdk/jdk-11.0.11"

После создания файла сервиса и определения переменных окружения, выполнить команду

sudo systemctl daemon-reload

Выполнение команды перезагрузит конфигурацию systemd, и сервис для запуска Artemis станет доступен

Включить автозапуск сервиса Artemis при старте системы:

sudo systemctl enable entaxy@artemis.service

Запустить брокер Entaxy

sudo systemctl start entaxy@artemis.service

Создать пользователя karaf, под которым будет работать Karaf. При создании пользователя создаётся домашний каталог пользователя /opt/karaf, в котором будет установлен сам Karaf:

sudo useradd -d /opt/karaf -m -r karaf -s /usr/sbin/nologin

Перейти в каталог где вы сохранили дистрибутив entaxy-ion-karaf-1.9.0.zip

cd /home/<username>/distrib/karaf
unzip entaxy-ion-karaf-1.9.0.zip -d /opt/karaf
sudo cp -a /opt/karaf/entaxy-ion-karaf-1.9.0/entaxy-ion-karaf/. /opt/karaf
sudo rm -rf /opt/karaf/entaxy-ion-karaf-1.9.0
sudo chown -R karaf:karaf /opt/karaf

Отредактировать переменную окружения JAVA_HOME для Karaf:

sudo sed -i 's/# export JAVA_HOME/export JAVA_HOME=\/opt\/openjdk\/jdk-11.0.11/g' /opt/karaf/bin/setenv

Отредактировать переменную окружения EXTRA_JAVA_OPTS для Karaf, чтобы устранить возможность эксплуатацию критической уязвимости Log4j CVE-2021-44228:

sudo sed -i 's/# export EXTRA_JAVA_OPTS/export EXTRA_JAVA_OPTS=-Dlog4j2.formatMsgNoLookups=true/g' /opt/karaf/bin/setenv

Создать файл сервиса /etc/systemd/system/karaf.service со следующим содержимым:

[Unit]
Description=Entaxy Karaf
After=syslog.target network.target

[Service]
ExecStart=/opt/karaf/bin/karaf start
ExecStop=/opt/karaf/bin/karaf stop

User=karaf
Group=karaf

SuccessExitStatus=0 143
RestartSec=15
Restart=on-failure

LimitNOFILE=102642

[Install]
WantedBy=multi-user.target

После создания файла сервиса и определения переменных окружения, выполнить команду:

sudo systemctl daemon-reload

Выполнение команды перезагрузит конфигурацию systemd, и сервис для запуска Karaf станет доступен

Включить автозапуск сервиса Karaf при старте системы:

sudo systemctl enable karaf.service

Для этого открыть браузер на машине, где установлена Система, и перейти по адресу http://localhost:8181/cxf.

Браузер запросит имя пользователя и пароль. Ввести admin в качестве имени пользователя, и admin в качестве пароля. Логин и пароль уже прописаны в файле /etc/nginx/htpasswd. При успешной аутентификации отобразится страница следующего вида:

На этом установку Системы можно считать законченной.