Difference between revisions of "AppSuite:Upgrade from 6.22 for SLES11"

m (US 68424070: Remove AJP because of discontinued support)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= Update of Open-Xchange Server v6.22 to OX App Suite 7.0 on SLES 11. =
+
{{AppSuiteUpgradeIntroduction|distroname=SLES 11|distro=SLES11|distronameshort=SLES 11}}
This example describes updating an OX 6 Server installation to OX App Suite 7.
 
  
= Supported update path =
+
= Update the software =
Updates from an OX6 installation to App Suite are only possible from 6.22 to 7.0. If you have an earlier version of Open-Xchange Server 6 installed, you have toupdate to the latest release of v6.22 before attempting an update to OX App Suite 7. See [[Open-Xchange_620_622_Update_Guide_for_SLES11|Open-Xchange 6.20 to 6.22 Update Guide for SLES 11]] for instructions regarding that update.
 
  
= Requirements =
+
== Update Open-Xchange Repositories ==
* An Open-Xchange Server installation v6.22.0 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_SLES11_622|Download and Installation Guide for SLES 11]]
 
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for OX App Suite 7. Do not attempt the update earlier.
 
* Custom packages built for 6.22.1 or earlier might not work with OX App Suite 7.0.
 
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.
 
  
= Update Open-Xchange Repositories =
+
If not already configured, we make the latest OX6 repos available. To do so, start with listing your existing repositories.
First, you need to add the current repositories to your zypper configuration to access the App Suite packages.
 
 
 
To do so, start with listing your existing repositories.
 
  
 
<code>
 
<code>
Line 20: Line 11:
 
</code>
 
</code>
  
Then, remove your configured Open-Xchange repositories. Assuming they are called <code>ox</code> and <code>ox-updates</code>, the commands would be:
+
Verify the latest OX6 repos are available. If not, add them using
  
<code>
+
  $ zypper ar http://software.open-xchange.com/OX6/6.22/frontend/SLES11/ ox-frontend
  $ zypper rr ox
+
  $ zypper ar http://software.open-xchange.com/OX6/6.22/backend/SLES11/ ox-backend
  $ zypper rr ox-updates
+
$ zypper ar http://software.open-xchange.com/OX6/6.22/usm/SLES11/ ox-usm
</code>
 
  
Finally, add the new Open-Xchange repositories for SLES11:
+
Optionally, if you have a valid maintenance subscription:
  
  $ zypper ar http://software.open-xchange.com/products/appsuite/stable/appsuiteui/SLES11/ appsuite-frontend  
+
  $ zypper ar http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/SLES11/ ox-updates-frontend
  $ zypper ar http://software.open-xchange.com/products/appsuite/stable/backend/SLES11/ ox-backend
+
  $ zypper ar http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/SLES11/ ox-updates-backend
 +
$ zypper ar http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/SLES11/ ox-updates-usm
  
 +
== Update packages ==
  
= Updating repositories and update packages =
 
 
Reload the package index:
 
Reload the package index:
  
Line 40: Line 31:
 
Download and update all installed Open-Xchange packages:  
 
Download and update all installed Open-Xchange packages:  
  
  $ zypper dup -r ox-backend -r appsuiteui
+
  $ zypper dup -r ox-backend -r appsuite-frontend -r ox-usm
 
 
One configuration setting is to be made manually:
 
 
 
# vi /opt/open-xchange/etc/cluster.properties
 
com.openexchange.cluster.name=oxcluster
 
  
= Restart Open-Xchange =
+
or, if you have a valid maintenance subscription:
  
To restart Open-Xchange Server after the update, run
+
$ zypper dup -r ox-backend -r appsuite-frontend -r ox-usm -r ox-updates-backend -r appsuite-updates-frontend -r ox-updates-usm
  
$ rcopen-xchange restart
 
  
You might  want to check with
+
{{AppSuiteUpgradeChangesByVersion}}
  
