OX6:Update to 6 22: Difference between revisions

From Open-Xchange
No edit summary
m (Choeger moved page Update to 6 22 to OX6:Update to 6 22)
 
(56 intermediate revisions by 8 users not shown)
Line 1: Line 1:
= Update and Installation Open-Xchange Server v6.22 =
= Open-Xchange Server v6.22 - Update and Installation  =


The new Open-Xchange Server v6.22 is the first step on the way to the next generation Open-Xchange Server 7. The update provides a new and improved Open-Xchange Server backend with enhancements for both generations.  
The new Open-Xchange Server v6.22 is the first step on the way to the next generation Open-Xchange App Suite. The update provides a new and improved Open-Xchange Server backend with enhancements for both generations.  


Especially on the backend, Open-Xchange implemented various changes and improvements like a new and clear structure for the configuration files and packages, an improved exception framework, unified OSGi, etc.
Especially on the backend, Open-Xchange implemented various changes and improvements like a new and clear structure for the configuration files and packages, an improved exception framework, unified OSGi, etc.
Line 9: Line 9:
'''Please read the different articles and manuals regarding the update. We encourage administrators of Open-Xchange 6 v6.20.x to install this update. The further feature development will be based on v6.22'''
'''Please read the different articles and manuals regarding the update. We encourage administrators of Open-Xchange 6 v6.20.x to install this update. The further feature development will be based on v6.22'''


'''Furthermore, Open-Xchange provides the complete v6.22 materials as a document which is available here: [http://software.open-xchange.com/OX6/6.22/doc Software Repository].'''
'''Custom Packages: Unfortunately custom packages will not be ready with 6.22 release. If you have custom packages provided by Open-Xchange, please discuss with your Open-Xchange contact when these packages will be available for 6.22.'''
 
'''Custom Plugins: If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles please check the information about necessary code and packaging changes below.'''
 
'''Furthermore, Open-Xchange provides the complete v6.22 materials as a document which is available here: [http://software.open-xchange.com/OX6/6.22/doc/OX6-Backend-Porting-Guide-English-v6.22.pdf Software Repository].'''


= Supported Update Path =
= Supported Update Path =
Line 19: Line 23:
|-
|-
|v6.20.7
|v6.20.7
|v6.22.x
|v6.22.0
|[[File:check.gif]]
|[[File:check.gif]]
|-
|v6.20.7
|>= v6.22.1
|[[File:cross.gif]]
|-
|-
|v6.20.x
|v6.20.x
Line 36: Line 44:
|}
|}


(1) If you don't [http://oxpedia.org/wiki/index.php?title=UpdatingOXPackages update to 6.20.7] before you start the 6.22 update, it is possible that some important scripts have not run on your system(s) and configuration options might be missing. See HERE for a list of changes that were done during the updates between 6.20.x versions
(1) If you don't [http://oxpedia.org/wiki/index.php?title=UpdatingOXPackages update to 6.20.7] before you start the 6.22 update, it is possible that some important scripts have not run on your system(s) and configuration options might be missing. If you have already updated to 6.22 from an v6.20 version earlier than 6.20.7 and you are experiencing problems, please contact Open-Xchange Support.


= Rollback =
= Rollback =


Please note that after updating to 6.22 there is no way to get back to an earlier version of Open-Xchange. Please make sure that you have a backup. (TODO)
Please note that after updating to 6.22 there is no way to get back to an earlier version of Open-Xchange. Please make sure that you have a full backup of your Open-Xchange installation(s).
 
 
= Cluster setups =
 
If you have several Open-Xchange systems in a cluster setup, you need to shut down all of them before attempting the upgrade. Parallel operation of v6.20 and v6.22 nodes in one cluster may lead to unforeseen errors and is not supported even for a short time.
 


= Supported Server / Client Combinations =
= Supported Server / Client Combinations =


== Client Support ==
== Client Support ==
Line 94: Line 109:
|
|
|[[File:cross.gif]] (Supported with upcoming 6.22.1, Q4 2012)
|[[File:cross.gif]] (Supported with upcoming 6.22.1, Q4 2012)
|-
|}
== Open-Xchange Database Support (Parallel Setup) ==
{| border="1" cellpadding="3" cellspacing="0"
!align="left" |Database
!align="left" |New Version
!align="left" |Supported
|- style="vertical-align:top"
|rowspan="5" | Open-Xchange Database
|v6.22.x
|[[File:check.gif]] (after running v6.22 update tasks)
|-
|v6.20.7
|[[File:check.gif]] (after running v6.22 update tasks)
|-
|v6.20.x
|[[File:check.gif]] (after running v6.22 update tasks)
|-
|v6.18.x
|[[File:cross.gif]]
|-
|Older Versions
|[[File:cross.gif]]
|-
|-
|}
|}
Line 130: Line 120:
= Configuration Changes =
= Configuration Changes =


