Running ZeXtras Suite on Zimbra Network Edition

From ZeXtras Suite Wiki

Jump to: navigation, search
Language: English  • español • português
Zextras logo box.png
ZeXtras Suite
Latest Version: 2.4.9
Released on: May 12th, 2017
Compatibility List
Changelog
FAQ
License Management

ZeXtras Suite and Zimbra Network Edition

While ZeXtras Suite has been specifically designed to satisfy the needs of Zimbra Open Source Edition users, it's also 100% compatible with Zimbra Network Edition.

The install process and usage is exactly the same on both editions, but some module-specific measures and limitations apply.

ZeXtras Backup

Due to the huge difference in Zimbra Network Edition's and ZeXtras Suite's backup feature, the two are 100% compatible. This means that there will be no conflicts in having both active.

Warning.png Warning!

Installing ZeXtras Suite will NOT disable Zimbra Network Edition's backup system. For more information about how to manage Zimbra NE's backup refer to your Zimbra release's Administration Guide

RedoLog management

The RedoLog feature is entirely managed by Zimbra itself, both on NE and OSE.

Both in Zimbra Network Edition and in Zimbra Open Source Edition, redologs are rotated according to a set of rules defined by the following properties:

<attr id="78" name="zimbraRedoLogRolloverFileSizeKB" type="integer" min="0" cardinality="single" optionalIn="globalConfig,server" flags="serverInherited" requiresRestart="mailbox">
<globalConfigValue>1048576</globalConfigValue>
  <desc>
  redo.log file becomes eligible for rollover over when it goes over this size
  </desc>
</attr>
<attr id="1020" name="zimbraRedoLogRolloverMinFileAge" type="integer" min="0" cardinality="single" optionalIn="globalConfig,server" flags="serverInherited" requiresRestart="mailbox" since="5.0.17">
  <globalConfigValue>60</globalConfigValue 
  <desc>
    minimum age in minutes for redo.log file before it becomes eligible for rollover based on size
  </desc>
</attr>
<attr id="1021" name="zimbraRedoLogRolloverHardMaxFileSizeKB" type="integer" min="0" cardinality="single" optionalIn="globalConfig,server" flags="serverInherited" requiresRestart="mailbox" since="5.0.17">
  <globalConfigValue>4194304</globalConfigValue>
  <desc>
    redo.log file rolls over when it goes over this size, even if it does not meet the minimum file age requirement
  </desc>
</attr>

In addition to this, In Zimbra Network Edition, redologs are rotated/archived when an incremental backup is performed, and any archived redolog is moved to the backup directory.


The main difference between Zimbra NE and Zimbra OSE is that while in Zimbra OSE redologs are deleted right after being rotated, in Zimbra NE redologs are moved to the backup directory when an incremental backup is ran. You can change this behaviour by editing the following property:

<attr id="251" name="zimbraRedoLogDeleteOnRollover" type="boolean" cardinality="single" optionalIn="globalConfig,server" flags="serverInherited" requiresRestart="mailbox">
  <globalConfigValue>TRUE</globalConfigValue>
  <desc>
    whether logs are delete on rollover or archived
  </desc>
</attr>

This is set by default to "false" on NE and to "true" on OSE. Setting it to "true" will delete a redolog file upon rollover instead of archiving it.

RedoLog Size during an External Restore

During an external restore, all items are injected in the appropriate mailboxes. This causes the RedoLog file to grow in size, so in order to avoid filling-up your disk with logs the following measures are suggested:

  • Tweak the zimbraRedoLogRolloverHardMaxFileSizeKB property to an appropriate value on both Zimbra NE and Zimbra OSE.
  • Set the zimbraRedoLogDeleteOnRollover to true when importing data on Zimbra NE


Warning.png Warning!

In order to improve External Restore performances, it's possible to disable the RedoLog feature to achieve lower I/O overhead and memory usage. In order to do so, set the "zimbraRedoLogEnabled" property (see below) to "false". Don't forget to enable this feature after the restore is completed. This is only for advanced users, please don't mess with the RedoLogs unless you know what you are doing.

Other RedoLog-related properties

Other than the aforementioned, there are some more configuration properties regarding the redolog feature:

<attr id="74" name="zimbraRedoLogEnabled" type="boolean" cardinality="single" optionalIn="globalConfig,server" flags="serverInherited" requiresRestart="mailbox">
  <globalConfigValue>TRUE</globalConfigValue>
  <desc>
    whether redo logging is enabled
  </desc>