$ ps aux | grep open-xchange
+
{{AppSuiteUpgradeRestartOpenXchange}}
 
 
that there is exactly one newly spawned process running Open-Xchange Server.
 
 
 
Now the backend has been upgraded to 7.0.x.  The v6.22 frontend might still work with this new backend but is *NOT*' supported up to version 6.22.1. The next version 6.22.2 is planned to be fully compatible with the 7.0.2 backend. Upon the first connection after the backend update, you will ge the message <code>Error: updating database, try later</code>. The second try should succeed.
 
  
 
= Add the App Suite UI =
 
= Add the App Suite UI =
  
# zypper install open-xchange-appsuite open-xchange-appsuite-backend open-xchange-appsuite-manifest
+
== Install the packages ==
  
It them remains to adjust Apache's <code>ox.conf</code> as well as <code>proxy_ajp.conf</code>.
+
Add App Suite repositories to your sources.list:
  
Basically you need to merge the OX6 and App Suite versions of those files. For the Apache config file <code>/etc/apache2/conf.d/ox.conf</code>, replace the element <code><Directory /srv/www/htdocs> ... </Directory></code> with the following:
+
$ zypper ar http://software.open-xchange.com/products/appsuite/stable/appsuiteui/SLES11/ appsuite-frontend
 +
$ #zypper ar http://software.open-xchange.com/products/appsuite/stable/backend/SLES11/ appsuite-backend
 +
$ #zypper ar http://software.open-xchange.com/products/appsuite/stable/usm/SLES11/ appsuite-usm
  
        <Directory /srv/www/htdocs>
 
                Options Indexes FollowSymLinks MultiViews
 
                AllowOverride None
 
                Order allow,deny
 
                allow from all
 
                RedirectMatch ^/$ /appsuite/
 
        </Directory>
 
 
 
        <Directory /srv/www/htdocs/appsuite>
 
                Options None +SymLinksIfOwnerMatch
 
                AllowOverride Indexes FileInfo
 
        </Directory>
 
 
        ErrorLog ${APACHE_LOG_DIR}/error.log
 
 
        # Possible values include: debug, info, notice, warn, error, crit,
 
        # alert, emerg.
 
        LogLevel warn
 
 
        CustomLog ${APACHE_LOG_DIR}/access.log combined
 
  
For the <code>/etc/apache2/conf.d/proxy_ajp.conf</code>, you need to add an element before the element <code><Proxy /ajax> ... </Proxy></code>:
+
Since the OX App Suite backend is the same as the OX6 backend, there is no need to add the backend repository here. But, on the other hand, you may add it here, and remove the backend repository from the OX6 repository list.
  
    # OX AppSuite frontend
+
Then, install packages:
    <Proxy /appsuite/api>
 
        ProxyPass balancer://oxcluster/ajax
 
    </Proxy>
 
  
Full sample versions of those files are given in the following.
+
  # zypper ref
 
+
  # zypper install open-xchange-appsuite open-xchange-appsuite-backend open-xchange-appsuite-manifest
<VirtualHost *:80>
 
ServerAdmin webmaster@localhost
 
 
DocumentRoot /srv/www/htdocs
 
   
 
        <Directory /srv/www/htdocs>
 
                Options Indexes FollowSymLinks MultiViews
 
                AllowOverride None
 
                Order allow,deny
 
                allow from all
 
                RedirectMatch ^/$ /appsuite/
 
        </Directory>
 
 
 
        <Directory /srv/www/htdocs/appsuite>
 
                Options None +SymLinksIfOwnerMatch
 
                AllowOverride Indexes FileInfo
 
        </Directory>
 
 
        ErrorLog ${APACHE_LOG_DIR}/error.log
 
 
        # Possible values include: debug, info, notice, warn, error, crit,
 
        # alert, emerg.
 
        LogLevel warn
 
 
        CustomLog ${APACHE_LOG_DIR}/access.log combined
 
   
 
        # deflate
 
      AddOutputFilterByType DEFLATE text/html text/plain text/javascript application/javascript text/css text/xml application/xml text/x-js application/x-javascript
 
 
