[jboss-svn-commits] JBL Code SVN: r35547 - labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Sun Oct 17 20:27:26 EDT 2010
Author: misty at redhat.com
Date: 2010-10-17 20:27:25 -0400 (Sun, 17 Oct 2010)
New Revision: 35547
Added:
labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Additional_JAR_Requirements.xml
labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Logging.xml
labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Operating_System_Services.xml
labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Preparing_Your_System.xml
labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Setting_Properties.xml
Modified:
labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/ArjunaCore_Administration_Guide.xml
Log:
First pass combining Admin & Installation guides
Added: labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Additional_JAR_Requirements.xml
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Additional_JAR_Requirements.xml (rev 0)
+++ labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Additional_JAR_Requirements.xml 2010-10-18 00:27:25 UTC (rev 35547)
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "ArjunaCore_Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter>
+ <title>Additional JAR Requirements</title>
+ <para>
+ To use all of the facilities available within ArjunaCore, you need to add all of the JAR files contained in the <filename>lib/</filename> directory of the distribution to the <varname>CLASSPATH</varname>.
+ </para>
+</chapter>
+
Modified: labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/ArjunaCore_Administration_Guide.xml
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/ArjunaCore_Administration_Guide.xml 2010-10-16 22:19:02 UTC (rev 35546)
+++ labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/ArjunaCore_Administration_Guide.xml 2010-10-18 00:27:25 UTC (rev 35547)
@@ -6,14 +6,25 @@
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-<!-- <xi:include href="Chapter.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
- <xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Starting_And_Stopping_Transaction_Manager.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="ObjectStore_Management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="ArjunaCore_Runtime_Information.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Failure_Recovery_Administration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Errors_And_Exceptions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <part>
+ <title>Installation</title>
+ <xi:include href="Preparing_Your_System.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Operating_System_Services.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Logging.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="ObjectStore_Management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Additional_JAR_Requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Setting_Properties.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </part>
+ <part>
+ <title>Administration</title>
+ <!-- <xi:include href="Chapter.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
+ <xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Starting_And_Stopping_Transaction_Manager.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="ObjectStore_Management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="ArjunaCore_Runtime_Information.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Failure_Recovery_Administration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Errors_And_Exceptions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </part>
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<index />
</book>
-
Added: labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Logging.xml
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Logging.xml (rev 0)
+++ labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Logging.xml 2010-10-18 00:27:25 UTC (rev 35547)
@@ -0,0 +1,33 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "ArjunaCore_Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter>
+ <title>Logging</title>
+ <para>
+ The recovery manager and the transaction server services produce log files which are located in the <filename>services/logs/</filename> directory. Two log files are created per service.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><filename><replaceable>service-name</replaceable>-service.log</filename></term>
+ <listitem>
+ <para>
+ Contains information regarding whether the service is stopped, started, restarted, or in another state.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><filename><replaceable>service-name</replaceable>.log</filename></term>
+ <listitem>
+ <para>
+ Contains information logged from the actual service.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ To configure what information is logged in these files, edit the appropriate LOG4J configuration files located in <filename>services/config/</filename>.
+ </para>
+</chapter>
+
Added: labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Operating_System_Services.xml
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Operating_System_Services.xml (rev 0)
+++ labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Operating_System_Services.xml 2010-10-18 00:27:25 UTC (rev 35547)
@@ -0,0 +1,161 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "ArjunaCore_Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter>
+ <title>Operating System Services</title>
+
+ <section>
+ <title>Microsoft Windows Server</title>
+ <para>
+ Four scripts, located in the <filename>Services\bin\windows</filename> folder, install and uninstall the recovery manager and transaction server services.
+ </para>
+ <variablelist>
+ <title>Installation Scripts for Microsoft Windows</title>
+ <varlistentry>
+ <term>Recovery Manager Service</term>
+ <listitem><para><filename>InstallRecoveryManagerService-NT.bat</filename></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Transaction Server</term>
+ <listitem><para><filename>InstallTransactionServiceService-NT.bat</filename></para></listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <title>Uninstallation Scripts for Microsoft Windows</title>
+ <varlistentry>
+ <term>Recovery Manager Service</term>
+ <listitem><para><filename>UninstallRecoveryManagerService-NT.bat</filename></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Transaction Server</term>
+ <listitem><para><filename>UninstallTransactionServerService-NT.bat</filename></para></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>
+ Each of the scripts requires administrative privileges.
+ </para>
+ </note>
+ <para>
+ After running any of the scripts, a status message indicates success or failure.
+ </para>
+
+ </section>
+
+ <section>
+ <title>Linux / UNIX</title>
+
+ <procedure>
+ <title>Installing Services in Linux / UNIX</title>
+ <step>
+ <title>Log into the system with <systemitem>root</systemitem> privileges.</title>
+ <para>
+ The installer needs these privileges to create files in <filename>/etc</filename>.
+ </para>
+ </step>
+ <step>
+ <title>Change to <filename><replaceable>JBOSS_HOME</replaceable>/services/installer</filename> directory.</title>
+ <para>
+ <filename><replaceable>JBOSS_HOME</replaceable></filename> refers to the directory where you extracted ArjunaCore.
+ </para>
+ </step>
+ <step>
+ <title>Set the <varname>JAVA_HOME</varname> variable, if necessary.</title>
+ <para>
+ Set the <varname>JAVA_HOME</varname> variable to the <firstterm>base directory</firstterm> of the JVM the service will use. The base directory is the directory above <filename>bin/java</filename>.
+ </para>
+ <substeps>
+ <step>
+ <para>Bash: <command>export JAVA_HOME="/opt/java"</command></para>
+ </step>
+ <step>
+ <para>CSH: <command>setenv JAVA_HOME="/opt/java"</command></para>
+ </step>
+ </substeps>
+ </step>
+ <step>
+ <title>Run the installer script.</title>
+ <para>
+ <command>./install_service.sh</command>
+ </para>
+ </step>
+ <step>
+ <title>The start-up and shut-down scripts are installed.</title>
+ <para>Information similar to the output below is displayed.</para>
+ <screen>
+ Adding $JAVA_HOME (/opt/java) to $PATH in
+ /opt/arjuna/ats-3.2/services/bin/solaris/recoverymanagerservice.sh
+ Adding $JAVA_HOME (/opt/java) to $PATH in
+ /opt/arjuna/ats-3.2/services/bin/solaris/transactionserverservice.sh
+ Installing shutdown scripts into /etc/rcS.d:
+ K01recoverymanagerservice
+ K00transactionserverservice
+ Installing shutdown scripts into /etc/rc0.d:
+ K01recoverymanagerservice
+ K00transactionserverservice
+ Installing shutdown scripts into /etc/rc1.d:
+ K01recoverymanagerservice
+ K00transactionserverservice
+ Installing shutdown scripts into /etc/rc2.d:
+ K01recoverymanagerservice
+ K00transactionserverservice
+ Installing startup scripts into /etc/rc3.d:
+ S98recoverymanagerservice
+ S99transactionserverservice
+ </screen>
+ <para>
+ The start-up and shut-down scripts are installed for each run-level. Depending on your specific operating system, you may need to explicitly enable the services for automatic start-up.
+ </para>
+ </step>
+ </procedure>
+
+ <procedure>
+ <title>Uninstalling Services in Linux / UNIX</title>
+ <step>
+ <title>Log into the system with <systemitem>root</systemitem> privileges.</title>
+ <para>
+ The installer needs these privileges to delete files in <filename>/etc</filename>.
+ </para>
+ </step>
+ <step>
+ <title>Change to <filename><replaceable>JBOSS_HOME</replaceable>/services/installer</filename> directory.</title>
+ <para>
+ <filename><replaceable>JBOSS_HOME</replaceable></filename> refers to the directory where you extracted ArjunaCore.
+ </para>
+ </step>
+
+ <step>
+ <title>Run the installation script with the <option>-u</option> option.</title>
+ <para>
+ <command>./install_services.sh -u</command>
+ </para>
+ </step>
+ <step>
+ <title>The start-up and shut-down scripts are removed.</title>
+ <para>
+ Messages like the ones below indicate that the start-up and shut-down scripts have been removed successfully.
+ </para>
+ <screen>
+ Removing startup scripts from /etc/rc3.d:
+ S98recoverymanagerservice
+ S99transactionserverservice
+ Removing shutdown scripts from /etc/rcS.d:
+ K01recoverymanagerservice
+ K00transactionserverservice
+ Removing shutdown scripts from /etc/rc0.d:
+ K01recoverymanagerservice
+ K00transactionserverservice
+ Removing shutdown scripts from /etc/rc1.d:
+ K01recoverymanagerservice
+ K00transactionserverservice
+ Removing shutdown scripts from /etc/rc2.d:
+ K01recoverymanagerservice
+ K00transactionserverservice
+ </screen>
+ </step>
+ </procedure>
+ </section>
+</chapter>
+
Added: labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Preparing_Your_System.xml
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Preparing_Your_System.xml (rev 0)
+++ labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Preparing_Your_System.xml 2010-10-18 00:27:25 UTC (rev 35547)
@@ -0,0 +1,37 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "ArjunaCore_Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter>
+ <title>Preparing Your System</title>
+ <procedure>
+ <title>Pre-Installation Steps</title>
+ <para>
+ Before installing the ArjunaCore software, we recommend the following administrative steps be taken, assuming a default configuration for ArjunaCore.
+ </para>
+ <step>
+ <title>Install the distribution into the required location.</title>
+ <para>
+ Typically, the distribution is extracted from a <filename>.ZIP</filename> file.
+ </para>
+ </step>
+ <step>
+ <title>Specify the Location for the Object Store</title>
+ <para>
+ ArjunaCore requires a minimum object store for storing the outcome of transactions in the event of system crashes. The location of this should be specified in the properties file using the <property>ObjectStoreEnvironmentBean.objectStoreDir</property> key or by using environment
+ variable:
+ </para>
+ <screen><command>java –DObjectStoreEnvironmentBean.objectStoreDir =C:\temp foo.</command></screen>
+ </step>
+ <step>
+ <title>Optional: Specify the sub-directory within the Object Store root.</title>
+ <para>
+ By default, all object states will be stored within the <filename>defaultStore/</filename> sub-directory of the object store root. For instance, if the object store root is <filename>/usr/local/Arjuna/TransactionService/ObjectStore</filename>, the subdirectory <filename>/usr/local/Arjuna/TransactionService/ObjectStore/defaultStore/</filename> is used.
+ </para>
+ <para>
+ To change this subdirectory, set the <property>ObjectStoreEnvironmentBean.localOSRoot</property> or <property>com.arjuna.ats.arjuna.objectstore.localOSRoot</property> property variable accordingly.
+ </para>
+ </step>
+ </procedure>
+</chapter>
Added: labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Setting_Properties.xml
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Setting_Properties.xml (rev 0)
+++ labs/jbosstm/trunk/ArjunaCore/docs/ArjunaCore_Administration_Guide/en-US/Setting_Properties.xml 2010-10-18 00:27:25 UTC (rev 35547)
@@ -0,0 +1,46 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "ArjunaCore_Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-ArjunaCore_Installation_Guide-Test_Chapter">
+ <title>Setting Properties</title>
+ <para>
+ ArjunaCore has been designed to be highly configurable at runtime through
+ the use of various property attributes. <!--, which will be described in
+ subsequent sections.-->Although these attributes can be provided at runtime
+ on the command line, it may be more convenient to specify them through a
+ single properties file or via <methodname>setter</methodname> methods on the
+ beans. At runtime, ArjunaCore looks for the file
+ <filename>jbossts-properties.xml</filename>, in a specific search order.
+ </para>
+ <orderedlist>
+ <listitem><para>A location specified by a system property<!--Which one? -->, allowing the normal search path to be overridden.</para></listitem>
+ <listitem><para>The directory from which the application was executed.</para></listitem>
+ <listitem><para>The home directory of the user that launched ArjunaCore.</para></listitem>
+ <listitem><para><varname>java.home</varname></para></listitem><!-- Is that like $JAVA_HOME? -->
+ <listitem><para>The <varname>CLASSPATH</varname>, which normally includes the installation's <filename>etc/</filename> directory.</para></listitem>
+ <listitem><para>A default set of properties embedded in the <filename>JAR</filename> file.</para></listitem>
+ </orderedlist>
+ <para>
+ Where properties are defined in both the system properties by using the <parameter>-D</parameter> switch, and in the properties file, the value from the system property takes precedence. This facilitates overriding individual properties easily on the command line.
+ </para>
+ <para>
+ The properties file uses <filename>java.uil.Properties</filename> XML format, for example:
+ </para>
+ <programlisting>
+ <![CDATA[
+<entry key="CoordinatorEnvironmentBean.asyncCommit">NO</entry>
+<entyr key="ObjectStoreEnvironmentBean.objectStoreDir">/var/ObjectStore</entry>
+ ]]>
+ </programlisting>
+ <para>
+ You can override the name of the properties file at runtime by specifying a new file using the <varname>com.arjuna.ats.arjuna.common.propertiesFile</varname> attribute variable.
+ </para>
+ <note>
+ <para>
+ Unlike earlier releases, there is no longer one properties file name per module. This properties file name key is now global for all JBoss Transaction Service components in the JVM.
+ </para>
+ </note>
+</chapter>
+
More information about the jboss-svn-commits
mailing list