Author: jbonofre
Date: Tue Jul 21 20:31:07 2009
New Revision: 796522
URL: http://svn.apache.org/viewvc?rev=796522&view=rev
Log:
Resuming installation guide.
Modified:
servicemix/sandbox/jbonofre/documentation/src/docbook/installation-guide.xml
Modified:
servicemix/sandbox/jbonofre/documentation/src/docbook/installation-guide.xml
URL:
http://svn.apache.org/viewvc/servicemix/sandbox/jbonofre/documentation/src/docbook/installation-guide.xml?rev=796522&r1=796521&r2=796522&view=diff
==============================================================================
---
servicemix/sandbox/jbonofre/documentation/src/docbook/installation-guide.xml
(original)
+++
servicemix/sandbox/jbonofre/documentation/src/docbook/installation-guide.xml
Tue Jul 21 20:31:07 2009
@@ -21,38 +21,32 @@
<book id="book" label="Apache ServiceMix Installation Guide" status="draft"
lang="en">
<title>Apache ServiceMix @version@ Installation Guide</title>
- <titleabbrv>smx install guide</titleabbrv>
<bookinfo>
<authorgroup>
<author>
<firstname>Guillaume</firstname>
<surname>Nodet</surname>
<email>[email protected]</email>
- <othername>gnodet</othername>
</author>
<author>
<firstname>Gert</firstname>
<surname>Vanthienen</surname>
<email>[email protected]</email>
- <othername>gertv</othername>
</author>
<author>
<firstname>Lars</firstname>
<surname>Heinemann</surname>
<email>[email protected]</email>
- <othername>lhein</othername>
</author>
<author>
<firstname>Jean-Baptiste</firstname>
<surname>Onofre</surname>
<email>[email protected]</email>
- <othername>jbonofre</othername>
</author>
<author>
<firstname>Bruce</firstname>
<surname>Snyder</surname>
<email>[email protected]</email>
- <othername>bsnyder</othername>
</author>
</authorgroup>
<copyright>
@@ -112,4 +106,156 @@
</para>
</chapter>
+ <chapter id="requirement">
+ <title>Installation Requirements</title>
+ <section id="hardware">
+ <title>Hardware</title>
+ <para>
+ <itemizedlist>
+ <listitem><para>100 MB of disk space for the ServiceMix
@version@ binary distribution.</para></listitem>
+ </itemizedlist>
+ </para>
+ </section>
+ <section id="OS">
+ <title>Operating Systems</title>
+ <para>
+ <itemizedlist>
+ <listitem><para><emphasis>Microsoft Windows</emphasis>: XP
SP2, 2000, 2003, Vista, 7</para></listitem>
+ <listitem><para><emphasis>Unix</emphasis>: any Unix/Linux
platform that supports Java.</para></listitem>
+ </itemizedlist>
+ </para>
+ </section>
+ <section id="environment">
+ <title>Environment</title>
+ <para>
+ <itemizedlist>
+ <listitem><para>Java Developer Kit (JDK) 1.5.x (Java 5)
for both deployment and compiling.</para></listitem>
+ </itemizedlist>
+ </para>
+ </section>
+ <section id="download">
+ <title>Get Apache ServiceMix @version@</title>
+ <para>
+ You can download Apache ServiceMix @version@ here:
<ulink>http://servicemix.apache.org/download.html</ulink>.
+ </para>
+ <para>
+ Apache ServiceMix is provided in two formats:
+ <itemizedlist>
+ <listitem><para>tarball for Unix platform</para></listitem>
+ <listitem><para>zip for Windows platform</para></listitem>
+ </itemizedlist>
+ </para>
+ </section>
+ </chapter>
+
+ <chapter id="install_standalone">
+ <title>Standalone Binary Distribution Installation Procedure</title>
+ <section id="uncompress">
+ <title>Uncompress</title>
+ <para>
+ Frist you need to uncompress the downloaded archive (tarball
or zip) in the directory of your choice (where you have write permissions).
+ Define the SERVICEMIX_HOME variable:
+ <example><title>Windows</title>
+ <programlisting>
+ > set SERVICEMIX_HOME=C:\apache-servicem...@version@
+ </programlisting>
+ </example>
+ <example><title>Linux/Unix</title>
+ <programlisting>
+ $ export SERVICEMIX_HOME=/apache-servicem...@version@
+ </programlisting>
+ </example>
+ </para>
+ </section>
+ <section id="start">
+ <title>Starting ServiceMix</title>
+ <example><title>Windows</title>
+ <programlisting>
+ > cd %SERVICEMIX_HOME%
+ > .\bin\servicemix
+ </programlisting>
+ </example>
+ <example><title>Linux/Unix</title>
+ <programlisting>
+ $ cd $SERVICEMIX_HOME
+ $ ./bin/servicemix
+ </programlisting>
+ </example>
+ </section>
+ <section id="stop">
+ <title>Stopping ServiceMix</title>
+ <para>
+ For both Windows and Unix installations, terminate ServiceMix
by typing "CTRL-C" on the command line where ServiceMix is running. ServiceMix
uses the Java shutdown hook to cleanly shut down the container.
+ </para>
+ </section>
+ </chapter>
+
+ <chapter id="install_embedded">
+ <title>ServiceMix Into A JEE Application Server Installation
Procedure</title>
+
+ </chapter>
+
+ <chapter id="configuration">
+ <title>ServiceMix Configuration</title>
+ <para>
+ This section contains description of main ServiceMix directories
and files :
+ <itemizedlist>
+ <listitem><para><emphasis>activemq-data</emphasis> - this
directory is created by the ServiceMix at startup time. It contains the
messages and transactions repository of the embedded Apache
ActiveMQ.</para></listitem>
+ <listitem><para><emphasis>bin/servicemix</emphasis> - contains
the main startup script of Apache ServiceMix.</para></listitem>
+ <listitem><para><emphasis>conf/activemq.xml</emphasis> -
contains the embedded Apache ActiveMQ configuration. This file shouldn't be
modified as it's managed by internal ServiceMix processes.</para></listitem>
+
<listitem><para><emphasis>conf/components.properties</emphasis> - contains the
tuning of embedded JBI components. See the tuning section for more
informations.</para></listitem>
+ <listitem><para><emphasis>conf/servicemix.conf</emphasis> -
contains the ServiceMix launcher classloading definition. This file shouldn't
be modified.</para></listitem>
+
<listitem><para><emphasis>conf/servicemix.properties</emphasis> - it's the main
ServiceMix configuration file. It defines the port numbers used by the
ServiceMix. You can change this file if one of the port number is already bound
on your system.
+ By default, ServiceMix uses the following ports :
+ <itemizedlist>
+ <listitem><para>1099 (rmi.port) - the core RMI port
used by the ServiceMix.</para></listitem>
+ <listitem><para>61616 (activemq.port) - the embedded
Apache ActiveMQ port.</para></listitem>
+ </itemizedlist>
+ </para></listitem>
+ <listitem><para><emphasis>conf/servicemix.xml</emphasis> -
contains the main ServiceMix Spring application context. This file mustn't be
modified.</para></listitem>
+ <listitem><para><emphasis>conf/groups.properties</emphasis> -
contains ServiceMix JAAS security group definition. You can define group
security to access to ServiceMix via JMX.</para></listitem>
+ <listitem><para><emphasis>conf/jmx.xml</emphasis> - contains
ServiceMix JMX layer application context. This file mustn't be
modified.</para></listitem>
+ <listitem><para><emphasis>conf/jndi.properties</emphasis> -
contains the default ServiceMix JNDI definition. This file shouldn't be
modified as it's managed by ServiceMix internal processes.</para></listitem>
+ <listitem><para><emphasis>conf/keystore.jks</emphasis> -
contains the security keys and certificates used by ServiceMix security layer.
This file mustn't be modified.</para></listitem>
+ <listitem><para><emphasis>conf/log4j.xml</emphasis> - contains
ServiceMix logging definition. You can change this file to change the default
log level of ServiceMix components. You can add new loggers if
required.</para></listitem>
+ <listitem><para><emphasis>conf/login.properties</emphasis> -
contains ServiceMix JAAS security definition. This file mustn't be
changed.</para></listitem>
+ <listitem><para><emphasis>conf/security.xml</emphasis> -
contains ServiceMix Security layer application context. This file mustn't be
modified.</para></listitem>
+ <listitem><para><emphasis>conf/tx.xml</emphasis> - contains
ServiceMix Transaction layer application context. This file mustn't be
modified.</para></listitem>
+
<listitem><para><emphasis>conf/users-credentials.properties</emphasis> -
contains ServiceMix JAAS security users and credentials (in case of external
security module). You can define users allowed to administrate ServiceMix via
JMX.</para></listitem>
+
<listitem><para><emphasis>conf/users-passwords.properties</emphasis> - contains
basic ServiceMix JAAS seucrity users and passwords (internal). You can add
users allowed to administrate ServiceMix via JMX.</para></listitem>
+ <listitem><para><emphasis>data/log/servicemix.log</emphasis> -
this file is created by ServiceMix at startup time. It contains main ServiceMix
log file.</para></listitem>
+ <listitem><para><emphasis>data</emphasis> - this directory is
created by ServiceMix at startup time. It contains all required file (storage)
required by ServiceMix internal components.</para></listitem>
+ <listitem><para><emphasis>extras</emphasis> - this directory
contains extras JAR files required by JBI components deployed in ServiceMix. If
you want to add JAR files in ServiceMix classloader, use <command>lib</command>
directory.</para></listitem>
+ <listitem><para><emphasis>hotdeploy</emphasis> - this
directory contains JBI components (services) automatically deployed by
ServiceMix.</para></listitem>
+ <listitem><para><emphasis>lib</emphasis> - this directory
contains all required JAR files for ServiceMix. You can add new JAR file in
this directory if required.</para></listitem>
+ </itemizedlist>
+ </para>
+ </chapter>
+
+ <chapter id="deploy">
+ <title>Deploying components and services into ServiceMix</title>
+ </chapter>
+
+ <chapter id="tuning">
+ <title>Tuning ServiceMix</title>
+ <para>
+ You can tune ServiceMix at three basic levels :
+ <itemizedlist>
+ <listitem><para><emphasis>Underlying JVM</emphasis> -
ServiceMix uses an underlying JVM to run. By default, the JVM configuration is
set to 512MB of maximum memory usage (that is enough for most of usage). Anyway
if you encounter OutOfMemory problem and bad performances, you can define JVM
parameters.
+ To do it, create a <command>conf/servicemix.rc</command>
file. In this file, you can define JAVA_MIN_MEM and JAVA_MAX_MEM variables.
+ </para></listitem>
+ <listitem><para><emphasis>Core Engine Tuning</emphasis> - in
the <command>conf/servicemix.properties</command> file, you can see three
properties :
+ <itemizedlist>
+
<listitem><para><emphasis>smx.corePoolSize</emphasis> - define the startup
number of ServiceMix threads. By default, 16 threads are
started.</para></listitem>
+
<listitem><para><emphasis>smx.maximumPoolSize</emphasis> - define the maximum
number of ServiceMix threads. If you see some bottlenecks around thread waits,
you can increase this value. By default, 32 threads maximum are
allowed.</para></listitem>
+ <listitem><para><emphasis>smx.queueSize</emphasis>
- define the maximum of messages store in the embedded Apache ActiveMQ. If you
see some bottlenecks around message waits, you can increase this value. By
default, ServiceMix can store 256 messages.</para></listitem>
+ </itemizedlist>
+ </para></listitem>
+ <listitem><para><emphasis>Components Tuning</emphasis> - You
can tune ServiceMix embedded JBI components using the
<command>conf/components.properties</command>.
+ By default, this file contains the basic tuning for the
HTTP components.
+ </para></listitem>
+ </itemizedlist>
+ </para>
+ </chapter>
+
</book>
\ No newline at end of file