# pre-compressed files
 
AddType text/javascript .jsz
 
AddType text/css .cssz
 
AddType text/xml .xmlz
 
        AddType text/plain .po
 
 
AddEncoding gzip .jsz .cssz .xmlz
 
SetEnvIf Request_URI "\.(jsz|cssz|xmlz)$" no-gzip
 
 
ExpiresActive On
 
 
<Location /ox6>
 
        # Expires (via ExpiresByType to override global settings)
 
        ExpiresByType image/gif "access plus 6 months"
 
        ExpiresByType image/png "access plus 6 months"
 
        ExpiresByType image/jpg "access plus 6 months"
 
        ExpiresByType image/jpeg "access plus 6 months"
 
        ExpiresByType text/css "access plus 6 months"
 
        ExpiresByType text/html "access plus 6 months"
 
        ExpiresByType text/xml "access plus 6 months"
 
        ExpiresByType text/javascript "access plus 6 months"
 
        ExpiresByType text/x-js "access plus 6 months"
 
        ExpiresByType application/x-javascript "access plus 6 months"
 
        ExpiresDefault "access plus 6 months"
 
        Header append Cache-Control "private"
 
        Header unset Last-Modified
 
        Header unset Vary
 
        # Strip version
 
        RewriteEngine On
 
        RewriteRule v=\w+/(.+) $1 [L]
 
        # Turn off ETag
 
        Header unset ETag
 
        FileETag None
 
</Location>
 
 
<Location /ox6/ox.html>
 
        ExpiresByType text/html "now"
 
        ExpiresDefault "now"
 
        Header unset Last-Modified
 
        Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"
 
        # Turn off ETag
 
        Header unset ETag
 
        FileETag None
 
</Location>
 
 
<Location /ox6/index.html>
 
        ExpiresByType text/html "now"
 
        ExpiresDefault "now"
 
        Header unset Last-Modified
 
        Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"
 
        # Turn off ETag
 
        Header unset ETag
 
        FileETag None
 
</Location>
 
</VirtualHost>
 
 
 
# /etc/apache2/conf.d/proxy_ajp.conf
 
# Please note that the servlet path to the soap API has changed:
 
  <Location /webservices>
 
      # restrict access to the soap provisioning API
 
      Order Deny,Allow
 
      Deny from all
 
      Allow from 127.0.0.1
 
      # you might add more ip addresses / networks here
 
      # Allow from 192.168 10 172.16
 
  </Location>
 
  # the old path is kept for compatibility reasons
 
 
<Location /servlet/axis2/services>
 
    # restrict access to the soap provisioning API
 
    Order Deny,Allow
 
    Deny from all
 
    Allow from 127.0.0.1
 
    # you might add more ip addresses / networks here
 
    # Allow from 192.168 10 172.16
 
</Location>
 
LoadModule proxy_ajp_module modules/mod_proxy_ajp.so
 
 
<IfModule mod_proxy_ajp.c>
 
    ProxyRequests Off
 
    <Proxy balancer://oxcluster>
 
        Order deny,allow
 
        Allow from all
 
        # multiple server setups need to have the hostname inserted instead localhost
 
        BalancerMember ajp://localhost:8009 timeout=100 smax=0 ttl=60 retry=60 loadfactor=50 route=OX1
 
        # Enable and maybe add additional hosts running OX here
 
        # BalancerMember ajp://oxhost2:8009 timeout=100  smax=0 ttl=60 retry=60 loadfactor=50 route=OX2
 
        ProxySet stickysession=JSESSIONID
 
    </Proxy>
 
 
    # OX AppSuite frontend
 
    <Proxy /appsuite/api>
 
        ProxyPass balancer://oxcluster/ajax
 
    </Proxy>
 
 
    <Proxy /ajax>
 
        ProxyPass balancer://oxcluster/ajax
 
    </Proxy>
 
    <Proxy /servlet>
 
        ProxyPass balancer://oxcluster/servlet
 
    </Proxy>
 
    <Proxy /infostore>
 
        ProxyPass balancer://oxcluster/infostore
 
    </Proxy>
 
    <Proxy /publications>
 
        ProxyPass balancer://oxcluster/publications
 
    </Proxy>
 
    <Proxy /Microsoft-Server-ActiveSync>
 
        ProxyPass balancer://oxcluster/Microsoft-Server-ActiveSync
 
    </Proxy>
 
    <Proxy /usm-json>
 
        ProxyPass balancer://oxcluster/usm-json
 
    </Proxy>
 
    <Proxy /webservices>
 
        ProxyPass balancer://oxcluster/webservices
 
    </Proxy>
 