</attr>

<attr id="75" name="zimbraRedoLogLogPath" type="string" max="256" cardinality="single" optionalIn="globalConfig,server" flags="serverInherited" requiresRestart="mailbox">
  <globalConfigValue>redolog/redo.log</globalConfigValue>
  <desc>
    name and location of the redolog file
  </desc>
</attr>

<attr id="76" name="zimbraRedoLogArchiveDir" type="string" max="256" cardinality="single" optionalIn="globalConfig,server" flags="serverInherited" requiresRestart="mailbox">
  <globalConfigValue>redolog/archive</globalConfigValue>
  <desc>
    redolog rollover destination
  </desc>
</attr>

<attr id="79" name="zimbraRedoLogFsyncIntervalMS" type="integer" min="0" cardinality="single" optionalIn="globalConfig,server" flags="serverInherited" requiresRestart="mailbox">
  <globalConfigValue>10</globalConfigValue>
  <desc>
    how frequently writes to redo log get fsynced to disk
  </desc>
</attr>

<attr id="225" name="zimbraRedoLogProvider" type="string" max="256" cardinality="multi" optionalIn="globalConfig,server" flags="serverInherited" requiresRestart="mailbox">
  <desc>
    provider class name for redo logging
  </desc>
</attr>

<attr id="1009" name="zimbraRedoLogCrashRecoveryLookbackSec" type="integer" min="0" cardinality="single" optionalIn="globalConfig,server" flags="serverInherited" requiresRestart="mailbox" since="6.0.0_BETA2">
  <globalConfigValue>10</globalConfigValue>
  <desc>
    how many seconds worth of committed redo ops to re-execute during crash recovery; related to mysql parameter innodb_flush_log_at_trx_commit=0
  </desc>
</attr>

Extreme caution is advised when dealing with this properties, especially with the latter 3 of the list.

ZeXtras Mobile

The ZxMobile module is disabled by default on Zimbra Network Edition. In order to activate it you must press the "Start" button near "ZxMobile" in the "Modules" section of the Core tab in the ZeXtras Administration Zimlet.

After enabling the module's automatic startup, you need to run the following ZeXtras CLI command and manually restart the mailboxd service:

zxsuite core setProperty ZxCore_OverrideNEMobile true

Enabling the ZeXtras Mobile module will override and deactivate all Zimbra Mobile functions.

This procedure is fully reversible, as disabling the ZxMobile and running the following command

zxsuite core setProperty ZxCore_OverrideNEMobile false

will reactivate all Zimbra Mobile functions (a mailboxd service restart is required in order for this change to take effect).

Using ZeXtras Mobile on Zimbra Network Edition

Once the module is activated, it works exactly as it does on Zimbra Open Source Edition.

ZeXtras Powerstore

The ZxMobile module is disabled by default on Zimbra Network Edition. In order to activate it you must press the "Enable" button near "ZxPowerstore" in the "Modules" section of the Core tab in the ZeXtras Administration Zimlet.

After enabling the module's automatic startup, you need to run the following ZeXtras CLI command and manually restart the mailboxd service:

zxsuite powerstore setProperty ZxPowerstore_EnableHsmOnNe true

Using ZeXtras Powerstore on Zimbra Network Edition

The same policies are shared between ZeXtras Powerstore and Zimbra's own HSM engine.

The two processes (Zimbra's zmhsm and ZeXtras Powerstore's doMoveBlobs) are compatible, but running both concurrently will likely cause a high load on the server's I/O and will be pretty much useless, since as previously stated the two share the same policies.

ZeXtras Admin

Starting from Zextras Suite 2.4.0, the ZeXtras Admin module is now available on Zimbra Network Edition.

Migrating from Zimbra NE to Zimbra OSE

After migrating from a Zimbra Network Edition server to a Zimbra Open Source Edition one, many unneeded (and potentially troublesome) ACLs will be still set in your users/domains settings. To reset such ACLs, run the `zxsuite core doDeleteAllDelegatedRights` command as the 'zimbra' user.

This will also reset any ZeXtras Admin setting, so make sure to use it BEFORE setting up the Zextras Admin module.

ZeXtras Chat

The ZeXtras Chat module is 100% compatible with Zimbra Network Edition, and it works exactly as it does on Zimbra Open Source Edition.

Personal tools