Debugging Kolab Sync

The kolab sync process creates new mailboxes and new domains, when they are created in the Kolab Webadmin. It periodically checks the LDAP directory for changes, and then adds the domains and mailboxes to Cyrus IMAP.

Sometimes, the sync fails, and it is good to see why the process hangs.

To test this, run these commands:

systemctl stop kolabd
kolab -d 9 sync 2>&1 | tee kolab-sync.log
systemctl start kolabd

This is the code for the kolabd service:

• https://cgit.kolab.org/pykolab/tree/kolabd/__init__.py#n236

The code for the commandline sync starts here:

• https://git.kolab.org/pykolab/tree/pykolab/cli/cmd_sync.py

Synchronization happens here:

• https://cgit.kolab.org/pykolab/tree/pykolab/auth/ldap/__init__.py#n1049

mailbox folders are created here (user_mailbox_create):

• https://cgit.kolab.org/pykolab/tree/pykolab/imap/__init__.py

The log is written to:

• /var/log/kolab/pykolab.log

Timing:

• if you add or delete a domain, in the default setup, it can take up to 10 minutes for the change to take effect (https://git.kolab.org/pykolab/tree/kolabd/__init__.py#n272)
• if you restart the kolabd service, it takes in the default setup 10 seconds per existing domain, for kolabd to become ready for adding new mailboxes etc (https://git.kolab.org/pykolab/tree/kolabd/__init__.py#n287)