</IfModule>
 
 
 
After this, stop and start the apache2 and open-xchange services. Then you should be able to use the App Suite UI.
 
 
 
= Remove the OX6 GUI =
 
 
 
This step is optional. You may just skip it and offer both GUIs, the OX6 GUI and the App Suite UI. This will only be supported after the 6.22.2 release!
 
 
 
If you want to uninstall the OX6 GUI, this step consists of removing the OX6 GUI packages and and adjusting Apache's configuration.
 
 
 
The packages to be removed can be identified by their version number in the output of <code>rpm -qa | grep open-x</code>. It will probably boil down to uninstall everything which starts with <code>open-xchange-gui</code>, as the names of the App Suite UI packages start with <code>open-xchange-appsuite</code>.
 
 
 
# zypper remove open-xchange-gui*
 
  
Then adjust the <code>/etc/apache2/conf.d/ox.conf</code> file to remove obsolete stuff which was required for the OX6 GUI, but is not required by the App Suite. To do so, you may consult the [[AppSuite:Open-Xchange_Installation_Guide_for_SLES11|Installation Guide for OX App Suite]] to learn which sections of the file are required for an App Suite UI.
+
{{AppSuiteUpgradeAdjustApacheConfig|filename=ox.conf|distro=SLES11|apacheservice=apache2}}
  
The file <code>/etc/apache2/conf.d/proxy_ajp.conf</code> will not require adjustments; the settings for App Suite are a superset of the settings of the OX6 GUI.
+
{{AppSuiteUpgradeRemoveOX6GUI|listpackages=rpm -qa|uninstallpackages=zypper remove|apacheconf=/etc/apache2/conf.d/ox.conf|distro=SLES11}}
  
= Leftover configuration files and runtime data =
+
== Leftover configuration files and runtime data ==
  
 
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code> It is safe to remove all files ending in .rpmsave or .rpmnew once you are confident that your configuration is working after the update.
 
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code> It is safe to remove all files ending in .rpmsave or .rpmnew once you are confident that your configuration is working after the update.

Latest revision as of 13:51, 17 November 2014

Update of Open-Xchange Server v6.22 to OX App Suite on SLES 11

This document describes updating an OX 6 Server installation from version 6.22 to OX App Suite.

Supported update path

This document assumes you are running at least OX6 v6.22.0. If you are running on an older version of OX6, you need to update to v6.22.0 first, see Open-Xchange 6.20 to 6.22 Update Guide for SLES 11. (This requires an intermediate upgrade to OX6 v6.20.7 if you are running a version older than that.)

Then, update your OX6 installation to the latest 6.22 version. Since OX App Suite and OX6 use the same backend (beginning with OX App Suite 7.0.2 / OX6 v6.22.2 released on 2013-04-04), this is basically upgrading your backend to the latest OX App Suite backend, while keeping the OX6 frontend functional.

Then, add the latest OX App Suite frontend to the system.

Then, the OX6 frontend can be removed, optionally.

