Load balancing and clustering - Revision history

Khgras at 10:44, 1 March 2013

2013-03-01T10:44:00Z

← Older revision		Revision as of 10:44, 1 March 2013
Line 2:		Line 2:

	== General ==		== General ==
	Open-Xchange Server 6 is primarily built for the Software-as-a-Service world. Hosting and telecommunication providers around the world use Open-Xchange to offer hosted services to their customers. Open-Xchange Server 6 scales vertically and horizontally which means either use a more powerful server or add more machines to fulfill resource requirements. While upgrading a single server installation inevitably gets to a point where costs rise faster than performance gains, adding some simple machines to the installation provides linear cost increase and a slightly more complex administration. Besides the fiscal impact of using medium sized servers another key argument for clustering is service availability, single nodes can go down for maintenance without influencing the general service availability. A typical scenario for clustering is virtualization where multiple nodes can provide resources on demand.		Open-Xchange Server is primarily built for the Software-as-a-Service world. Hosting and telecommunication providers around the world use Open-Xchange to offer hosted services to their customers. Open-Xchange Server scales vertically and horizontally which means either use a more powerful server or add more machines to fulfill resource requirements. While upgrading a single server installation inevitably gets to a point where costs rise faster than performance gains, adding some simple machines to the installation provides linear cost increase and a slightly more complex administration. Besides the fiscal impact of using medium sized servers another key argument for clustering is service availability, single nodes can go down for maintenance without influencing the general service availability. A typical scenario for clustering is virtualization where multiple nodes can provide resources on demand.

	One of the main principles of Open-Xchange Server 6 is the ability to utilize several medium sized servers. This guide will outline the basic principles of clustering Open-Xchange Server instances and provide load balancing to utilize all nodes of a cluster.		One of the main principles of Open-Xchange Server is the ability to utilize several medium sized servers. This guide will outline the basic principles of clustering Open-Xchange Server instances and provide load balancing to utilize all nodes of a cluster.

	== Requirements ==		== Requirements ==
	Since clustering and load balancing is an advanced topic, skills on operating system and Open-Xchange Server 6 administration are required. To gain those skills, please refer to the [http://software.open-xchange.com/OX6/doc documentation repository] and general system administration lecture.		Since clustering and load balancing is an advanced topic, skills on operating system and Open-Xchange Server administration are required. To gain those skills, please refer to the [http://software.open-xchange.com/OX6/doc documentation repository] and general system administration lecture.
	With this guide we're going to set up five machines in total. Therefor it's recommended to get some training on a virtualized environment first. When rolling out the setup it is recommended to use real hardware or enterprise grade virtualization solutions like VMware ESX or Citrix XEN. If VMware is used, please make sure that VMware Tools are installed on all hosts to ensure optimal network performance. The following types servers will be set up:		With this guide we're going to set up five machines in total. Therefor it's recommended to get some training on a virtualized environment first. When rolling out the setup it is recommended to use real hardware or enterprise grade virtualization solutions like VMware ESX or Citrix XEN. If VMware is used, please make sure that VMware Tools are installed on all hosts to ensure optimal network performance. The following types servers will be set up:

	* 1 Webserver (Apache)		* 1 Webserver (Apache)
	* 2 Groupware nodes (Open-Xchange Server 6)		* 2 Groupware nodes (Open-Xchange Server)
	* 2 Database servers (MySQL Master/Slave)		* 2 Database servers (MySQL Master/Slave)

	To maintain consistency throughout the guide, each system gets a unique name which can be set as hostname. The IP addresses are also used through the whole guide but they may differ at the actual network setup. All systems run Debian GNU/Linux 5.0 (Lenny), any other supported platform works as well. All assumptions and instructions about system configuration is based on a minimal installation of the operating system~~. This guide is valid for Open-Xchange 6.10~~.		To maintain consistency throughout the guide, each system gets a unique name which can be set as hostname. The IP addresses are also used through the whole guide but they may differ at the actual network setup. All systems run Debian GNU/Linux 5.0 (Lenny), any other supported platform works as well. All assumptions and instructions about system configuration is based on a minimal installation of the operating system.

	* web (10.20.30.210)		* web (10.20.30.210)

Bartl3by at 10:35, 10 February 2011

2011-02-10T10:35:37Z

Show changes

WolfgangRosenauer: fix small typos

2010-10-05T10:36:41Z

fix small typos

Mheiland: /* Network configuration */

2010-02-17T13:39:25Z

Network configuration

← Older revision		Revision as of 13:39, 17 February 2010
Line 317:		Line 317:
	Restart the networking to enable the new multicast address on both groupware nodes. Also restart the Open-Xchange Server processes on all nodes.		Restart the networking to enable the new multicast address on both groupware nodes. Also restart the Open-Xchange Server processes on all nodes.
	$ /etc/init.d/networking restart		$ /etc/init.d/networking restart
	$ /etc/init.open-xchange-groupware restart		$ /etc/init.d/open-xchange-groupware restart
	$ /etc/init.open-xchange-admin restart		$ /etc/init.d/open-xchange-admin restart

	=== Test the network settings ===		=== Test the network settings ===

Holgi: /* Session load balancing */

2010-02-01T12:37:55Z

Session load balancing

← Older revision		Revision as of 12:37, 1 February 2010
Line 214:		Line 214:

	<IfModule mod_proxy_ajp.c>		<IfModule mod_proxy_ajp.c>
	~~ProxyRequests On~~
	~~ProxyVia On~~

	<Proxy *>		<Proxy *>

Mheiland at 09:37, 30 November 2009

2009-11-30T09:37:03Z

← Older revision		Revision as of 09:37, 30 November 2009
Line 29:		Line 29:
	* Database read/write separation		* Database read/write separation
	* Distributed file storage		* Distributed file storage
	* Remote logging

	~~== Concepts ==~~

	== Master/Slave database setup ==		== Master/Slave database setup ==

Mheiland at 16:55, 27 November 2009

2009-11-27T16:55:57Z

← Older revision		Revision as of 16:55, 27 November 2009
Line 1:		Line 1:
	= Load balancing and clustering Open-Xchange ~~(WORK IN PROGRESS)~~=		= Load balancing and clustering Open-Xchange =

	== General ==		== General ==
Line 355:		Line 355:
	It is important that each service is connected to each other while the foldercache is only connected between two groupware services. It can take some time until all connections are established after Open-Xchange Server has been started.		It is important that each service is connected to each other while the foldercache is only connected between two groupware services. It can take some time until all connections are established after Open-Xchange Server has been started.
	In this example, the first two lines indicate connections between the local groupware process and the remote admindaemon and groupware processes.		In this example, the first two lines indicate connections between the local groupware process and the remote admindaemon and groupware processes.

	~~== Remote logging ==~~

	[[Category: OX6]]		[[Category: OX6]]

Choeger: /* Configuring Open-Xchange Server */

2009-10-23T13:38:28Z

Configuring Open-Xchange Server

← Older revision		Revision as of 13:38, 23 October 2009
Line 250:		Line 250:
	Install all relevant Open-Xchange Server packages to both groupware nodes after adding the Open-Xchange software repository to your package manages configuration. This package selection does not contain user interface packages.		Install all relevant Open-Xchange Server packages to both groupware nodes after adding the Open-Xchange software repository to your package manages configuration. This package selection does not contain user interface packages.

	apt-get install{{OXPackageInstallation-Server}}		apt-get install{{OXPackageInstallation-Server\|javavendor=sun}}

	Create the ''configdb'' database at the MySQL Master. This step does only need to be performed on one of the Open-Xchange Server nodes.		Create the ''configdb'' database at the MySQL Master. This step does only need to be performed on one of the Open-Xchange Server nodes.

Mheiland: /* Configuring Open-Xchange Server */

2009-10-23T12:21:05Z

Configuring Open-Xchange Server

@@ Line 250: / Line 250: @@
 Install all relevant Open-Xchange Server packages to both groupware nodes after adding the Open-Xchange software repository to your package manages configuration. This package selection does not contain user interface packages.
-  apt-get install open-xchange open-xchange-authentication-database \
+  apt-get install{{OXPackageInstallation-Server}}
 Create the ''configdb'' database at the MySQL Master. This step does only need to be performed on one of the Open-Xchange Server nodes.

Mheiland: /* Session load balancing */

2009-10-23T12:20:42Z

Session load balancing

← Older revision		Revision as of 12:20, 23 October 2009
Line 210:		Line 210:
	For the web server we only need a very small set of packages, basically only packages that starts with ''open-xchange-gui'' where most of additional packages are languagespacks or plugins. Add the Open-Xchange software repository to the package manager configuration first. Then install the ''open-xchange-gui'' package to the web server.		For the web server we only need a very small set of packages, basically only packages that starts with ''open-xchange-gui'' where most of additional packages are languagespacks or plugins. Add the Open-Xchange software repository to the package manager configuration first. Then install the ''open-xchange-gui'' package to the web server.

	$ apt-get install ~~open~~-~~xchange-gui open-xchange-configjump-generic-gui \~~		$ apt-get install{{OXPackageInstallation-GUI}}
	~~open-xchange-online-help-de open-xchange-online-help-en open-xchange-online-help-fr~~

	This will install the Open-Xchange user interface, Apache 2 and several services as dependency. The Apache module ''proxy_ajp'' will handle all the communication with the Open-Xchange Servers. Its configuration also contains the setup of the session balancing. What it basically does is defining two backend nodes and forwarding servlet paths to them based on the ''loadfactor''. This setting can be customized in case the backend servers are not equal in terms of performance. The ''route'' property is important, it specifies a unique ID of a backend server and will be used when setting up Open-Xchange Servers later. Please see the Apache mod_proxy_ajp [http://httpd.apache.org/docs/2.2/mod/mod_proxy_ajp.html documentation] for more details.		This will install the Open-Xchange user interface, Apache 2 and several services as dependency. The Apache module ''proxy_ajp'' will handle all the communication with the Open-Xchange Servers. Its configuration also contains the setup of the session balancing. What it basically does is defining two backend nodes and forwarding servlet paths to them based on the ''loadfactor''. This setting can be customized in case the backend servers are not equal in terms of performance. The ''route'' property is important, it specifies a unique ID of a backend server and will be used when setting up Open-Xchange Servers later. Please see the Apache mod_proxy_ajp [http://httpd.apache.org/docs/2.2/mod/mod_proxy_ajp.html documentation] for more details.

← Older revision		Revision as of 10:36, 5 October 2010
Line 2:		Line 2:

	== General ==		== General ==
	Open-Xchange Server 6 is ~~primary~~ built for the Software-as-a-Service world. Hosting and telecommunication providers around the world use Open-Xchange to offer hosted services to their customers. Open-Xchange Server 6 scales ~~vertical~~ and ~~horizontal~~ which means either use a more powerful server or add more machines to fulfill resource requirements. While upgrading a single server installation ~~inevitable~~ gets to a point where costs rise faster than performance gains, adding some simple machines to the installation provides linear cost increase and a slightly more complex administration. Besides the fiscal impact of using medium sized servers another key argument for clustering is service availability, single nodes can go down for maintenance without influencing the general service availability. A typical scenario for clustering is virtualization where multiple nodes can provide resources on demand.		Open-Xchange Server 6 is primarily built for the Software-as-a-Service world. Hosting and telecommunication providers around the world use Open-Xchange to offer hosted services to their customers. Open-Xchange Server 6 scales vertically and horizontally which means either use a more powerful server or add more machines to fulfill resource requirements. While upgrading a single server installation inevitably gets to a point where costs rise faster than performance gains, adding some simple machines to the installation provides linear cost increase and a slightly more complex administration. Besides the fiscal impact of using medium sized servers another key argument for clustering is service availability, single nodes can go down for maintenance without influencing the general service availability. A typical scenario for clustering is virtualization where multiple nodes can provide resources on demand.

	One of the main principles of Open-Xchange Server 6 is the ability to utilize several medium sized servers. This guide will outline the basic principles of clustering Open-Xchange Server instances and provide load balancing to utilize all nodes of a cluster.		One of the main principles of Open-Xchange Server 6 is the ability to utilize several medium sized servers. This guide will outline the basic principles of clustering Open-Xchange Server instances and provide load balancing to utilize all nodes of a cluster.
Line 56:		Line 56:
	Enter password:		Enter password:

	Configure replication permissions for the MySQL slave server and the MySQL user "replication". This account is used by the MySQL slave to get database updates from the master. Please ~~chose~~ a strong password here.		Configure replication permissions for the MySQL slave server and the MySQL user "replication". This account is used by the MySQL slave to get database updates from the master. Please choose a strong password here.
	mysql> GRANT REPLICATION SLAVE ON . TO 'replication'@'10.20.30.219' IDENTIFIED BY 'secret';		mysql> GRANT REPLICATION SLAVE ON . TO 'replication'@'10.20.30.219' IDENTIFIED BY 'secret';

	Now setup access for the Open-Xchange Server database user ''openexchange'' to configdb and the groupware database for both groupware server addresses. These databases do not yet ~~exist~~, but will be created during the Open-Xchange Server installation.		Now setup access for the Open-Xchange Server database user ''openexchange'' to configdb and the groupware database for both groupware server addresses. These databases do not exist yet, but will be created during the Open-Xchange Server installation.
	mysql> GRANT ALL PRIVILEGES ON . TO 'openexchange'@'10.20.30.213' IDENTIFIED BY 'secret';		mysql> GRANT ALL PRIVILEGES ON . TO 'openexchange'@'10.20.30.213' IDENTIFIED BY 'secret';
	mysql> GRANT ALL PRIVILEGES ON . TO 'openexchange'@'10.20.30.215' IDENTIFIED BY 'secret';		mysql> GRANT ALL PRIVILEGES ON . TO 'openexchange'@'10.20.30.215' IDENTIFIED BY 'secret';
Line 96:		Line 96:
	mysql> CHANGE MASTER TO MASTER_HOST='10.20.30.217', MASTER_USER='replication', MASTER_PASSWORD='secret', MASTER_LOG_FILE='mysql-bin.000001', MASTER_LOG_POS=1082;		mysql> CHANGE MASTER TO MASTER_HOST='10.20.30.217', MASTER_USER='replication', MASTER_PASSWORD='secret', MASTER_LOG_FILE='mysql-bin.000001', MASTER_LOG_POS=1082;

	Now setup access for the Open-Xchange Server database user 'openexchange' to configdb and the oxdb for both groupware server addresses. These databases do not yet ~~exist~~, but will be created during the Open-Xchange Server installation.		Now setup access for the Open-Xchange Server database user 'openexchange' to configdb and the oxdb for both groupware server addresses. These databases do not exist yet, but will be created during the Open-Xchange Server installation.
	mysql> GRANT ALL PRIVILEGES ON . TO 'openexchange'@'10.20.30.213' IDENTIFIED BY 'secret';		mysql> GRANT ALL PRIVILEGES ON . TO 'openexchange'@'10.20.30.213' IDENTIFIED BY 'secret';
	mysql> GRANT ALL PRIVILEGES ON . TO 'openexchange'@'10.20.30.215' IDENTIFIED BY 'secret';		mysql> GRANT ALL PRIVILEGES ON . TO 'openexchange'@'10.20.30.215' IDENTIFIED BY 'secret';
Line 140:		Line 140:

	== Distributed file storage ==		== Distributed file storage ==
	The distributed file storage will be set up on the MySQL database master server. Of course it is possible to use a dedicated file server or a already existing storage system, this guide does not cover that. This has several reasons:		The distributed file storage will be set up on the MySQL database master server. Of course it is possible to use a dedicated file server or an already existing storage system, however this guide does not cover that. This has several reasons:
	* Open-Xchange Server does not require much I/O on typical operation		* Open-Xchange Server does not require much I/O on typical operation
	* Data for groupware objects like the Infostore is stored at the file storage and file metadata is stored at the database. Consistency between the database and the file storage is critical.		* Data for groupware objects like the Infostore is stored at the file storage and file metadata is stored at the database. Consistency between the database and the file storage is critical.
Line 152:		Line 152:
	$ mkdir /var/opt/filestore		$ mkdir /var/opt/filestore

	Open-Xchange Server runs as user ''open-xchange'', create a user account at the NFS server, this is required for accessing the NFS export later. NFS will map the user id (uid) and group id (gid), ~~therefor~~ they need to be equal at the Open-Xchange Server nodes and the NFS server.		Open-Xchange Server runs as user ''open-xchange'', create a user account at the NFS server, this is required for accessing the NFS export later. NFS will map the user id (uid) and group id (gid), therefore they need to be equal at the Open-Xchange Server nodes and the NFS server.
	$ useradd open-xchange		$ useradd open-xchange

	Check the uid and gid, typically ~~its~~ 1001:1001 since it's the first user on the system.		Check the uid and gid, typically it's 1001:1001 since it's the first user on the system.
	$ grep open-xchange /etc/passwd		$ grep open-xchange /etc/passwd
	open-xchange:x:1001:1001::/home/open-xchange:/bin/sh		open-xchange:x:1001:1001::/home/open-xchange:/bin/sh
Line 178:		Line 178:
	$ mkdir /var/opt/filestore/		$ mkdir /var/opt/filestore/

	Open-Xchange Server runs as user ''open-xchange'', to let this user access the filestore, create a user account at all Open-Xchange Server nodes. NFS will map the user id (uid) and group id (gid) to the ones at the NFS server, ~~therefor~~ they need to be equal at the Open-Xchange Server nodes and the NFS Server.		Open-Xchange Server runs as user ''open-xchange'', to let this user access the filestore, create a user account at all Open-Xchange Server nodes. NFS will map the user id (uid) and group id (gid) to the ones at the NFS server, therefore they need to be equal at the Open-Xchange Server nodes and the NFS Server.
	$ useradd open-xchange		$ useradd open-xchange
	$ grep open-xchange /etc/passwd		$ grep open-xchange /etc/passwd
Line 201:		Line 201:

	== Session load balancing ==		== Session load balancing ==
	Since configuration of system services for the corresponding operating system is already described at the general [[Main_Page#Installation_based_on_packages\|installation guides]], this guide will focus on the specialties when creating a ~~distributing~~ setup. Please refer to the [[Main_Page#Installation_based_on_packages\|installation guides]] for configuration that is not mentioned in this guide.		Since configuration of system services for the corresponding operating system is already described in the general [[Main_Page#Installation_based_on_packages\|installation guides]], this guide will focus on the specialties when creating a distributed setup. Please refer to the [[Main_Page#Installation_based_on_packages\|installation guides]] for configuration that is not mentioned in this guide.

	The web server on this setup is a pure frontend server. This means it takes and responds to requests sent by a client but it does not contain any groupware logic. All requests are forwarded to the Open-Xchange Servers through the ''AJP13'' protocol. The configuration will allow round-robin session load balancing, basically both Open-Xchange servers are configured as backends for answering requests with an 50:50 probability of being chosen. Once a new session is created, that session is bound to the groupware server it has been created.		The web server on this setup is a pure frontend server. This means it takes and responds to requests sent by a client but it does not contain any groupware logic. All requests are forwarded to the Open-Xchange Servers through the ''AJP13'' protocol. The configuration will allow round-robin session load balancing, basically both Open-Xchange servers are configured as backends for answering requests with an 50:50 probability of being chosen. Once a new session is created, that session is bound to the groupware server it has been created.

	For the web server we only need a very small set of packages, basically only packages that starts with ''open-xchange-gui'' where most of additional packages are ~~languagespacks~~ or plugins. Add the Open-Xchange software repository to the package manager configuration first. Then install the ''open-xchange-gui'' package to the web server.		For the web server we only need a very small set of packages, basically only packages that starts with ''open-xchange-gui'' where most of additional packages are languagepacks or plugins. Add the Open-Xchange software repository to the package manager configuration first. Then install the ''open-xchange-gui'' package to the web server.

	$ apt-get install{{OXPackageInstallation-GUI}}		$ apt-get install{{OXPackageInstallation-GUI}}
Line 265:		Line 265:
	$ /opt/open-xchange/sbin/registerfilestore -A oxadminmaster -P secret -t file:///var/opt/filestore		$ /opt/open-xchange/sbin/registerfilestore -A oxadminmaster -P secret -t file:///var/opt/filestore

	Now register the MySQL Master database at configdb. This step does only need to be performed on one of the Open-Xchange Server nodes.		Now register the MySQL Master database in configdb. This step does only need to be performed on one of the Open-Xchange Server nodes.
	$ /opt/open-xchange/sbin/registerdatabase -A oxadminmaster -P secret --name oxdatabase --hostname 10.20.30.217 --dbuser openexchange --dbpasswd secret --master true		$ /opt/open-xchange/sbin/registerdatabase -A oxadminmaster -P secret --name oxdatabase --hostname 10.20.30.217 --dbuser openexchange --dbpasswd secret --master true
	database 4 registered		database 4 registered

	Check the returned database ID which is 4 in this case. This value is required to register the MySQL Slave database at configdb. This step does only need to be performed on one of the Open-Xchange Server nodes.		Check the returned database ID which is 4 in this case. This value is required to register the MySQL Slave database in configdb. This step does only need to be performed on one of the Open-Xchange Server nodes.
	$ /opt/open-xchange/sbin/registerdatabase -A oxadminmaster -P secret --name oxdatabase_slave --hostname 10.20.30.219 --dbuser openexchange --dbpasswd secret --master false --masterid=4		$ /opt/open-xchange/sbin/registerdatabase -A oxadminmaster -P secret --name oxdatabase_slave --hostname 10.20.30.219 --dbuser openexchange --dbpasswd secret --master false --masterid=4

Line 297:		Line 297:
	Open-Xchange Server uses multicast discovery to find other nodes. Once this discovery has been successful, the groupware nodes will establish TCP connections for cache communication.		Open-Xchange Server uses multicast discovery to find other nodes. Once this discovery has been successful, the groupware nodes will establish TCP connections for cache communication.

	Configure a multicast address for the servers network. This needs to be done on all groupware nodes.		Configure a multicast address for the servers' network. This needs to be done on all groupware nodes.
	$ vim /etc/network/interfaces		$ vim /etc/network/interfaces
	[...]		[...]
Line 346:		Line 346:
	tcp6 0 0 oxgw01:57461 oxgw02:44893 ESTABLISHED 3582/java		tcp6 0 0 oxgw01:57461 oxgw02:44893 ESTABLISHED 3582/java

	How to verify those ~~connection~~? The last line shows a process id (PID) of the local process that has an established connection. In this case, PID3706 is the Open-Xchange Groupware Daemon and PID3582 is the Open-Xchange Administration Daemon.		How to verify those connections? The last line shows a process id (PID) of the local process that has an established connection. In this case, PID3706 is the Open-Xchange Groupware Daemon and PID3582 is the Open-Xchange Administration Daemon.
	These services build mesh connections between each groupware, each admindaemon and each foldercache service. Some connections are used ~~bidirectional~~ so only one connection is visible, others use two connections (inbound and outbound) depending on the network responses.		These services build mesh connections between each groupware, each admindaemon and each foldercache service. Some connections are used bidirectionally so only one connection is visible, others use two connections (inbound and outbound) depending on the network responses.
	It is important that each service is connected to each other while the foldercache is only connected between two groupware services. It can take some time until all connections are established after Open-Xchange Server has been started.		It is important that each service is connected to each other while the foldercache is only connected between two groupware services. It can take some time until all connections are established after Open-Xchange Server has been started.
	In this example, the first two lines indicate connections between the local groupware process and the remote admindaemon and groupware processes.		In this example, the first two lines indicate connections between the local groupware process and the remote admindaemon and groupware processes.

	[[Category: OX6]]		[[Category: OX6]]