The overview page provides a list of
== Configuration file location ==
In v6.22 we simplified the directory tree containing all configuration files to not longer include the subdirectories <code>admindaemon</code>, <code>common</code> and <code>groupware</code>.
 
For more details see the packaging changes [http://oxpedia.org/wiki/index.php?title=6.22_Packaging_Changes overview page].
 
'''If you have any configuration management or templating system for automatic deployment of OX instances in place, theses changes mean that you will have to adapt that system to the new configuration file tree.'''
 


* unchanged config files with old and new location
== Other configuration changes ==
** push.properties renamed to push-udp.properties
* completely new config files
* config files that do not longer exist
* merged / split config files
* config options which need to be changed and their containing files


* push.properties has been renamed to push-udp.properties
* the configuration of theme packages has changed. This is also described on the  packaging changes [http://oxpedia.org/wiki/index.php?title=6.22_Packaging_Changes overview page].
* since there is no administration deamon running any more, all, provisioning and general logs are written to one singel logfile


'''If you have any configuration management or templating system for automatic deployment of OX instances in place, theses changes mean that you will have to adapt that system to the new configuration file tree.'''
= RMI changes =


With the consolidation of the admin process and the groupware process in 6.22 we also consolidated the former splitted RMI libraries. So the files <code>/opt/open-xchange/lib/ox_admin_rmiclient.jar</code> and <code>/opt/open-xchange/lib/ox_admin_hosting_rmiclient.jar</code> were combined into the file <code>/opt/open-xchange/lib/com.openexchange.admin.rmi.jar</code>.
This means that you have to adjust your software to use the new library if you use the RMI interface.


= Packages changes =
= Packages changes =


The overview page provides a list of
With v6.22 we have significantly reduced the number of packages necessary to install Open-Xchange Server. We encourage administrators of Open-Xchange v6.20.x to read the article [[6.22_Package_Changes|Package changes with 6.22]] before updating to Open-Xchange v6.22. This article describes in detail which new packages correspond to which old ones.


* new packages and metapackages with short description
The changes in the package structure should be completely transparent to the system administrator and are handled by standard package management tools during the upgrade.
* removed metapackages
* remaining metapackages and what they do


We encourage administrators of Open-Xchange v6.20.x to read the article [[6.22_Package_Changes|Package changes with 6.22]] before updating to Open-Xchange v6.22.
'''If you have any custom system for automatic installation and deployment of OX instances in place, it is very likely that you need to adapt your system to the new package structure.'''


'''If you have any custom system for automatic installation and deployment of OX instances in place, it is very likely that you need to adapt your system to the new package structure.'''


= Dropped packages =
The package open-xchange-upsell-generic has been dropped for this release. An update will replace the package with open-xchange-upsell-multiple which offers the same features. The configuration needs to be converted though:


= No separate admin daemon =
In upsell.properties:
com.openexchange.upsell.multiple.method=direct
com.openexchange.upsell.multiple.method.static.shop_redir_url=URL_TO_STATIC_HTML_DOCUMENT


Admin functionality will now be a part of the Groupware Process as optional bundle. This means the former, as root running, Admin daemon will no longer exist.
The URL must point to an HTML document which holds the content previously defined in upsell.properties' modules/com.openexchange.upsell.generic/html.


following are potential pitfalls :
* ox-admin-scriptconf.sh is merged to /opt/open-xchange/etc/ox-scriptconf.sh, check NRFILES and Memory setting to fit the environment.
* If /etc/security/limits.conf does set limits for the open-xchange user, those need to be adopted.
* administrative tasks are now executed as user open-xchange (for example the filestore mount is no longer accessed as root).
* The mutual process is not able to open tcp sockets below 1024.
* Monitoring for the admin process is no longer needed.


= Default languages =


= Startup Scripts =
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update. Please see the [http://oxpedia.org/wiki/index.php?title=Update_to_6_22#Update_Guide_.28supported_packages.29 update guide] for your distribution for details.


The overview page provides a list of


* startup scripts
= No separate admin daemon =


We encourage administrators of Open-Xchange v6.20.x to read the ['''list'''] before updating to Open-Xchange v6.22.
Admin functionality will now be a part of the Groupware Process as optional bundle. This means the former, as root running, Admin daemon will no longer exist.


= Changes to programming APIs which might break custom plugins to the OX Server =
Admin functionality is only available when the corresponding packages are installed.
 
As a result of this change, there is now only one startup script which starts the Open-Xchange Server. The new unified process is called <code>open-xchange</code>.


* Exception handling has changed, see [http://oxpedia.org/wiki/index.php?title=Backend_Improvements_6_22 Backend Improvements 6.22]
Following are potential pitfalls :
* If you build your own packages, you need to change a few things, see: TODO
* ox-admin-scriptconf.sh is merged to /opt/open-xchange/etc/ox-scriptconf.sh, check NRFILES and Memory setting to fit the environment.
* If /etc/security/limits.conf does set limits for the open-xchange user, those need to be adopted.
* administrative tasks are now executed as user open-xchange (for example the filestore mount is no longer accessed as root).
* The new, unified process is not able to open tcp sockets below 1024.
* Separate monitoring for the admin process is no longer needed.
* admindaemon used to limit its network usage to IPv4 which is not the case anymore. This means that proper network setup is needed to avoid DNS and routing issues caused by dual stack usage.


The changes of the configuration files for the administration daemon are described in [[6.22_AdminConf_Changes|Administration daemon configuration changes for 6.22]].


= Installation and Update Guide for Open-Xchange v6.22 =
= Changes to programming APIs which might break custom plugins to the OX Server =


== Quick Installation Guide (supported packages) ==
* Please see [http://oxpedia.org/wiki/index.php?title=Backend_Improvements_6_22 Backend Improvements 6.22] for changes to the v6.22 core.
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages  [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and  [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.


To download and install the software, please use the following Installation Guides.


* [[Open-Xchange_Installation_Guide_for_Debian_6.0_622|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
= Update Guide for Open-Xchange v6.22 =
* [[Open-Xchange_Installation_Guide_for_SLES11_622|Download and Installation Guide for SUSE Linux Enterprise Server 11]]
* [[Open-Xchange_Installation_Guide_for_RHEL5_622|Download and Installation Guide for RedHat Enterprise Linux 5]]
* [[Open-Xchange_Installation_Guide_for_RHEL6_622|Download and Installation Guide for RedHat Enterprise Linux 6]]
* [[Open-Xchange Installation Guide for CentOS 5‎‎_622|Download and Installation Guide for CentOS 5]]
* [[Open-Xchange Installation Guide for CentOS 6‎‎_622|Download and Installation Guide for CentOS 6]]


== Update Guide (supported packages) ==
== Update Guide (supported packages) ==
Line 206: Line 201:
* [[Open-Xchange_620_622_Update_Guide_for_CentOS6‎‎|Update Guide from 6.20 to 6.22 for CentOS 6]]
* [[Open-Xchange_620_622_Update_Guide_for_CentOS6‎‎|Update Guide from 6.20 to 6.22 for CentOS 6]]


= Installation Guide for Open-Xchange v6.22.x =
== Quick Installation Guide (supported packages) ==
To download and install the software, please use the following Installation Guides.
* [[Open-Xchange_Installation_Guide_for_Debian_6.0_622|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[Open-Xchange_Installation_Guide_for_SLES11_622|Download and Installation Guide for SUSE Linux Enterprise Server 11]]
* [[Open-Xchange_Installation_Guide_for_RHEL6_622|Download and Installation Guide for RedHat Enterprise Linux 6]]
* [[Open-Xchange Installation Guide for CentOS 6‎‎_622|Download and Installation Guide for CentOS 6]]


= Migration from OLOX1 to OLOX2 =
= Migration from OLOX1 to OLOX2 =
Line 218: Line 224:
* User can directly start installing by clicking on a provided link
* User can directly start installing by clicking on a provided link


If the user closes the pop-up window, the OLOX 1 will be deactivated for the current session and profil. After installing OLOX2 and starting Outlook the user has to select the new OLOX2 profile and the migration is done.


If the user closes the pop-up window, the OLOX 1 will be deactivated for the current session and profil. After installing OLOX2 and starting Outlook the user has to select the new OLOX2 profile and the migration is done.
'''A complete migration path is documented at http://oxpedia.org/wiki/index.php?title=OLOX_Migration'''


== Known Issues ==
== Known Issues ==


* After the start of the new OLOX 2 profile, contacts, appointments and tasks will be synchronized
* After the start of the new OLOX 2 profile, contacts, appointments and tasks will be synchronized
* Per default server configuration, mails older as one year won't be synchronized
* Per default server configuration, mails, appointments and tasks older as one year won't be synchronized
* Notice and Journal information won't be synchronized. It is possible to export and import the information via the Outlook functionalities
* Per default all serial appointments which was created older as one year won't be synchronized
* <tt>/etc/init.d/open-xchange</tt> <tt>status</tt> / <tt>restart</tt> keeps issuing
  old 6.20 admin daemon still running, shutting down... done
or
  old 6.20 groupware still running, shutting down...
In that case, remove the pidfile(s):
  rm -f /var/run/open-xchange-admindaemon.pid; rm -f /var/run/open-xchange-groupware.pid

Latest revision as of 09:32, 27 November 2015

Open-Xchange Server v6.22 - Update and Installation

The new Open-Xchange Server v6.22 is the first step on the way to the next generation Open-Xchange App Suite. The update provides a new and improved Open-Xchange Server backend with enhancements for both generations.

Especially on the backend, Open-Xchange implemented various changes and improvements like a new and clear structure for the configuration files and packages, an improved exception framework, unified OSGi, etc.

On this page you can find an overview of the differences between the Open-Xchange 6.20.x and the Open-Xchange v.6.22 backend. There are new requirements, update guides, and multiple other changes.

Please read the different articles and manuals regarding the update. We encourage administrators of Open-Xchange 6 v6.20.x to install this update. The further feature development will be based on v6.22

Custom Packages: Unfortunately custom packages will not be ready with 6.22 release. If you have custom packages provided by Open-Xchange, please discuss with your Open-Xchange contact when these packages will be available for 6.22.

Custom Plugins: If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles please check the information about necessary code and packaging changes below.

Furthermore, Open-Xchange provides the complete v6.22 materials as a document which is available here: Software Repository.

Supported Update Path

Old version New version Update supported
v6.20.7 v6.22.0 Check.gif
v6.20.7 >= v6.22.1 Cross.gif
v6.20.x v6.22.x Cross.gif(1)
v6.18.x v6.22.x Cross.gif
Older Versions v6.22.x Cross.gif

(1) If you don't update to 6.20.7 before you start the 6.22 update, it is possible that some important scripts have not run on your system(s) and configuration options might be missing. If you have already updated to 6.22 from an v6.20 version earlier than 6.20.7 and you are experiencing problems, please contact Open-Xchange Support.

Rollback

Please note that after updating to 6.22 there is no way to get back to an earlier version of Open-Xchange. Please make sure that you have a full backup of your Open-Xchange installation(s).


Cluster setups

If you have several Open-Xchange systems in a cluster setup, you need to shut down all of them before attempting the upgrade. Parallel operation of v6.20 and v6.22 nodes in one cluster may lead to unforeseen errors and is not supported even for a short time.


Supported Server / Client Combinations

Client Support

Open-Xchange GUI / Clients Open-Xchange Server Supported
v6.22.x v6.22.x Check.gif
v6.20.x v6.22.x Cross.gif
v6.18.x v6.22.x Cross.gif
Older versions of Open-Xchange GUI v6.22.x Cross.gif
OXtender 2 for Microsoft Outlook v6.22.x Check.gif
OXtender for Business Mobility v6.22.x Check.gif
Open-Xchange Web Interface v1.2 v6.22.x Check.gif
OXtender for cPanel v6.22.x Check.gif
OXtender 1 for Microsoft Outlook Cross.gif
OXtender for SyncML Cross.gif
Parallels Operations Automation Cross.gif (Supported with upcoming 6.22.1, Q4 2012)


Improvements Overview of 6.20.x to 6.22 Backend

Open-Xchange provides an overview page regarding the main improvements of the new v6.22. Please have a look at Backend Improvements 6.22


Configuration Changes

Configuration file location

In v6.22 we simplified the directory tree containing all configuration files to not longer include the subdirectories admindaemon, common and groupware.

For more details see the packaging changes overview page.

If you have any configuration management or templating system for automatic deployment of OX instances in place, theses changes mean that you will have to adapt that system to the new configuration file tree.


Other configuration changes

  • push.properties has been renamed to push-udp.properties
  • the configuration of theme packages has changed. This is also described on the packaging changes overview page.
  • since there is no administration deamon running any more, all, provisioning and general logs are written to one singel logfile

RMI changes

With the consolidation of the admin process and the groupware process in 6.22 we also consolidated the former splitted RMI libraries. So the files /opt/open-xchange/lib/ox_admin_rmiclient.jar and /opt/open-xchange/lib/ox_admin_hosting_rmiclient.jar were combined into the file /opt/open-xchange/lib/com.openexchange.admin.rmi.jar. This means that you have to adjust your software to use the new library if you use the RMI interface.

Packages changes

With v6.22 we have significantly reduced the number of packages necessary to install Open-Xchange Server. We encourage administrators of Open-Xchange v6.20.x to read the article Package changes with 6.22 before updating to Open-Xchange v6.22. This article describes in detail which new packages correspond to which old ones.

The changes in the package structure should be completely transparent to the system administrator and are handled by standard package management tools during the upgrade.

If you have any custom system for automatic installation and deployment of OX instances in place, it is very likely that you need to adapt your system to the new package structure.


Dropped packages

The package open-xchange-upsell-generic has been dropped for this release. An update will replace the package with open-xchange-upsell-multiple which offers the same features. The configuration needs to be converted though:

In upsell.properties:

com.openexchange.upsell.multiple.method=direct
com.openexchange.upsell.multiple.method.static.shop_redir_url=URL_TO_STATIC_HTML_DOCUMENT

The URL must point to an HTML document which holds the content previously defined in upsell.properties' modules/com.openexchange.upsell.generic/html.


Default languages

Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update. Please see the update guide for your distribution for details.


No separate admin daemon

Admin functionality will now be a part of the Groupware Process as optional bundle. This means the former, as root running, Admin daemon will no longer exist.

Admin functionality is only available when the corresponding packages are installed.

As a result of this change, there is now only one startup script which starts the Open-Xchange Server. The new unified process is called open-xchange.

Following are potential pitfalls :

  • ox-admin-scriptconf.sh is merged to /opt/open-xchange/etc/ox-scriptconf.sh, check NRFILES and Memory setting to fit the environment.
  • If /etc/security/limits.conf does set limits for the open-xchange user, those need to be adopted.
  • administrative tasks are now executed as user open-xchange (for example the filestore mount is no longer accessed as root).
  • The new, unified process is not able to open tcp sockets below 1024.
  • Separate monitoring for the admin process is no longer needed.
  • admindaemon used to limit its network usage to IPv4 which is not the case anymore. This means that proper network setup is needed to avoid DNS and routing issues caused by dual stack usage.

The changes of the configuration files for the administration daemon are described in Administration daemon configuration changes for 6.22.

Changes to programming APIs which might break custom plugins to the OX Server


Update Guide for Open-Xchange v6.22

Update Guide (supported packages)

To update the software to Open-Xchange v6.22, please use the following Update Guides. There you can also find information on how to start the groupware with / without admin part, on known issues and manual steps required.


Installation Guide for Open-Xchange v6.22.x

Quick Installation Guide (supported packages)

To download and install the software, please use the following Installation Guides.

Migration from OLOX1 to OLOX2

Migration Path

Open-Xchange will discontinue the support for OXtender 1 for Microsoft Outlook with the new release v6.22. Additional, at the new backend, the Open-Xchange WebDAV XML API will no longer be officially supported. Open-Xchange will provide an upgrade path to the OXtender 2 for Microsoft Outlook.

If the user installs the upcoming OLOX1 6.18.19 we will provide the following information to the user when trying to sync against the OX server >= 6.22. Open-Xchange provides via a pop-up window at the product the following migration possibilities:

  • User can use the OXUpdater to install the new version
  • User can directly start installing by clicking on a provided link

If the user closes the pop-up window, the OLOX 1 will be deactivated for the current session and profil. After installing OLOX2 and starting Outlook the user has to select the new OLOX2 profile and the migration is done.

A complete migration path is documented at http://oxpedia.org/wiki/index.php?title=OLOX_Migration

Known Issues

  • After the start of the new OLOX 2 profile, contacts, appointments and tasks will be synchronized
  • Per default server configuration, mails, appointments and tasks older as one year won't be synchronized
  • Per default all serial appointments which was created older as one year won't be synchronized
  • /etc/init.d/open-xchange status / restart keeps issuing
 old 6.20 admin daemon still running, shutting down... done

or

 old 6.20 groupware still running, shutting down...

In that case, remove the pidfile(s):

 rm -f /var/run/open-xchange-admindaemon.pid; rm -f /var/run/open-xchange-groupware.pid