Alfresco SOLR Index Checker

This is an experimental project to check the indexation coverage for an Alfresco Repository DB.

This project is not intended to be used in any production system (yet).

The project has been designed with the "No Database Row Were Harmed in the Fixing of This Solr Index" principle.

Additional resources to verify SOLR consistency against DB available in https://github.com/evasques/alfresco-search-services-inspector-script

Configuring

Alfresco JDBC and SOLR Endpoint can be configured in src/main/resources/application.properties

# Alfresco Database
spring.datasource.url=jdbc:postgresql://localhost/alfresco
spring.datasource.username=alfresco
spring.datasource.password=alfresco
spring.datasource.driver-class-name=org.postgresql.Driver

# Alfresco SOLR endpoint
solr.url=http://localhost:8983/solr
# Communication mode (NONE, HTTPS, SECRET)
solr.comms=NONE

When using SECRET communication mode for SOLR, use following settings:

solr.comms=SECRET
# Add secret word (only to be used for solr.comms=SECRET)
solr.secret=secret

When using HTTPS (mTLS) communication mode for SOLR, use following settings:

solr.comms=HTTPS
# mTLS / HTTPS keystores (only to be used for solr.comms=HTTPS)
solr.mtls.keystore.path=/opt/alfresco/keystores/ssl.keystore
solr.mtls.keystore.type=JCEKS
solr.mtls.keystore.pass=keystore
solr.mtls.truststore.path=/opt/alfresco/keystores/ssl.truststore
solr.mtls.truststore.type=JCEKS
solr.mtls.truststore.pass=truststore

Use ssl.keystore and ssl.truststore files from your Alfresco Repository deployment and use also the same settings for pass and type properties

This program validates the number of nodes and permissions in Alfresco Database and SOLR. Every validation can be enabled or disabled with the following properties (also available in application.properties):

# Validation options (true / false)
validation.nodes=true
validation.permissions=true

When the property report.detailed in this properties file is set to true, a list including the dbIds and the aclIds different in SOLR and Database is produced.

# Produce detail report on missing nodes or documents (true / false)
report.detailed=true

When the property run.fix.actions in this properties file is set to true, fixing actions are applied to SOLR Index:

• DELETE documents (NODE or ACL) existing in SOLR but missing in DB
• REINDEX nodes (NODE or ACL) existing in DB but missing in SOLR

run.fix.actions=true

Compiling

Java 11 is required.

$ mvn clean package

Execution

$ java -jar target/index-checker-0.0.1-SNAPSHOT.jar

org.alfresco.indexchecker.App            : Count SOLR document = 815
org.alfresco.indexchecker.App            : Count DB nodes = 815
org.alfresco.indexchecker.App            : Count SOLR permissions = 57
org.alfresco.indexchecker.App            : Count DB permissions = 58

If all the validations are passing, no additional messages are logged.

If some of the types has a different count in SOLR than in DB, error messages like the following one are logged.

SOLR indexed 201 nodes more than the existing in database for {http://www.alfresco.org/model/content/1.0}content
SOLR indexed 393 nodes more than the existing in database for {http://www.alfresco.org/model/content/1.0}failedThumbnail
SOLR indexed 2 nodes more than the existing in database for {http://www.alfresco.org/model/content/1.0}folder

The database contains 1 acls more than the indexed in SOLR

When using report.detailed option, additional details are provided.

AclIds present in DB but missed in SOLR [15]

Using parameters from command line

Values configured in application.properties can be overridden from command line using the following syntax.

$ java -jar target/index-checker-0.0.1-SNAPSHOT.jar --validation.nodes=false