Revision: 72ac7602dcbe
Author: [email protected] <[email protected]>
Date: Wed Jan 2 07:41:24 2013
Log: doc review diameter-rx resource adaptor
http://code.google.com/p/jain-slee/source/detail?r=72ac7602dcbe&repo=diameter
Modified:
/resources/diameter-rx/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
/resources/diameter-rx/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
/resources/diameter-rx/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
/resources/diameter-rx/docs/sources/src/main/resources/en-US/ra/Section-Configuration.xml
=======================================
---
/resources/diameter-rx/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-rx/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
Wed Jan 2 07:41:24 2013
@@ -7,7 +7,7 @@
<chapter id="introduction">
<title>Introduction to &THIS.PLATFORM; JAIN SLEE &THIS.RA; Resource
Adaptor</title>
- <para>This resource adaptor provides a Diameter API for JAIN SLEE
applications, according to Rx interface based on Diameter protocol.</para>
+ <para>This resource adaptor provides a Diameter API for JAIN SLEE
applications according to Rx interface which is based on Diameter
protocol.</para>
<para>The Rx reference point is used to exchange application level
session information between the Policy and Charging Rules Function
(<acronym>PCRF</acronym>) and the Application Function
(<acronym>AF</acronym>). This information is part of the input used by the
<acronym>PCRF</acronym> for the Policy and Charging Control
(<acronym>PCC</acronym>) decisions. The <acronym>PCRF</acronym> exchanges
the <acronym>PCC</acronym> rules with the Policy and Charging Enforcement
Function (<acronym>PCEF</acronym>) and <acronym>QoS</acronym> rules with
the Bearer Binding and Event Reporting Function
(<acronym>BBERF</acronym>).</para>
<para>Events represent Diameter Rx messages received by the Diameter
stack. Different events types are specified for each Diameter request or
answer. Events are fired either on client or server activities.</para>
<para>The Activities are defined by <acronym>RA</acronym> Type to ease
use of <acronym>RA</acronym>. Activities represent Diameter session between
two peers. <acronym>SLEE</acronym> applications use activities to create,
send and receive messages.</para>
=======================================
---
/resources/diameter-rx/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
Tue Sep 11 20:38:40 2012
+++
/resources/diameter-rx/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
Wed Jan 2 07:41:24 2013
@@ -10,15 +10,27 @@
<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 Mobicents 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. Therefore, the
faster the CPU, the more requests per second can be quickly processed. 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 configured and
that 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.</para>
</section>
</section>
@@ -34,7 +46,7 @@
<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 is 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,7 +63,7 @@
[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 &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>
</step>
</procedure>
</section>
@@ -72,12 +84,14 @@
<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; 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 simply execute the provided ant
script <filename>build.xml</filename> <literal>undeploy</literal>
target:</para>
<programlisting>
[usr]$ ant undeploy
</programlisting>
=======================================
---
/resources/diameter-rx/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-rx/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
Wed Jan 2 07:41:24 2013
@@ -9,7 +9,7 @@
<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
which is 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; Diameter and the
jDiameter development teams. The source code is provided in all
releases.</para>
<xi:include
xmlns:xi="http://www.w3.org/2001/XInclude";
=======================================
---
/resources/diameter-rx/docs/sources/src/main/resources/en-US/ra/Section-Configuration.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-rx/docs/sources/src/main/resources/en-US/ra/Section-Configuration.xml
Wed Jan 2 07:41:24 2013
@@ -38,7 +38,10 @@
</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
without a default value. This means that the configuration for those
properties are mandatory, otherwise, the Resource Adaptor Entity creation
will fail!
+
+</para>
</important>
</section>
