AppSuite:Upgrade from 6.22 Debian 6.0: Difference between revisions

From Open-Xchange
No edit summary
 
(35 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= Update of Open-Xchange Server v6.22 to OX Appsuite 7.0 on Debian GNU/Linux 6.0 =
{{AppSuiteUpgradeIntroduction|distroname=Debian GNU/Linux 6.0|distro=Debian_6.0|distronameshort=Debian 6.0}}
This example describes updating some OX 6 Server installation to OX Appsuite 7.


= Supported update path =
= Update the software =
We expect the only valid update path will be latest 6.22.X to Appsuite 7.0.1. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.22 before attempting an update to OX Appsuite 7. See [[Open-Xchange_620_622_Update_Guide_for_Debian_6.0|Open-Xchange 6.20 to 6.22 Update Guide for Debian 6.0]] for instructions regarding that update.


= Requirements =
== Update Open-Xchange Repositories ==
* An Open-Xchange Server installation v6.22.1 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_Debian_6.0_622|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for OX Appsuite 7. Do not attempt the update earlier.
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[7.0_Packaging_Changes|v7.0 Packaging Changes]]
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages  [[7.0_Packaging_Changes|v7.0 Packaging Changes]] and  [[7.0_Necessary_Code_Changes|v7.0 Necessary Code Changes]] for changes you might need to do.
* Custom packages built for 6.22.1 or earlier might not work with OX Appsuite 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 by ajdusting the corresponding sources.list file:
We start by adding some Appsuite repos to our sources.list.


# adjust this to some final repo location
<code>
  cat >/etc/apt/sources.list.d/ox-appsuite.list <<EOF
  deb http://software.open-xchange.com/OX6/6.22/frontend/DebianSqueeze/ /
  deb http://buildservice.oxoe.int/repos/backend-release-7.0.1/DebianSqueeze/ /
  deb http://software.open-xchange.com/OX6/6.22/backend/DebianSqueeze/ /
  deb http://buildservice.oxoe.int/repos/frontend-release-7.0.1/DebianSqueeze/ /
  deb http://software.open-xchange.com/OX6/6.22/usm/DebianSqueeze/ /
   
   
  # if you have a valid maintenance subscription, please uncomment the  
  # if you have a valid maintenance subscription, please uncomment the  
  # following and add the ldb account data to the urls so that the most recent
  # following and add the ldb account data to the url so that the most recent
  # packages get installed
  # packages get installed
  # TODO: insert Update Repo Lines here
  # deb http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/DebianSqueeze /
  EOF
  # deb http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/DebianSqueeze /
 
# deb http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/DebianSqueeze /
= Updating repositories and update packages =
</code>


== Update packages ==


Reload the package index:
Reload the package index:
Line 52: Line 44:


Chose Y to install the new version. Check later no manual changes have been screwed. You can do this by comparing the new (installed) config file with the dpkg.old files created by dpkg.
Chose Y to install the new version. Check later no manual changes have been screwed. You can do this by comparing the new (installed) config file with the dpkg.old files created by dpkg.
One configuration setting is to be made manually:
# vi /opt/open-xchange/etc/cluster.properties
com.openexchange.cluster.name=oxcluster


'''IMPORTANT''': Please be extremely careful when executing <code>apt-get autoremove</code> after the upgrade. On some test systems packages were marked for automatic removal even if they were still needed.
'''IMPORTANT''': Please be extremely careful when executing <code>apt-get autoremove</code> after the upgrade. On some test systems packages were marked for automatic removal even if they were still needed.
Line 64: Line 51:
  $ apt-mark unmarkauto package1 [package2 [package3 [...]]]
  $ apt-mark unmarkauto package1 [package2 [package3 [...]]]


= Restart Open-Xchange =
=== Replace AJP with Grizzly ===


To restart Open-Xchange Server after the update, run
You need to decide whether whether you want to replace AJP by Grizzly now, or later. AJP is deprecated with OX App Suite 7.4 / OX6 v6.22.4 released in September 2013 and will be discontinued with OX App Suite 7.6 in April 2014. For more information, see [[AppSuite:Grizzly]].


$ /etc/init.d/open-xchange restart
{{AppSuiteUpgradeChangesByVersion}}


You might  want to check with
{{AppSuiteUpgradeRestartOpenXchange}}


$ ps aux | grep open-xchange
= Add the App Suite UI =


that there is exactly one newly spawned process running Open-Xchange Server.
== Install the packages ==


Now the backend has been upgraded to 7.0.X. The v6.22 frontend should still work with this new backend. You should verify this at this moment. Upon the first connection after the backend update, you will ge tthe message <code>Error: updating database, try later</code>. The second try should succeed.
Add App Suite repositories to your sources.list:


= Add the Appsuite GUI =
# adjust your existing repository list with the new locations
#deb http://software.open-xchange.com/products/appsuite/stable/backend/DebianSqueeze/ /
#deb http://software.open-xchange.com/products/appsuite/stable/usm/DebianSqueeze/ /
deb http://software.open-xchange.com/products/appsuite/stable/appsuiteui/DebianSqueeze/ /


# apt-get install open-xchange-appsuite open-xchange-appsuite-backend open-xchange-appsuite-manifest
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.