Requirements

  • An Open-Xchange Server installation v6.22.0 or later. This update guide is valid for a system installed through our Download and Installation Guide for SLES 11
  • If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for OX App Suite. Do not attempt the update earlier.
  • Custom packages built for 6.22.1 or earlier might not work with OX App Suite.
  • As for every update we strongly recommend that you make a backup of your system(s) before you proceed.

Update the software

Update Open-Xchange Repositories

If not already configured, we make the latest OX6 repos available. To do so, start with listing your existing repositories.

$ zypper lr

Verify the latest OX6 repos are available. If not, add them using

$ zypper ar http://software.open-xchange.com/OX6/6.22/frontend/SLES11/ ox-frontend
$ zypper ar http://software.open-xchange.com/OX6/6.22/backend/SLES11/ ox-backend
$ zypper ar http://software.open-xchange.com/OX6/6.22/usm/SLES11/ ox-usm

Optionally, if you have a valid maintenance subscription:

$ zypper ar http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/SLES11/ ox-updates-frontend
$ zypper ar http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/SLES11/ ox-updates-backend
$ zypper ar http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/SLES11/ ox-updates-usm

Update packages

Reload the package index:

$ zypper ref

Download and update all installed Open-Xchange packages:

$ zypper dup -r ox-backend -r appsuite-frontend -r ox-usm

or, if you have a valid maintenance subscription:

$ zypper dup -r ox-backend -r appsuite-frontend -r ox-usm -r ox-updates-backend -r appsuite-updates-frontend -r ox-updates-usm


Review configuration files

We recommend that you read the release notes vor all versions newer than your version before you started the upgrade. The release notes contain all changes to the product together with the actions required by the admin to accommodate for those changes.

You can find the release notes here:

Some of the most prominent changes are summarized below.

Changes by version

6.22.1, 2012-11-14

Introduction of hazelcast as distributed session cache. Review Hazelcast configuration after the upgrade.

6.22.2, 2013-03-12

OX now offers Grizzly as alternative to AJP. (AJP is deprecated with 7.4 and will be discontinued with 7.6.) Either switch to Grizzly now, following AppSuite:Grizzly, or stick with AJP for now.

The whole cluster communication will now be done through Hazelcast. Please note that even in case of an update it is important to configure the new settings as required as this will not be done automatically. The configuration of the new system is described in http://oxpedia.org/wiki/index.php?title=AppSuite:Running_a_cluster

New config file 'cluster.properties'. Set reasonable cluster name there, same for all nodes in the cluster.

7.2.0, 2013-04-11

Features OX Text. OX Text requires OX Realtime. OX Realtime requires Grizzly. So switch to Grizzly now if you are using OX Text.

It is now possible to disable the OX builtin replication monitor for replicated database backends which work synchronously. (configdb.properties, com.openexchange.database.replicationMonitor)

Adjustment of apache configuration required: App Suite 7.2 introduces a new realtime/push framework for which a new namespace was added to OX URLs. Please add new proxy entries to the apache configuration to map the /realtime and /atmosphere paths to the backend. e.g.:

 <Proxy /atmosphere>
     ProxyPass balancer://oxcluster/atmosphere
 </Proxy>
 <Proxy /realtime>
     ProxyPass balancer://oxcluster/realtime
 </Proxy>

7.2.1, 2013-05-23

Internal OSGi events have been distributed in the cluster using the UDP push mechanism. This mechanism is now replaced using Hazelcast topics. Therefore the UDP push mechanism should be disabled. Several properties of the configuration file /opt/open-xchange/etc/push-udp.properties are configured to false by default and when upgrading the packages. This are the properties: - com.openexchange.push.udp.pushEnabled - com.openexchange.push.udp.registerDistributionEnabled - com.openexchange.push.udp.eventDistributionEnabled - com.openexchange.push.udp.multicastEnabled If your cluster requires push mechanisms to push changes to client devices, ensure to configure a proper working cluster setup. This is described here: AppSuite:Running_a_cluster

7.2.2, 2013-07-03

