Since Starting from version 1.9.8.2.10, DMS uses utilizes an external worker container to create generate previews and parse emails. To deploy it correctly in existing environments, deploy_script must be updated to the latest preview branch and next lines must be added to containers.conf. Please use the latest image version that is available at the moment of deployment.
Please use preview tag for nuxeo and cb image versions before 1.9.8.2.10 is released.
This container requires a minimum of 4GB of free RAM in addition to the necessary overhead for Docker and other applications. Please ensure that your system meets these requirements.
The procedure:
- Pull latest version of config repository
- Pull latest version of deploy_script repository
Update the
Edit thecommands.conf file by
insertingadding the
code lines as seen below if they don't exist yet- Configure the right nuxeo and cb image
- go to deploy_script, use command "git pull" before then changing branch.
- Currently, (as of 23.02.2023) it is necessary to use the "1.9.8.2.10-rc" branch tag, as it is the only branch where the deploy script includes the worker container.
- Change branch (git checkout <branchtag>)
- Do a proper redeployment of the system
following code block after the add_variable "ES_JAVA_OPTS" "-Xms${ES_XMS} -Xmx${ES_XMX}" line, if it does not already exist:
Code Block language bash title commands.conf elif [ ${1} = "WORKER" ] then add_volume ${NUXEO_TEMPDIR} "/tmp" add_volume ${NUXEO_WINFONTDIR} "/usr/share/fonts/custom-fonts" add_volume ${NUXEO_WINFONTDIR} "/root/.windows_fonts" add_
...
volume ${NUXEO_LOGDIR} "/var/log/worker"
- Configure the nuxeo and cb images to use version 1.9.8.2.10.
- Perform a proper system redeployment.
Troubleshooting:
If the worker container constantly restarts, it may be due to an outdated Docker version.
To resolve this issue, execute a yum update. If the Docker service does not start, you may need to create or update the /etc/docker/daemon.json file with the following content:
Code Block | ||
---|---|---|
| ||
{
"storage-driver": "devicemapper"
} |
Changelog for administrators
- Nuxeo Default Fulltext Functionality Disabled: The default fulltext functionality in Nuxeo has been disabled due to excessive CPU and IO load and an increase in Nuxeo database entries. This change also disables the 'Filter' feature in the folder view of the Nuxeo Console, which was occasionally used by administrators. Instead, please use the Nuxeo Search page or provide the direct path in the URL.
Option to Disable Default Nuxeo Audit Log: The default Nuxeo audit log, which can produce excessive entries in the Nuxeo database's nxp_logs table, can now be disabled. This change disables the document history in the Nuxeo Console. To disable the audit log, add the following line to dms.conf:
Code Block DISABLE_NXP_LOGS=true
It is highly recommended to disable the audit log when updating to this and future versions, as it consumes significant disk space and generates excessive IO and CPU load
Only keep the audit log enabled if the client utilizes Nuxeo document history.
Audit logs are disabled by default for all new repositories.
To free up space used by audit logs, execute the following command:
Code Block docker exec postgres psql -d nuxeo -U postgres -c "TRUNCATE nxp_logs CASCADE;"
- User Access Logging Enabled by Default: The enable.user.access.logging entry in PAT_DMS_SETTINGS is now set to true by default, providing a replacement for the audit log.
- Parallel Execution of Sweepers: Sweepers can now be run in parallel. In previous versions up to 1.9.8.2.9, sweepers were executed sequentially.
Deploy script changelog
- New DMS_IMAGE_VERSION Variable: A new DMS_IMAGE_VERSION variable is available for dms.conf. If provided, this version will be used for Nuxeo, CaseBrowser, and worker containers. When deploying a Nuxeo or CaseBrowser container, a new worker container will be deployed with the same version as the Nuxeo container. Old image versions variables are still supported.
- Worker container: On deployment of nuxeo or casebrowser container, new worker container will be deployed with version equal to the nuxeo container version.
- Deprecated CLI Options:
- The -rmc option is deprecated. The deploy script now always deletes unused containers.
- The -rmi option is deprecated. The deploy script now always deletes unused images.
- The -v, -vv, and -vvvv options are deprecated. Only the -vvv option is available for deployment in DEBUG log mode.
- Debug Mode Limitations: The production environment should be run without the -vvv option, as the DEBUG level of logs generates excessive load on the filesystem and CPU. The -vvv option should only be used upon request from the PaceIP support team.
- NX_XMS and CB_XMS variables are deprecated: NX_XMX and CB_XMX will be used instead to define minimal heap size of java processes.