It them remains to adjust apache's default.conf as well as proxy_ajp.conf.
Then, install packages:


Basically you need to merge the OX6 and Appsuite versions of those files. This leaves enough room to screw things up. Sample versions of those files are given in the following.
# apt-get update
# apt-get install open-xchange-appsuite open-xchange-appsuite-backend open-xchange-appsuite-manifest


# /etc/apache2/sites-available/default
{{AppSuiteUpgradeAdjustApacheConfig|filename=default.conf|distro=Debian_6.0|apacheservice=apache2}}
<VirtualHost *:80>
        ServerAdmin webmaster@localhost
 
        DocumentRoot /var/www/
 
        <Directory /var/www/>
                Options Indexes FollowSymLinks MultiViews
                AllowOverride None
                Order allow,deny
                allow from all
                RedirectMatch ^/$ /appsuite/
        </Directory>
 
        <Directory /var/www//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
{{AppSuiteUpgradeRemoveOX6GUI|listpackages=dpkg -l|uninstallpackages=apt-get remove|apacheconf=/etc/apache2/sites-available/default.conf|distro=Debian_6.0}}
# 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 192.168
      # 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 192.168
    # you might add more ip addresses / networks here
    # Allow from 192.168 10 172.16
</Location>
 
 
<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 Appsuite UI. (I again encountered a "Upgrading database, try again later" message on the first login try.)
== 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>.
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.
Line 249: Line 93:
Finally, there may be backup files created by the package manager during earlier updates.
Finally, there may be backup files created by the package manager during earlier updates.


It is safe to remove:
It is safe to remove all files ending in <code>.dpkg-bak</code> or <code>.dpkg-remove</code>
 
* All files and subdirectories below:
 
/opt/open-xchange/etc/admindaemon
/opt/open-xchange/etc/common
/opt/open-xchange/etc/groupware
 
unless you have built your own packages which install files into these directories.
 
* All files ending in <code>.dpkg-bak</code> or <code>.dpkg-remove</code>

Latest revision as of 14:18, 27 September 2013

Update of Open-Xchange Server v6.22 to OX App Suite on Debian GNU/Linux 6.0

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 Debian 6.0. (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 Debian GNU/Linux 6.0
  • 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 by ajdusting the corresponding sources.list file: 

deb http://software.open-xchange.com/OX6/6.22/frontend/DebianSqueeze/ /
deb http://software.open-xchange.com/OX6/6.22/backend/DebianSqueeze/ /
deb http://software.open-xchange.com/OX6/6.22/usm/DebianSqueeze/ /

# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/DebianSqueeze /
# deb http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/DebianSqueeze /
# deb http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/DebianSqueeze /

Update packages

Reload the package index: 

$ apt-get update

Download and update all installed packages: 

$ apt-get dist-upgrade

Please note: For some config files, the following interaction dialog may occur: 

Configuration file `/opt/open-xchange/etc/hazelcast.properties'
 ==> File on system created by you or by a script.
 ==> File also in package provided by package maintainer.
   What would you like to do about it ?  Your options are:
    Y or I  : install the package maintainer's version
    N or O  : keep your currently-installed version
      D     : show the differences between the versions
      Z     : start a shell to examine the situation
 The default action is to keep your current version.
*** hazelcast.properties (Y/I/N/O/D/Z) [default=N] ?

Chose Y to install the new version. Check later no manual changes have been screwed. You can do this by comparing the new (installed) config file with the dpkg.old files created by dpkg.

IMPORTANT: Please be extremely careful when executing apt-get autoremove after the upgrade. On some test systems packages were marked for automatic removal even if they were still needed.

To remove a package from the autoremove list, you can use: 

$ apt-mark unmarkauto package1 [package2 [package3 [...]]]

Replace AJP with Grizzly

You need to decide whether whether you want to replace AJP by Grizzly now, or later. AJP is deprecated with OX App Suite 7.4 / OX6 v6.22.4 released in September 2013 and will be discontinued with OX App Suite 7.6 in April 2014. For more information, see AppSuite:Grizzly.

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: 

# adjust your existing repository list with the new locations
#deb http://software.open-xchange.com/products/appsuite/stable/backend/DebianSqueeze/ /
#deb http://software.open-xchange.com/products/appsuite/stable/usm/DebianSqueeze/ /
deb http://software.open-xchange.com/products/appsuite/stable/appsuiteui/DebianSqueeze/ /

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: 

# apt-get update
# apt-get 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 default.conf file for OX App Suite. Consult the OX App Suite documentation for details about the default.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 dpkg -l | 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. 

# apt-get remove open-xchange-gui*

After deinstallation of the OX6 GUI packages, adjust the /etc/apache2/sites-available/default.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.

Some of these files belong to packages which have been uninstalled during the update, they are marked with the status rc in the output of dpkg -l. You can remove these packages with the command 

$ dpkg --purge <packagename>

Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.

Finally, there may be backup files created by the package manager during earlier updates.

It is safe to remove all files ending in .dpkg-bak or .dpkg-remove

Retrieved from "https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Upgrade_from_6.22_Debian_6.0&oldid=15857"