Reminder: AJP is deprecated, please switch to Grizzly. AppSuite:Grizzly

7.4.0, 2013-09-26

Support Debian 7 (Wheey) with OpenJDK 7 and MySQL 5.5.

Reminder: AJP is deprecated, please switch to Grizzly. AppSuite:Grizzly

Jolokia monitoring capabilities added. See: Jolokia

showruntimestats is deprecated and will be gone in Sep 2014.

Removed Sql.properties. Database Schema setup will no longer be performed by *.sql scripts but by OX internally (Java code).

Added tokenlogin. Should be more secure / robust than the former "config jump" feature.

Galera support (and possibly support for other MySQL replication mechanisms which rely on the presence of primary key in all tables) added. See server.properties / com.openexchange.server.fullPrimaryKeySupport.

Cluster discovery now handled by Hazelcast (both static and dynamic). See hazelcast.properties for configuration. Hazelcast now also listens by default only on localhost, please check.

Office capabilities configurable, see documents.properties.

Restart Open-Xchange

To restart Open-Xchange Server after the update, run

$ service open-xchange restart

You might want to check with

$ ps aux | grep open-xchange

that there is exactly one newly spawned process running Open-Xchange Server.

You should verify that login is possible. Upon the first connection after the backend update, you will get the message Error: updating database, try later. The second try should succeed.

Add the App Suite UI

Install the packages

Add App Suite repositories to your sources.list:

$ zypper ar http://software.open-xchange.com/products/appsuite/stable/appsuiteui/SLES11/ appsuite-frontend 
$ #zypper ar http://software.open-xchange.com/products/appsuite/stable/backend/SLES11/ appsuite-backend
$ #zypper ar http://software.open-xchange.com/products/appsuite/stable/usm/SLES11/ appsuite-usm


Since the OX App Suite backend is the same as the OX6 backend, there is no need to add the backend repository here. But, on the other hand, you may add it here, and remove the backend repository from the OX6 repository list.

Then, install packages:

# zypper ref
# zypper install open-xchange-appsuite open-xchange-appsuite-backend open-xchange-appsuite-manifest

Adjust Apache configuration

Apache's service configuration needs adjustments.

If you want to run both frontends later, you need to create a default.conf file with the contents from OX6 and OX App Suite merged. If you want to drop the OX6 frontend anyways, you can now just create a ox.conf file for OX App Suite. Consult the OX App Suite documentation for details about the ox.conf contents for OX App Suite.

Then you need to adjust the proxy_http.conf file. Basically the OX App Suite configuration is a superset of the OX6 configuraton, so you can use the configuration described in the OX App Suite documentation for the Grizzly configuration.

After this, stop and start the apache2 and open-xchange services. Then you should be able to use the App Suite UI.

Remove the OX6 GUI

This step is optional. You may just skip it and offer both GUIs, the OX6 GUI and the App Suite GUI. (This is only supported with OX6 v6.22.2 and later.)

If you want to uninstall the OX6 GUI, this step consists of removing the OX6 GUI packages and adjusting Apache's configuration.

The packages to be removed can be identified by their version number in the output of rpm -qa | grep open-x. It will probably boil down to uninstall everything which starts with open-xchange-gui, as the names of the App Suite UI packages start with open-xchange-appsuite.

# zypper remove open-xchange-gui*

After deinstallation of the OX6 GUI packages, adjust the /etc/apache2/conf.d/ox.conf file to remove obsolete stuff which was required for the OX6 GUI, but is not required by the App Suite UI. To do so, you may consult the Installation Guide for OX Appsuite to learn which sections of the file are required for an App Suite UI.

The Grizzly configuration will not require adjustments; the settings for App Suite are a superset of the settings of the OX6 GUI.

Leftover configuration files and runtime data

After the update you may see leftover configuration files and runtime data below /opt/open-xchange/etc It is safe to remove all files ending in .rpmsave or .rpmnew once you are confident that your configuration is working after the update.