Revision: fab606324624
Author: [email protected] <[email protected]>
Date: Tue Dec 11 12:28:33 2012
Log: diameter-gq doc review
http://code.google.com/p/jain-slee/source/detail?r=fab606324624&repo=diameter
Modified:
/resources/diameter-gq/docs/sources/src/main/resources/en-US/Chapter-Clustering.xml
/resources/diameter-gq/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra-type/Chapter-Resource_Adaptor_Type.xml
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra-type/Section-Activities.xml
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra-type/Section-Events.xml
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra/Section-Configuration.xml
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra/Section-Default_Resource_Adaptor_Entities.xml
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra/Section-Logging_Traces_and_Alarms.xml
=======================================
---
/resources/diameter-gq/docs/sources/src/main/resources/en-US/Chapter-Clustering.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-gq/docs/sources/src/main/resources/en-US/Chapter-Clustering.xml
Tue Dec 11 12:28:33 2012
@@ -10,10 +10,12 @@
<section
id="ra_clustering_failover">
<title>Failover</title>
- <para>
- The Diameter stack used by the &THIS.PLATFORM; JAIN SLEE &THIS.RA;
Resource Adaptor supports application session failover, with specific
session state being replicated, thus only available for Application
sessions.
- Failover of application activities is transparent to SLEE applications.
This means that SLEE applications must be in charge of properly adapting
its state machine to recover generic session on node failure.
+
+<para>
+ The Diameter stack used by the &THIS.PLATFORM; JAIN SLEE &THIS.RA;
Resource Adaptor supports application session failover with specific
session state being replicated. Therefore, failover is only available for
Application sessions.
+ Failover of application activities is transparent to SLEE applications.
This means that SLEE applications must be in charge of correctly adapting
its state machine to recover generic session on node failure.
</para>
+
</section>
<section
id="ra_clustering_load_balancing">
=======================================
---
/resources/diameter-gq/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
Tue Sep 11 20:38:40 2012
+++
/resources/diameter-gq/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
Tue Dec 11 12:28:33 2012
@@ -10,15 +10,18 @@
<section id="preinstall_requirements_and_prerequisites">
<title>Pre-Install Requirements and Prerequisites</title>
- <para>Ensure that the following requirements have been met before
continuing with the install.</para>
+ <para>Ensure that the following requirements have been met before
continuing with the installation</para>
<section id="hardware_requirements">
<title>Hardware Requirements</title>
- <para>The Resource Adaptor hardware's main concern is RAM memory and
Java Heap size, the more the better. For instance, while the underlying
&THIS.PLATFORM; JAIN SLEE may run with 1GB of RAM, 8GB is needed to achieve
performance higher than 800 new requests per second.</para>
- <para>Of course, memory is only needed to store the Resource Adaptor
state, the faster the CPU more requests per second are supported, yet no
particular CPU is a real requirement to use the RA.</para>
+ <para>RAM and Java Heap size are very important with regards to
Resource Adaptor. The more the RAM, the better the performance will be. For
instance, while the underlying &THIS.PLATFORM; JAIN SLEE may run with 1GB
of RAM, 8GB is needed to achieve performance higher than 800 new requests
per second.</para>
+
+<para>Memory is only needed to store the Resource Adaptor state.
Consequently, having a faster CPU means that the system will be able to
handle more request per second. That said, there is no minimum specified
CPU speed required to use the RA.</para>
+
+
</section>
<section id="software_prerequisites">
<title>Software Prerequisites</title>
- <para>The RA requires &THIS.PLATFORM; JAIN SLEE properly set and
Mobicents Diameter Multiplexer (<acronym>MUX</acronym>), which includes the
stack, &THIS.PLATFORM; Diameter Base RA and &THIS.PLATFORM; Diameter CCA RA
to be properly installed too.</para>
+ <para>The RA requires that &THIS.PLATFORM; JAIN SLEE is correctly set
and that Mobicents Diameter Multiplexer (<acronym>MUX</acronym>), which
includes the stack, &THIS.PLATFORM; Diameter Base RA and &THIS.PLATFORM;
Diameter CCA RA are correctly installed.</para>
</section>
</section>
@@ -34,7 +37,10 @@
<important>
<para>Git is used to manage Mobicents JAIN SLEE source code.
Instructions for downloading, installing and using Git can be found at
<ulink url="http://git-scm.com/"; /></para>
</important>
- <para>Use Git to checkout a specific release source, the Git
repository URL is &THIS.SOURCE_CODE_URL; , then switch to the specific
release version, lets consider &THIS.VERSION;.</para>
+
+<para>Use Git to checkout a specific release source. The Git repository
URL located at &THIS.SOURCE_CODE_URL;. Choose the desired release version
as can be seen in the following example: &THIS.VERSION;.</para>
+
+
<programlisting>
[usr]$ git clone &THIS.SOURCE_CODE_URL;
mobicents-jain-slee-diameter
[usr]$ cd mobicents-jain-slee-diameter
@@ -51,14 +57,21 @@
[usr]$ cd resources/&THIS.RA.DIRNAME;
[usr]$ mvn install
</programlisting>
- <para>Once the process finishes you should have the
<literal>deployable-unit</literal> jar file in the
<filename>target</filename> directory, if &THIS.PLATFORM; JAIN SLEE is
installed and environment variable JBOSS_HOME is pointing to its underlying
&JEE.PLATFORM; directory, then the deployable unit jar will also be
deployed in the container.</para>
+
+<para>Once the build is completed, you should have the
<literal>deployable-unit</literal> jar file in the
<filename>target</filename> directory. If the &THIS.PLATFORM; JAIN SLEE is
installed and the environment variable JBOSS_HOME is pointing to its
underlying &JEE.PLATFORM; directory, then, the deployable unit jar will
also be deployed in the container.</para>
+
+
</step>
</procedure>
</section>
<section id="master_source_building">
<title>Development Master Source Building</title>
- <para>Similar process as for <xref linkend="release_source_building"/>,
the only change is the Git reference should be the
<literal>master</literal>. The <literal>git checkout
tags/&THIS.VERSION;</literal> command should not be performed. If already
performed, the following should be used in order to switch back to the
master:</para>
+
+
+ <para>The procedure is similar to <xref
linkend="release_source_building"/>. The Git reference should point to
<literal>master</literal> branch . The <literal>git checkout
tags/&THIS.VERSION;</literal> command should not be performed. To switch to
the <literal>master</literal> branch, perform the following: </para>
+
+
<programlisting>
[usr]$ git checkout master
</programlisting>
@@ -72,16 +85,16 @@
<programlisting>
[usr]$ ant
</programlisting>
- <para>The script will copy the RA deployable unit jar to the
<literal>default</literal> &THIS.PLATFORM; JAIN SLEE server profile deploy
directory, to deploy to another server profile use the argument
<literal>-Dnode=</literal>.</para>
+ <para>The script will copy the RA deployable unit jar to the
<literal>default</literal> &THIS.PLATFORM; JAIN SLEE server/default/deploy
directory, to deploy to another server profile use the argument
<literal>-Dnode=</literal>.</para>
</section>
<section id="uninstall">
<title>Uninstalling &THIS.PLATFORM; JAIN SLEE &THIS.RA; Resource
Adaptor</title>
- <para>To uninstall the Resource Adaptor simply execute provided ant
script <filename>build.xml</filename> <literal>undeploy</literal>
target:</para>
+ <para>To uninstall the Resource Adaptor, execute the provided ant script
<filename>build.xml</filename> <literal>undeploy</literal> target:</para>
<programlisting>
[usr]$ ant undeploy
</programlisting>
- <para>The script will delete the RA deployable unit jar from the
<literal>default</literal> &THIS.PLATFORM; JAIN SLEE server profile deploy
directory, to undeploy from another server profile use the argument
<literal>-Dnode=</literal>.</para>
+ <para>The script will delete the RA deployable unit jar from the
<literal>default</literal> &THIS.PLATFORM; JAIN SLEE server/default/deploy
directory, to undeploy from another server profile use the argument
<literal>-Dnode=</literal>.</para>
</section>
</chapter>
=======================================
---
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra-type/Chapter-Resource_Adaptor_Type.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra-type/Chapter-Resource_Adaptor_Type.xml
Tue Dec 11 12:28:33 2012
@@ -9,7 +9,7 @@
<title>Resource Adaptor Type</title>
- <para>&THIS.RA; Resource Adaptor Type is defined by Mobicents team as
part of effort to standardize RA Types.</para>
+ <para>&THIS.RA; Resource Adaptor Type is defined by the Mobicents team as
part of the effort to standardize RA Types.</para>
<xi:include
xmlns:xi="http://www.w3.org/2001/XInclude";
=======================================
---
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra-type/Section-Activities.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra-type/Section-Activities.xml
Tue Dec 11 12:28:33 2012
@@ -30,8 +30,7 @@
</varlistentry>
</variablelist>
- <para>
- All activities define methods required to properly function and expose
necessary information to <acronym>JAIN SLEE</acronym> services.
+ <para>All activities define the methods that are required to ensure
correct functionality and to expose necessary information to <acronym>JAIN
SLEE</acronym> services.
Gq' Server Activity is defined as follows:
</para>
=======================================
---
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra-type/Section-Events.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra-type/Section-Events.xml
Tue Dec 11 12:28:33 2012
@@ -100,6 +100,6 @@
</table>
<important>
- <para>Spaces where introduced in <literal>Name</literal> and
<literal>Event Class</literal> column values, to correctly render the
table. Please remove them when using copy/paste.</para>
+ <para>Spaces where introduced in <literal>Name</literal> and
<literal>Event Class</literal> column values so that the tables can be
correctly rendered. Please remove the spaces them when using
copy/paste.</para>
</important>
</section>
=======================================
---
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
Tue Dec 11 12:28:33 2012
@@ -9,7 +9,9 @@
<title>Resource Adaptor Implementation</title>
- <para>This <acronym>RA</acronym> uses the &THIS.PLATFORM; Diameter Stack,
an improvement over <ulink url="http://jdiameter.dev.java.net";>jDiameter
Stack</ulink>. The stack is the result of the work done by &THIS.PLATFORM;
Diameter and jDiameter development teams, and source code is provided in
all releases.</para>
+ <para>This <acronym>RA</acronym> uses the &THIS.PLATFORM; Diameter Stack,
an improvement over <ulink url="http://jdiameter.dev.java.net";>jDiameter
Stack</ulink>. The stack is the result of the work done by the
&THIS.PLATFORM; and the jDiameter development teams. Source codes are
provided in all releases
+
+</para>
<xi:include
xmlns:xi="http://www.w3.org/2001/XInclude";
=======================================
---
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra/Section-Configuration.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra/Section-Configuration.xml
Tue Dec 11 12:28:33 2012
@@ -38,7 +38,7 @@
</table>
<important>
- <para>JAIN SLEE 1.1 Specification requires values set for properties
without a default value, which means the configuration for those properties
are mandatory, otherwise the Resource Adaptor Entity creation will
fail!</para>
+ <para>JAIN SLEE 1.1 Specification requires that values are set for
properties that do not have a default value. This means that the
configuration for those properties are mandatory, otherwise, the Resource
Adaptor Entity creation will fail!</para>
</important>
</section>
=======================================
---
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra/Section-Default_Resource_Adaptor_Entities.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra/Section-Default_Resource_Adaptor_Entities.xml
Tue Dec 11 12:28:33 2012
@@ -11,7 +11,7 @@
<para>There is a single Resource Adaptor Entity created when deploying
the Resource Adaptor, named <literal>DiameterGq</literal>. The
<literal>DiameterGq</literal> entity uses the default Resource Adaptor
configuration, specified in <xref linkend="ra_configuration" />.</para>
- <para>The <literal>DiameterGq</literal> entity is also bound to Resource
Adaptor Link Name <literal>DiameterGq</literal>, to use it in an Sbb add
the following XML to its descriptor:</para>
+ <para>The <literal>DiameterGq</literal> entity is also bound to Resource
Adaptor Link Name <literal>DiameterGq</literal>. In order to use the
entity in an Sbb, add the following XML to its descriptor:</para>
<programlisting language="XML" role="XML"><![CDATA[
<resource-adaptor-type-binding>
=======================================
---
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra/Section-Logging_Traces_and_Alarms.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-gq/docs/sources/src/main/resources/en-US/ra/Section-Logging_Traces_and_Alarms.xml
Tue Dec 11 12:28:33 2012
@@ -11,7 +11,9 @@
<section id="ra_tracers">
<title>Tracers</title>
- <para>Each Resource Adaptor Entity uses a single JAIN SLEE 1.1 Tracer,
named <literal>DiameterGqResourceAdaptor</literal>. The related Log4j
Logger category, which can be used to change the Tracer level from Log4j
configuration, is
<literal>javax.slee.RAEntityNotification[entity=DiameterGq]</literal>.</para>
+ <para>Each Resource Adaptor Entity uses a single JAIN SLEE 1.1 Tracer,
named <literal>DiameterGqResourceAdaptor</literal>. The related Log4j
Logger category,
<literal>javax.slee.RAEntityNotification[entity=DiameterGq]</literal>, can
be used to change the tracer level from the Log4j configuration.
+
+</para>
</section>
<section id="ra_alarms">
