Порядок установки
Для установки сервисов Ario в операционной системе на базе Linux используются docker‑контейнеры. Каждому сервису соответствует отдельный контейнер.
Перед установкой ознакомьтесь с типовыми требованиями и убедитесь, что ваше аппаратное и программное обеспечение подходит для установки сервисов. Подробнее см. в документе «Directum RX. Типовые требования к аппаратному и программному обеспечению». Требуемая конфигурация оборудования определяется с учетом объема документов, который обрабатывается сервисами Ario:
•если объем документопотока в месяц составляет до 90 000 документов, все сервисы Directum Ario можно самостоятельно установить на один сервер;
•если объем документопотока в месяц превышает 90 000 документов, рекомендуется установить Directum Text Extractor Service и другие сервисы на отдельные виртуальные или физические серверы. Чтобы выполнить распределенную установку, обратитесь в службу поддержки Directum.
ПРИМЕЧАНИЕ. Объем документопотока рассчитан исходя из средних значений: объем одного документа – 2 страницы, время обработки – 8 часов в день, 22 дня в месяц.
Чтобы установить сервисы Directum Ario на один сервер:
1.Архив с Directum Launcher распакуйте в локальную папку на сервере с помощью команды:
tar -xvf <Имя архива> -C <Имя папки>
ВАЖНО. Для корректной установки общий путь к файлам должен быть не более 256 символов. Также он не должен содержать пробелы, символы кириллицы, запятые и спецсимволы. Поэтому используйте, например, папку /srv/DirectumLauncher. В зависимости от настроек операционной системы для дальнейших действий могут потребоваться права суперпользователя.
2.В корень папки с Directum Launcher скопируйте архив с сервисами Ario.tar.gz. Если на сервере отсутствует доступ к сети Интернет, также скопируйте архив с базовыми образами для сервисов ArioBaseImages.tar.gz.
3.Дальнейшие действия выполняйте под учетной записью пользователя, от имени которого запущена служба Docker. Если используется учетная запись без привилегий суперпользователя:
•выдайте пользователю полные права на папку с Directum Launcher и вложенные в нее папки и файлы;
•убедитесь, что для этой учетной записи выданы права на чтение и запись в папки, путь до которых задается в конфигурационном файле config.yml;
4.Добавьте компоненты в Directum Launcher. Для этого выполните команду:
./do.sh components add_all
5.Создайте конфигурационный файл config.yml на основе файла DirectumLauncher/etc/config.yml.example. Если он был создан ранее, пропустите шаг.
6.Сгенерируйте конфигурационный файл config.yml с минимальными настройками сервисов Ario с помощью команды:
./do.sh ario generate_config_yaml
7.Откройте конфигурационный файл config.yml и в секции variables задайте реквизиты пользователя, от которого запускаются сервисы внутри контейнеров, параметры подключения к базам данных и RabbitMQ, а также другие параметры.
Структура сеции variables:
variables:
ARIO_DATABASE_ENGINE: '{используемая СУБД}'
ARIO_PG_CONNECTION_STRING: '{строка подключения к базе данных Smart Service};'
ARIO_PG_CONNECTION_STRING_DIS: '{строка подключения к базе данных Smart Service};'
ARIO_QUEUE_CONNECTION_STRING: '{строка подключения к очереди сообщений RabbitMQ}'
ARIO_STORAGE_SERVICE_URL: '{хост для хранения оперативных данных}'
ARIO_STORAGE_SERVICE_PORT: {порт подключения к сервису Storage Service}
ARIO_STORAGE_SERVICE_LOGIN: '{логин для подключения к сервису Storage Service}'
ARIO_STORAGE_SERVICE_PASSWORD: '{пароль для подключения к сервису Storage Service}'
ARIO_IDENTITY_SERVICE_PORT: {порт подключения к сервису Identity Service}
ARIO_INSTALL_PATH: '{путь до папки установки}'
ARIO_LOG_PATH: '{путь до лог-файлов}'
ARIO_ACTIVATION_KEY_PATH: '{путь до ключа активации}'
ARIO_DSS_HOST: '{IP-адрес хоста или доменное имя контейнера с сервисом Smart Service}'
ARIO_DSS_PORT: {порт для подключения к сервису Smart Service}
ARIO_APM_SERVER_HOST: {адрес контейнера с сервисом Elastic APM Service}
ARIO_APM_SERVER_PORT: {внутренний порт для подключения к сервису Elastic APM Service}
ARIO_APM_SERVER_EXTERNAL_PORT: {внешний порт для подключения к сервису Elastic APM Service}
ARIO_USER_ID: {ИД пользователя для запуска контейнера}
ARIO_USER_NAME: '{Имя пользователя для запуска контейнера}'
Где:
•реквизиты пользователя, от которого запускаются сервисы внутри контейнеров:
ARIO_USER_ID – идентификатор пользователя. По умолчанию используется UID пользователя, под которым была запущена команда для генерации конфигурационного файла config.yml.
ARIO_USER_NAME – имя пользователя. Значение по умолчанию admin.
По умолчанию эти реквизиты используются в параметрах USER_ID и USER_NAME для каждого сервиса;
•параметры подключения к базам данных Smart Service или Identity Service. Для этого в строках подключения к базам данных ARIO_PG_CONNECTION_STRING и ARIO_PG_CONNECTION_STRING_DIS соответственно задайте параметры:
User ID – логин для подключения к базе данных. Значение по умолчанию postgres.
Password – пароль для подключения к базе данных. Не допускается использование пустого пароля. Для корректной работы сервисов в пароле не рекомендуется использовать спецсимволы: ‘ # @ \ \ : * ? “ < > |.
Host – имя компьютера, на котором установлена СУБД. Если при установке PostgreSQL имя компьютера по умолчанию было изменено, укажите имя сервера в формате <Имя компьютера>/<Имя экземпляра>.
Port – порт для подключения к базе данных. Значение по умолчанию 5432.
Datadase – имя базы данных. Укажите имя ранее созданной базы данных или задайте имя новой. Если указать имя новой базы данных, то она создается при первом запуске сервисов. Значения по умолчанию: Ario_Smart_Service – для базы данных Smart Service; Ario_Identity_Service – для базы данных Identity Service;
•параметры подключения к RabbitMQ. На каждом сервере в строке подключения ARIO_QUEUE_CONNECTION_STRING необходимо задать одинаковые параметры:
Port – порт для подключения к RabbitMQ. Значение по умолчанию 5672.
virtualHost – виртуальный хост RabbitMQ для работы с сервисами Ario, например ario_host.
username – логин для подключения к RabbitMQ. Для установки на один сервер значение по умолчанию – guest. Для установки на нескольких серверах укажите логин вручную, так как использование учетной записи guest запрещено.
password – пароль для подключения к RabbitMQ.
ВАЖНО. Для корректной работы сервисов не рекомендуется в логине и пароле для подключения к RabbitMQ использовать спецсимволы: ‘ # @ \ \ : * ? “ < > |.
hostname – сервер, на котором установлен брокер сообщений RabbitMQ. Значение по умолчанию localhost.
Exchange – точка обмена, к которой привязываются очереди сообщений веб-сервера. Также используется для наименования очередей сообщений. Имя каждой точки должно быть уникальным и не повторять имена точек, которые добавлены в RabbitMQ по умолчанию. Задайте новую точку обмена, например Ario_Exchange. Она создается во время установки системы;
•остальные параметры:
ARIO_DATABASE_ENGINE – используемая СУБД. Значение по умолчанию postgres. Не рекомендуется менять значение параметра.
ARIO_STORAGE_SERVICE_URL – хост, на котором необходимо развернуть Directum Storage Service. Значение по умолчанию localhost.
ARIO_STORAGE_SERVICE_PORT – порт для подключения к сервису Directum Storage Service. Значение по умолчанию 9021.
ARIO_STORAGE_SERVICE_LOGIN – логин для подключения к сервису Directum Storage Service. Значение указывается автоматически при генерации конфигурационного файла config.yml.
ARIO_STORAGE_SERVICE_PASSWORD – пароль для подключения к сервису Directum Storage Service. Значение указывается автоматически при генерации конфигурационного файла config.yml.
ARIO_IDENTITY_SERVICE_PORT – порт для подключения к сервису Directum Identity Service. Значение по умолчанию 9030.
ARIO_INSTALL_PATH – относительный или полный путь до папки установки сервисов Directum Ario. Значение по умолчанию /opt/directum/ario.
ARIO_LOG_PATH – относительный или полный путь до папки с лог-файлами и файлами трассировки. Значение по умолчанию /opt/directum/ario/logs.
ARIO_ACTIVATION_KEY_PATH – относительный или полный путь до ключа активации.
ARIO_DSS_HOST – IP-адрес хоста или доменное имя контейнера с сервисом Directum Smart Service. Значение по умолчанию dss.
ARIO_DSS_PORT – порт для подключения к сервису Directum Smart Service. Значение по умолчанию 61100.
ARIO_APM_SERVER_HOST – адрес контейнера с сервисом Elastic APM Service. Значение по умолчанию elastic-apm.
ARIO_APM_SERVER_PORT – внутренний порт для подключения к сервису Directum Elastic APM Service, который используется внутри службы Docker. Значение по умолчанию 8200.
ARIO_APM_SERVER_EXTERNAL_PORT – внешний порт для подключения к сервису Directum Elastic APM Service. Значение по умолчанию 9082.
8.В конфигурационном файле config.yml в секции services_config проверьте значения параметров установки сервисов.
Структура секции services_config:
services_config:
ArioRabbitMQ:
QUEUE_CONNECTION_STRING: '{{ ARIO_QUEUE_CONNECTION_STRING }}'
LOG_PATH: '{{ ARIO_LOG_PATH }}/RabbitMQ'
USER_ID: '{{ ARIO_USER_ID }}'
ArioStorageService:
PORT: '{{ ARIO_STORAGE_SERVICE_PORT }}'
LOGIN: '{{ ARIO_STORAGE_SERVICE_LOGIN }}'
PASSWORD: '{{ ARIO_STORAGE_SERVICE_PASSWORD }}'
DATA_PATH: '{{ ARIO_INSTALL_PATH }}/etc/storage-service'
USER_ID: '{{ ARIO_USER_ID }}'
USER_NAME: '{{ ARIO_USER_NAME }}'
ArioElasticApm:
HOST: '{{ ARIO_APM_SERVER_HOST }}'
EXTERNAL_PORT: '{{ARIO_APM_SERVER_EXTERNAL_PORT}}'
PORT: '{{ ARIO_APM_SERVER_PORT }}'
TRACES_PATH: '{{ ARIO_LOG_PATH }}/traces'
USER_ID: '{{ ARIO_USER_ID }}'
ArioIdentityService:
PORT: '{{ ARIO_IDENTITY_SERVICE_PORT }}'
DATABASE_ENGINE: '{{ ARIO_DATABASE_ENGINE }}'
CONNECTION_STRING: '{{ ARIO_PG_CONNECTION_STRING_DIS }}'
APM_ENDPOINT: '{{ ARIO_APM_SERVER_HOST }}:{{ ARIO_APM_SERVER_PORT }}'
LOG_PATH: '{{ ARIO_LOG_PATH }}/IdentityService'
USER_ID: '{{ ARIO_USER_ID }}'
USER_NAME: '{{ ARIO_USER_NAME }}'
ArioSmartService:
HOST: '{{ ARIO_DSS_HOST }}'
PORT: '{{ ARIO_DSS_PORT }}'
DATABASE_ENGINE: '{{ ARIO_DATABASE_ENGINE }}'
CONNECTION_STRING: '{{ ARIO_PG_CONNECTION_STRING }}'
STORAGE_ENDPOINT: '{{ ARIO_STORAGE_SERVICE_URL }}:{{ ARIO_STORAGE_SERVICE_PORT }}'
STORAGE_LOGIN: '{{ ARIO_STORAGE_SERVICE_LOGIN }}'
STORAGE_PASSWORD: '{{ ARIO_STORAGE_SERVICE_PASSWORD }}'
APM_ENDPOINT: 'http://{{ ARIO_APM_SERVER_HOST }}:{{ ARIO_APM_SERVER_PORT }}'
IDENTITY_SERVICE: 'http://dis:{{ ARIO_IDENTITY_SERVICE_PORT }}'
QUEUE_CONNECTION_STRING: '{{ ARIO_QUEUE_CONNECTION_STRING }}'
LOG_PATH: '{{ ARIO_LOG_PATH }}/SmartService'
USER_ID: '{{ ARIO_USER_ID }}'
USER_NAME: '{{ ARIO_USER_NAME }}'
ArioPublishingService:
PORT: {Порт для подключения к сервису Publishing Service}
QUEUE_CONNECTION_STRING: '{{ ARIO_QUEUE_CONNECTION_STRING }}'
APM_ENDPOINT: '{{ ARIO_APM_SERVER_HOST }}:{{ ARIO_APM_SERVER_PORT }}'
LOG_PATH: '{{ ARIO_LOG_PATH }}/PublishingService'
USER_ID: '{{ ARIO_USER_ID }}'
USER_NAME: '{{ ARIO_USER_NAME }}'
ArioTextExtractorService:
PORT: {Порт для подключения к сервису Text Extractor Service}
QUEUE_CONNECTION_STRING: '{{ ARIO_QUEUE_CONNECTION_STRING }}'
APM_ENDPOINT: '{{ ARIO_APM_SERVER_HOST }}:{{ ARIO_APM_SERVER_PORT }}'
LOG_PATH: '{{ ARIO_LOG_PATH }}/TextExtractorService'
USER_ID: '{{ ARIO_USER_ID }}'
USER_NAME: '{{ ARIO_USER_NAME }}'
QUEUE_POLICIES:
- QUEUE_POLICY_NAME: 'ARIO_EXTRACT_TEXT_POLICY'
QUEUE_POLICY_FILTER: '(?!.*reply)ario-extract-text'
QUEUE_POLICY_VALUE: '{"consumer-timeout":86400000}'
ArioDocumentDisassemblerService:
PORT: {Порт для подключения к сервису Document Disassembler Service}
QUEUE_CONNECTION_STRING: '{{ ARIO_QUEUE_CONNECTION_STRING }}'
APM_ENDPOINT: '{{ ARIO_APM_SERVER_HOST }}:{{ ARIO_APM_SERVER_PORT }}'
LOG_PATH: '{{ ARIO_LOG_PATH }}/DocumentDisassemblerService'
USER_ID: '{{ ARIO_USER_ID }}'
USER_NAME: '{{ ARIO_USER_NAME }}'
ArioDocumentAssemblerService:
PORT: {Порт для подключения к сервису Document Assembler Service}
QUEUE_CONNECTION_STRING: '{{ ARIO_QUEUE_CONNECTION_STRING }}'
APM_ENDPOINT: '{{ ARIO_APM_SERVER_HOST }}:{{ ARIO_APM_SERVER_PORT }}'
LOG_PATH: '{{ ARIO_LOG_PATH }}/DocumentAssemblerService'
USER_ID: '{{ ARIO_USER_ID }}'
USER_NAME: '{{ ARIO_USER_NAME }}'
ArioFactExtractorService:
PORT: {Порт для подключения к сервису Fact Extractor Service}
QUEUE_CONNECTION_STRING: '{{ ARIO_QUEUE_CONNECTION_STRING }}'
APM_ENDPOINT: '{{ ARIO_APM_SERVER_HOST }}:{{ ARIO_APM_SERVER_PORT }}'
LOG_PATH: '{{ ARIO_LOG_PATH }}/FactExtractorService'
USER_ID: '{{ ARIO_USER_ID }}'
USER_NAME: '{{ ARIO_USER_NAME }}'
ArioFactExtractorRulesService:
PORT: {Порт для подключения к сервису Fact Extractor Rules Service}
QUEUE_CONNECTION_STRING: '{{ ARIO_QUEUE_CONNECTION_STRING }}?heartbeat=300'
APM_ENDPOINT: '{{ ARIO_APM_SERVER_HOST }}:{{ ARIO_APM_SERVER_PORT }}'
LOG_PATH: '{{ ARIO_LOG_PATH }}/FactExtractorRulesService'
USER_ID: '{{ ARIO_USER_ID }}'
USER_NAME: '{{ ARIO_USER_NAME }}'
ArioFactExtractorLearnService:
PORT: {Порт для подключения к сервису Fact Extractor Learn Service}
DATABASE_ENGINE: '{{ ARIO_DATABASE_ENGINE }}'
CONNECTION_STRING: '{{ ARIO_PG_CONNECTION_STRING }}'
QUEUE_CONNECTION_STRING: '{{ ARIO_QUEUE_CONNECTION_STRING }}?heartbeat=36000'
APM_ENDPOINT: '{{ ARIO_APM_SERVER_HOST }}:{{ ARIO_APM_SERVER_PORT }}'
LOG_PATH: '{{ ARIO_LOG_PATH }}/FactExtractorLearnService'
USER_ID: '{{ ARIO_USER_ID }}'
USER_NAME: '{{ ARIO_USER_NAME }}'
QUEUE_POLICIES:
- QUEUE_POLICY_NAME: 'ARIO_FACT_TRAIN_POLICY'
QUEUE_POLICY_FILTER: '(?!.*reply)ario-facts-(train|retrain)'
QUEUE_POLICY_VALUE: '{"consumer-timeout":250000000}'
ArioObjectDetectionService:
PORT: {Порт для подключения к сервису Object Detection Service}
QUEUE_CONNECTION_STRING: '{{ ARIO_QUEUE_CONNECTION_STRING }}'
APM_ENDPOINT: '{{ ARIO_APM_SERVER_HOST }}:{{ ARIO_APM_SERVER_PORT }}'
LOG_PATH: '{{ ARIO_LOG_PATH }}/ObjectDetectionService'
USER_ID: '{{ ARIO_USER_ID }}'
USER_NAME: '{{ ARIO_USER_NAME }}'
ArioImageClassifierService:
PORT: {Порт для подключения к сервису Image Classifier Service}
QUEUE_CONNECTION_STRING: '{{ ARIO_QUEUE_CONNECTION_STRING }}'
APM_ENDPOINT: '{{ ARIO_APM_SERVER_HOST }}:{{ ARIO_APM_SERVER_PORT }}'
LOG_PATH: '{{ ARIO_LOG_PATH }}/ImageClassifierService'
USER_ID: '{{ ARIO_USER_ID }}'
USER_NAME: '{{ ARIO_USER_NAME }}'
ArioTextClassifierService:
PORT: {Порт для подключения к сервису Text Classifier Service}
DATABASE_ENGINE: '{{ ARIO_DATABASE_ENGINE }}'
CONNECTION_STRING: '{{ ARIO_PG_CONNECTION_STRING }}'
QUEUE_CONNECTION_STRING: '{{ ARIO_QUEUE_CONNECTION_STRING }}'
APM_ENDPOINT: '{{ ARIO_APM_SERVER_HOST }}:{{ ARIO_APM_SERVER_PORT }}'
LOG_PATH: '{{ ARIO_LOG_PATH }}/TextClassifierService'
USER_ID: '{{ ARIO_USER_ID }}'
USER_NAME: '{{ ARIO_USER_NAME }}'
QUEUE_POLICIES:
- QUEUE_POLICY_NAME: 'ARIO_CLASSIFIER_TRAIN_POLICY'
QUEUE_POLICY_FILTER: '(?!.*reply)ario-classifier-(train|retrain)'
QUEUE_POLICY_VALUE: '{"consumer-timeout":250000000}'
Где:
ArioRabbitMQ – секция с параметрами установки брокера сообщений RabbitMQ:
•QUEUE_CONNECTION_STRING – строка подключения к RabbitMQ. По умолчанию используется значение, указанное в параметре ARIO_QUEUE_CONNECTION_STRING;
•LOG_PATH – путь до лог-файлов брокера сообщений. По умолчанию используется значение <Путь до лог-файлов>/RabbitMQ, где в качестве пути до лог-файлов используется значение параметра ARIO_LOG_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с брокером сообщений. По умолчанию используется значение, указанное в параметре ARIO_USER_ID.
ArioStorageService – секция с параметрами установки сервиса Directum Storage Service:
•PORT – порт для подключения к сервису Directum Storage Service. По умолчанию используется значение, указанное в параметре ARIO_STORAGE_SERVICE_PORT;
•LOGIN – логин для подключения к сервису Directum Storage Service. По умолчанию используется значение, указанное в параметре ARIO_STORAGE_SERVICE_LOGIN;
•PASSWORD – пароль для подключения к сервису Directum Storage Service. По умолчанию используется значение, указанное в параметре ARIO_STORAGE_SERVICE_PASSWORD;
•DATA_PATH – путь до папки, в которой хранятся файлы сервиса хранилищ. Например, лог-файлы или содержимое документов, которые передаются между сервисами Directum Ario. По умолчанию задается путь относительно папки установки сервисов, указанной в параметре ARIO_INSTALL_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_ID;
•USER_NAME – имя пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_NAME;
ArioElasticApm – секция с параметрами установки сервиса Directum Elastic APM Service:
•HOST – IP-адрес или доменное имя контейнера с сервисом Elastic APM Service. По умолчанию используется значение, указанное в параметре ARIO_APM_SERVER_HOST;
•EXTERNAL_PORT – внешний порт для подключения к сервису Directum Elastic APM Service. По умолчанию используется значение, указанное в параметре ARIO_APM_SERVER_EXTERNAL_PORT;
•PORT – внутренний порт для подключения к сервису Directum Elastic APM Service, который используется внутри службы Docker. По умолчанию используется значение, указанное в параметре ARIO_APM_SERVER_PORT;
•TRACES_PATH – папка, в которую записываются файлы трассировки запросов к сервисам Ario. По умолчанию используется значение <Путь до лог-файлов>/Traces, где в качестве пути до лог-файлов используется значение параметра ARIO_LOG_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_ID.
ArioIdentityService – секция с параметрами установки сервиса Directum Identity Service:
•PORT – порт для подключения к сервису. Значение по умолчанию 9030;
•DATABASE_ENGINE – используемая СУБД. По умолчанию используется значение, указанное в параметре ARIO_DATABASE_ENGINE;
•CONNECTION_STRING – строка подключения к базе данных Smart Service. По умолчанию используется значение, указанное в параметре ARIO_PG_CONNECTION_STRING;
•APM_ENDPOINT – URL-адрес для подключения к сервису Elastic APM Service. По умолчанию используется значение <адрес контейнера с сервисом>:<внутренний порт>, где в качестве адреса и порта используются значения, указанные в параметрах ARIO_APM_SERVER_HOST и ARIO_APM_SERVER_PORT соответственно;
•LOG_PATH – путь до лог-файлов сервиса. По умолчанию используется значение <Путь до лог-файлов>/IdentityService, где в качестве пути до лог-файлов используется значение параметра ARIO_LOG_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_ID;
•USER_NAME – имя пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_NAME;
ArioSmartService – секция с параметрами установки сервиса Directum Smart Service:
•HOST – IP-адрес или доменное имя контейнера с сервисом Directum Smart Service. По умолчанию используется значение, указанное в параметре ARIO_DSS_HOST;
•PORT – порт для подключения к сервису. Значение по умолчанию 61100;
•DATABASE_ENGINE – Тип СУБД. По умолчанию используется значение, указанное в параметре ARIO_DATABASE_ENGINE;
•CONNECTION_STRING – строка подключения к базе данных Smart Service. По умолчанию используется значение, указанное в параметре ARIO_PG_CONNECTION_STRING;
•STORAGE_ENDPOINT – URL-адрес для подключения к сервису хранения объектов Storage Service. По умолчанию используется значение <адрес контейнера с сервисом>:<внутренний порт>, где в качестве адреса и порта используются значения, указанные в параметрах ARIO_APM_SERVER_HOST и ARIO_APM_SERVER_PORT соответственно;
•STORAGE_LOGIN – логин для подключения к сервису Directum Storage Service. Подставляется значение, указанное в параметре ARIO_STORAGE_SERVICE_LOGIN;
•STORAGE_PASSWORD – пароль для подключения к сервису Directum Storage Service. Подставляется значение, указанное в параметре ARIO_STORAGE_SERVICE_PASSWORD;
•APM_ENDPOINT – URL-адрес для подключения к сервису Elastic APM Service. По умолчанию используется значение <адрес контейнера с сервисом>:<внутренний порт>, где в качестве адреса и порта используются значения, указанные в параметрах ARIO_APM_SERVER_HOST и ARIO_APM_SERVER_PORT соответственно;
•IDENTITY_SERVICE – адрес сервиса Identity Service. Рекомендуется не менять значение по умолчанию localhost;
•QUEUE_CONNECTION_STRING – строка подключения к RabbitMQ. Подставляется значение, указанное для параметра ARIO_QUEUE_CONNECTION_STRING;
•LOG_PATH – путь до лог-файлов сервиса. По умолчанию используется значение <Путь до лог-файлов>/SmartService, где в качестве пути до лог-файлов используется значение параметра ARIO_LOG_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_ID;
•USER_NAME – имя пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_NAME;
ArioPublishingService – секция с параметрами установки сервиса Directum Publishing Service:
•PORT – порт для подключения к сервису. Значение по умолчанию 9057;
•QUEUE_CONNECTION_STRING – строка подключения к RabbitMQ. По умолчанию используется значение, указанное в параметре ARIO_QUEUE_CONNECTION_STRING;
•APM_ENDPOINT – URL-адрес для подключения к сервису Elastic APM Service. По умолчанию используется значение <адрес контейнера с сервисом>:<внутренний порт>, где в качестве адреса и порта используются значения, указанные в параметрах ARIO_APM_SERVER_HOST и ARIO_APM_SERVER_PORT соответственно;
•LOG_PATH – путь до лог-файлов сервиса. По умолчанию используется значение <Путь до лог-файлов>/PublishingService, где в качестве пути до лог-файлов используется значение параметра ARIO_LOG_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_ID;
•USER_NAME – имя пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_NAME;
ArioTextExtractorService – секция с параметрами установки сервиса Directum Text Extractor Service:
•PORT – порт для подключения к сервису. Значение по умолчанию 9027;
•QUEUE_CONNECTION_STRING – строка подключения к RabbitMQ. По умолчанию используется значение, указанное в параметре ARIO_QUEUE_CONNECTION_STRING;
•APM_ENDPOINT – URL-адрес для подключения к сервису Elastic APM Service. По умолчанию используется значение <адрес контейнера с сервисом>:<внутренний порт>, где в качестве адреса и порта используются значения, указанные в параметрах ARIO_APM_SERVER_HOST и ARIO_APM_SERVER_PORT соответственно;
•LOG_PATH – путь до лог-файлов сервиса. По умолчанию используется значение <Путь до лог-файлов>/TextExtractorService, где в качестве пути до лог-файлов используется значение параметра ARIO_LOG_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_ID;
•USER_NAME – имя пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_NAME;
•QUEUE_POLICIES – секция с настройкой политик RabbitMQ. Значения по умолчанию:
QUEUE_POLICIES:
QUEUE_POLICY_NAME: 'ARIO_EXTRACT_TEXT_POLICY'
QUEUE_POLICY_FILTER: '(?!.*reply)ario-extract-text'
QUEUE_POLICY_VALUE: '{"consumer-timeout":86400000}'
ArioDocumentDisassemblerService – секция с параметрами установки сервиса Directum Document Disassembler Service:
•PORT – порт для подключения к сервису. Значение по умолчанию 9028;
•QUEUE_CONNECTION_STRING – строка подключения к RabbitMQ. По умолчанию используется значение, указанное в параметре ARIO_QUEUE_CONNECTION_STRING;
•APM_ENDPOINT – URL-адрес для подключения к сервису Elastic APM Service. По умолчанию используется значение <адрес контейнера с сервисом>:<внутренний порт>, где в качестве адреса и порта используются значения, указанные в параметрах ARIO_APM_SERVER_HOST и ARIO_APM_SERVER_PORT соответственно;
•LOG_PATH – путь до лог-файлов сервиса. По умолчанию используется значение <Путь до лог-файлов>/DocumentDisassemblerService, где в качестве пути до лог-файлов используется значение параметра ARIO_LOG_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_ID;
•USER_NAME – имя пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_NAME;
ArioDocumentAssemblerService – секция с параметрами установки сервиса Directum Document Assembler Service:
•PORT – порт для подключения к сервису. Значение по умолчанию 9029;
•QUEUE_CONNECTION_STRING – строка подключения к RabbitMQ. По умолчанию используется значение, указанное в параметре ARIO_QUEUE_CONNECTION_STRING;
•APM_ENDPOINT – URL-адрес для подключения к сервису Elastic APM Service. По умолчанию используется значение <адрес контейнера с сервисом>:<внутренний порт>, где в качестве адреса и порта используются значения, указанные в параметрах ARIO_APM_SERVER_HOST и ARIO_APM_SERVER_PORT соответственно;
•LOG_PATH – путь до лог-файлов сервиса. По умолчанию используется значение <Путь до лог-файлов>/DocumentAssemblerService, где в качестве пути до лог-файлов используется значение параметра ARIO_LOG_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_ID;
•USER_NAME – имя пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_NAME;
ArioFactExtractorService – секция с параметрами установки сервиса Directum Fact Extractor Base Service:
•PORT – порт для подключения к сервису. Значение по умолчанию 9017;
•QUEUE_CONNECTION_STRING – строка подключения к RabbitMQ. По умолчанию используется значение, указанное в параметре ARIO_QUEUE_CONNECTION_STRING;
•APM_ENDPOINT – URL-адрес для подключения к сервису Elastic APM Service. По умолчанию используется значение <адрес контейнера с сервисом>:<внутренний порт>, где в качестве адреса и порта используются значения, указанные в параметрах ARIO_APM_SERVER_HOST и ARIO_APM_SERVER_PORT соответственно;
•LOG_PATH – путь до лог-файлов сервиса. По умолчанию используется значение <Путь до лог-файлов>/FactExtractorService, где в качестве пути до лог-файлов используется значение параметра ARIO_LOG_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_ID;
•USER_NAME – имя пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_NAME;
ArioFactExtractorRulesService – секция с параметрами установки сервиса Directum Fact Extractor Rules Service:
•PORT – порт для подключения к сервису. Значение по умолчанию 9018;
•QUEUE_CONNECTION_STRING – строка подключения к RabbitMQ. По умолчанию используется значение, указанное в параметре ARIO_QUEUE_CONNECTION_STRING;
•APM_ENDPOINT – URL-адрес для подключения к сервису Elastic APM Service. По умолчанию используется значение <адрес контейнера с сервисом>:<внутренний порт>, где в качестве адреса и порта используются значения, указанные в параметрах ARIO_APM_SERVER_HOST и ARIO_APM_SERVER_PORT соответственно;
•LOG_PATH – путь до лог-файлов сервиса. По умолчанию используется значение <Путь до лог-файлов>/FactExtractorRulesService, где в качестве пути до лог-файлов используется значение параметра ARIO_LOG_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_ID;
•USER_NAME – имя пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_NAME;
ArioFactExtractorLearnService – секция с параметрами установки сервиса Directum Fact Extractor Learn Service:
•PORT – порт для подключения к сервису. Значение по умолчанию 9019;
•DATABASE_ENGINE – Тип СУБД. По умолчанию используется тип, указанный в параметре ARIO_DATABASE_ENGINE;
•CONNECTION_STRING – строка подключения к базе данных Smart Service. По умолчанию используется значение, указанное в параметре ARIO_PG_CONNECTION_STRING;
•QUEUE_CONNECTION_STRING – строка подключения к RabbitMQ. По умолчанию используется значение, указанное в параметре ARIO_QUEUE_CONNECTION_STRING;
•APM_ENDPOINT – URL-адрес для подключения к сервису Elastic APM Service. По умолчанию используется значение <адрес контейнера с сервисом>:<внутренний порт>, где в качестве адреса и порта используются значения, указанные в параметрах ARIO_APM_SERVER_HOST и ARIO_APM_SERVER_PORT соответственно;
•LOG_PATH – путь до лог-файлов сервиса. По умолчанию используется значение <Путь до лог-файлов>/FactExtractorLearnService, где в качестве пути до лог-файлов используется значение параметра ARIO_LOG_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_ID;
•USER_NAME – имя пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_NAME;
•QUEUE_POLICIES – секция с настройкой политик RabbitMQ. Значения по умолчанию:
QUEUE_POLICIES:
QUEUE_POLICY_NAME: 'ARIO_FACT_TRAIN_POLICY'
QUEUE_POLICY_FILTER: '(?!.*reply)ario-facts-(train|retrain)'
QUEUE_POLICY_VALUE: '{"consumer-timeout":250000000}'
ArioObjectDetectionService – секция с параметрами установки сервиса Directum Object Detection Service:
•PORT – порт для подключения к сервису. Значение по умолчанию 9047;
•QUEUE_CONNECTION_STRING – строка подключения к RabbitMQ. По умолчанию используется значение, указанное в параметре ARIO_QUEUE_CONNECTION_STRING;
•APM_ENDPOINT – URL-адрес для подключения к сервису Elastic APM Service. По умолчанию используется значение <адрес контейнера с сервисом>:<внутренний порт>, где в качестве адреса и порта используются значения, указанные в параметрах ARIO_APM_SERVER_HOST и ARIO_APM_SERVER_PORT соответственно;
•LOG_PATH – путь до лог-файлов сервиса. По умолчанию используется значение <Путь до лог-файлов>/ObjectDetectionService, где в качестве пути до лог-файлов используется значение параметра ARIO_LOG_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_ID;
•USER_NAME – имя пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_NAME;
ArioImageClassifierService – секция с параметрами установки сервиса Directum Image Classifier Service:
•PORT – порт для подключения к сервису. Значение по умолчанию 9008;
•QUEUE_CONNECTION_STRING – строка подключения к RabbitMQ. По умолчанию используется значение, указанное в параметре ARIO_QUEUE_CONNECTION_STRING;
•APM_ENDPOINT – URL-адрес для подключения к сервису Elastic APM Service. По умолчанию используется значение <адрес контейнера с сервисом>:<внутренний порт>, где в качестве адреса и порта используются значения, указанные в параметрах ARIO_APM_SERVER_HOST и ARIO_APM_SERVER_PORT соответственно;
•LOG_PATH – путь до лог-файлов сервиса. По умолчанию используется значение <Путь до лог-файлов>/ImageClassifierService, где в качестве пути до лог-файлов используется значение параметра ARIO_LOG_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_ID;
•USER_NAME – имя пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_NAME;
ArioTextClassifierService – секция с параметрами установки сервиса Directum Text Classifier Service:
•PORT – порт для подключения к сервису. Значение по умолчанию 9007;
•DATABASE_ENGINE – Тип СУБД. По умолчанию используется тип, указанный в параметре ARIO_DATABASE_ENGINE;
•CONNECTION_STRING – строка подключения к базе данных Smart Service. По умолчанию используется значение, указанное в параметре ARIO_PG_CONNECTION_STRING.
•QUEUE_CONNECTION_STRING – строка подключения к RabbitMQ. По умолчанию используется значение, указанное в параметре ARIO_QUEUE_CONNECTION_STRING;
•APM_ENDPOINT – URL-адрес для подключения к сервису Elastic APM Service. По умолчанию используется значение <адрес контейнера с сервисом>:<внутренний порт>, где в качестве адреса и порта используются значения, указанные в параметрах ARIO_APM_SERVER_HOST и ARIO_APM_SERVER_PORT соответственно;
•LOG_PATH – путь до лог-файлов сервиса. По умолчанию используется значение <Путь до лог-файлов>/TextClassifierService, где в качестве пути до лог-файлов используется значение параметра ARIO_LOG_PATH;
•USER_ID – идентификатор пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_ID;
•USER_NAME – имя пользователя, от которого запускается контейнер с сервисом. По умолчанию используется значение, указанное в параметре ARIO_USER_NAME;
•QUEUE_POLICIES – секция с настройкой политик RabbitMQ. Значения по умолчанию:
QUEUE_POLICIES:
QUEUE_POLICY_NAME: 'ARIO_CLASSIFIER_TRAIN_POLICY'
QUEUE_POLICY_FILTER: '(?!.*reply)ario-classifier-(train|retrain)'
QUEUE_POLICY_VALUE: '{"consumer-timeout":250000000}'
При необходимости скорректируйте значения.
9.По умолчанию при установке сервисов настраиваются политики брокера сообщений RabbitMQ. Если он используется на отдельном сервере, политики настраиваются на стороне брокера сообщений, а из настроек сервисов Directum Ario их нужно удалить. Для этого в секциях ArioTextExtractorService, ArioFactExtractorLearnService и ArioTextClassifierService удалите секцию с настройкой политики RabbitMQ QUEUE_POLICIES.
10.Установите сервисы Directum Ario. Для этого выполните команду:
./do.sh ario install
11.Дождитесь окончания установки.
СОВЕТ. В зависимости от конфигурации оборудования меняется время запуска сервисов Directum Ario. Иногда Directum Launcher может прекратить установку, потому что не дожидается запуска сервисов. В результате модели классификации и извлечения фактов не импортируются. В этом случае проверьте состояние сервисов Directum Ario. Если сервисы запустились, импортируйте модели классификации и извлечения фактов вручную.
12.Если используется учетная запись без привилегий суперпользователя, выдайте другим пользователям (Other) права на запись в папки, созданные при установке сервисов Directum Ario: etc, logs и dataset. Они расположены в папке установки сервисов. Это необходимо, так как запись файлов в эти папки будет выполняться от пользователей с разными идентификаторами.
13.Добавьте рассчитанные лимиты объема оперативной памяти для Directum Text Extractor Service и Directum Fact Extractor Learn Service в конфигурационный файл deploy.yml, который располагается в папке установки сервисов Directum Ario. Подробнее о расчете памяти см. в типовых требованиях к сервисам Ario в документе «Directum RX. Типовые требования к аппаратному и программному обеспечению». Для этого измените значение параметра memory в соответствующих секциях файла, указав рассчитанный объем в байтах.
ПРИМЕЧАНИЕ. Чтобы в параметре memory указать значение в мегабайтах или гигабайтах, после числа введите m или g соответственно. Например, для лимита оперативной памяти 16384 мегабайта будет соответствовать значение 16384m.
В конфигурационном файле deploy.yml настройки сервиса Directum Text Extractor Service соответствует секция dtes, сервису Directum Fact Extractor Learn Service – dfesl:
deploy:
mode: replicated
replicas: ${dtes_replicas}
placement:
constraints:
- "node.labels.service == ${dtes_node_label}"
max_replicas_per_node: 1
restart_policy:
condition: any
delay: 15s
window: 180s
resources:
limits:
memory: 16384m
Примечание. Если для распознавания и обучения используется два экземпляра сервиса Directum Fact Extractor Learn Service, то в первом случае лимит оперативной памяти имеет постоянное значение – 2 ГБ. Лимит оперативной памяти для обучения определяется с учетом количества обрабатываемых документов.
Если для распознавания и обучения используется один экземпляр Directum Fact Extractor Learn Service, лимит оперативной памяти для распознавания также будет равен 2 ГБ, а итоговый лимит памяти равен объему памяти для обучения согласно таблице конфигурации оборудования для сервиса Directum Fact Extractor Learn Service. Подробнее о расчете памяти см. в типовых требованиях к сервисам Ario в документе «Directum RX. Типовые требования к аппаратному и программному обеспечению». Например, при 2 ГБ для распознавания и 16 ГБ для обучения на 400 документах итоговый лимит 16 ГБ. Таким образом, итоговый лимит равен наибольшему значению лимита для экземпляра сервиса.
14.Убедитесь, что в параметрах конфигурационного файла .env указаны значения:
•timezone – текущий часовой пояс;
•dss_allow_local_path – true;
•dtcs_allow_local_path – True.
15.Если дополнительно необходимо изменить другие настройки определенного сервиса, внесите корректировки в конфигурационный файл .env в соответствующую секцию. Например, чтобы изменить время хранения ссылок на объекты, внесите изменения в секцию SmartService в параметр dss_storage_uri_lifetime_seconds.
16.После изменения настроек перезапустите сервисы. Для этого сначала остановите работу сервисов:
./do.sh ario stop
Затем повторно запустите сервисы:
./do.sh ario start
В результате сервисы запустятся с учетом обновленных настроек в конфигурационном файле.
В результате установки:
•из архива загружаются docker-образы;
•запускаются контейнеры с сервисами Directum Ario;
•автоматически импортируются базовые модели извлечения фактов и базовые модели классификации документов.
© Компания Directum, 2024 |