[jopr-commits] JOPR SVN: r1186 - docs/enterprise/JON/2.3/Installation_Guide/en-US.

jopr-commits at lists.jboss.org jopr-commits at lists.jboss.org
Fri Sep 11 02:02:30 EDT 2009


Author: smeehan
Date: 2009-09-11 02:02:30 -0400 (Fri, 11 Sep 2009)
New Revision: 1186

Modified:
   docs/enterprise/JON/2.3/Installation_Guide/en-US/Book_Info.xml
   docs/enterprise/JON/2.3/Installation_Guide/en-US/JON_Best_Practices.xml
   docs/enterprise/JON/2.3/Installation_Guide/en-US/JON_Server_Installation.xml
   docs/enterprise/JON/2.3/Installation_Guide/en-US/Prerequisites.xml
Log:
Changes to Install Guide

Modified: docs/enterprise/JON/2.3/Installation_Guide/en-US/Book_Info.xml
===================================================================
--- docs/enterprise/JON/2.3/Installation_Guide/en-US/Book_Info.xml	2009-09-11 05:25:49 UTC (rev 1185)
+++ docs/enterprise/JON/2.3/Installation_Guide/en-US/Book_Info.xml	2009-09-11 06:02:30 UTC (rev 1186)
@@ -8,7 +8,7 @@
 	<productname>JBoss Operations Network</productname>
 	<productnumber>2.3</productnumber>
 	<edition>1</edition>
-	<pubsnumber>13</pubsnumber>
+	<pubsnumber>15</pubsnumber>
 	<abstract>
 		<para>A guide to the download, installation and initial setup of the JBoss Operations Network 2.x product and management agent.</para>
 	</abstract>

Modified: docs/enterprise/JON/2.3/Installation_Guide/en-US/JON_Best_Practices.xml
===================================================================
--- docs/enterprise/JON/2.3/Installation_Guide/en-US/JON_Best_Practices.xml	2009-09-11 05:25:49 UTC (rev 1185)
+++ docs/enterprise/JON/2.3/Installation_Guide/en-US/JON_Best_Practices.xml	2009-09-11 06:02:30 UTC (rev 1186)
@@ -7,19 +7,19 @@
 	
 	
 	<para>
-		The following sections will provide you with some best practices you can use when setting up and running your JBoss ON environment.
+		The following sections provide some best practices when setting up and running your JBoss ON environment.
 	</para>
 
 	
 	<section id="Installation_Guide-JON_Best_Practices-JBoss_App_Servers">
-		<title>Best Practices for Managing JBoss App Servers</title>
+		<title>Best Practices for Managing JBoss Application Servers</title>
 		
 		<section id="Installation_Guide-JBoss_App_Servers-DynaGroups">
 			<title>DynaGroups</title>
 		
 		
 			<para>
-				Utilize the DynaGroups feature by setting up GroupDefinitions that can automatically group resources with certain attributes. Set an update period to have the groups automatically recalculate themselves.
+				You can use the DynaGroups feature by setting up <application>GroupDefinitions</application>. This means that resources with certain attributes will be automatically grouped. It will also set an update period to automatically recalculate the groups.
 			</para>
 		
 			<formalpara>
@@ -29,7 +29,7 @@
 			</title>
 				
 				<para>
-					Use the template definition for "JBoss AS Clusters in the system" to automatically create a separate group for each set of jboss nodes in a cluster.
+					You can use the template definition for <application>JBoss AS Clusters in the system</application> to automatically create a separate group for each set of JBoss nodes in a cluster.
 				</para>
 			</formalpara>
 				
@@ -40,7 +40,7 @@
 			</title>
 				
 				<para>
-					Create a handy group of down resources with the "All Down Resources" template.
+					This creates a group of down resources using the <application>All Down Resources</application> template.
 				</para>
 			</formalpara>
 				
@@ -49,17 +49,15 @@
 		
 		<section id="Installation_Guide-JBoss_App_Servers-Useful_Alerts">
 			<title>Useful Alerts</title>
-		
-		
 			
 			<formalpara>
 				
 				<title>
-					JBossAS Server : JVM Free Memory
+					JBossAS Server: JVM Free Memory
 				</title>
 				
 				<para>
-					Alert on this getting &lt; 10MB to indicate the app server may be about to go out of memory.
+					Alert on this getting &lt; 10MB to indicate the application server may be about to run out of memory.
 				</para>
 			</formalpara>
 			
@@ -70,7 +68,7 @@
 				</title>
 				
 				<para>
-					Alert on this getting too low, to know when your app is about to run out of free database connections
+					Alert on this getting too low, to know when your applicaton is about to run out of free database connections
 				</para>
 			</formalpara>
 				
@@ -84,7 +82,7 @@
 				</title>
 				
 				<para>
-					Alert on this being > 0 to find out when your web apps are responding with errors to requests. See also 'Web Application (WAR) : Errors while processing' for information on individual web apps.
+					Alert on this being > 0 to find out when your web applications are responding with errors to requests. See also 'Web Application (WAR): Errors while processing' for information on individual web applications.
 				</para>
 			</formalpara>
 			
@@ -95,7 +93,7 @@
 				</title>
 				
 				<para>
-					Alert on this going above say 15sec, to indicate your web apps are running slow. See also 'Web Application (WAR) : Max. Servlet Resp. Time' for information on individual web apps.
+					Alert on this going above 15 seconds, to indicate your web applications are running slow. See also 'Web Application (WAR): Max. Servlet Resp. Time' for information on individual web applications.
 				</para>
 			</formalpara>
 				
@@ -109,7 +107,7 @@
 				</title>
 				
 				<para>
-					Monitor this to see how load on your app changes during the day/week. See also 'Web Application (WAR) : Requests served per Minute' for information on individual web apps.
+					Monitor this to see how load on your application changes during the day/week. See also 'Web Application (WAR) : Requests served per Minute' for information on individual web apps.
 				</para>
 			</formalpara>
 			
@@ -151,61 +149,68 @@
 </section>
 	
 		<section id="Installation_Guide-JBoss_App_Servers-JBoss_App_Server_Setup">
-			<title>JBoss App Server Setup</title>
+			<title>JBoss Application Server Setup</title>
 			
 			<formalpara>
-				
-				<title>
-					Management invoker security
-					
-					
-				</title>
-				
+				<title>Management invoker security</title>
 				<para>
-					always secure invoker endpoints
+					<itemizedlist>
+						<listitem>
+							<para>
+								Always secure invoker endpoints.
+							</para>
+						</listitem>					
+					</itemizedlist>
 				</para>
-			</formalpara>
+			</formalpara>	
+
 			
+			
 			<formalpara>
-				
-				<title>
-					configuration
-				</title>
-				
+				<title>Configuration</title>
 				<para>
-					Symlinking is common for externalizing configs (mostly xml), makes upgrading easier
+					<itemizedlist>
+						<listitem>
+							<para>
+								Symlinking is common for externalizing configs (mostly xml). It makes upgrading easier.
+							</para>
+						</listitem>	
+						<listitem>
+							<para>
+								Parametrized configurations by further externalizing environment variables how to leverage check config against init files.
+							</para>
+						</listitem>	
+						
+						
+					</itemizedlist>
 				</para>
-			</formalpara>
-				
-				<para>
-					Parametrized configurations by further externalizing environment variables how to leverage check config against init files
-				</para>
-				
+			</formalpara>	
 			
-			
 			<formalpara>
-				
-				<title>
-					application management
-					
-					
-				</title>
-				
+				<title>Application management</title>
 				<para>
-					Use deploy dir or farm, sometimes symlinks to common deploy dir company wide
+					<itemizedlist>
+						<listitem>
+							<para>
+								Use deploy dir or farm, sometimes symlinks to common deploy dir company wide.
+							</para>
+						</listitem>	
+						<listitem>
+							<para>
+								Turn autodeploy off so that accidental touches to files do not cause redeploys.
+							</para>
+						</listitem>	
+						<listitem>
+							<para>
+								Application upgrade - side-by-side or rolling restart, scripted solution and coordinate with load balancer.
+							</para>
+						</listitem>	
+						
+					</itemizedlist>
 				</para>
-				
-			</formalpara>
-				
-				<para>
-					Turn autodeploy off so that accidental touches to files do not cause redeploys
-				</para>
-				<para>
-					Application upgrade - side-by-side or rolling restart, scripted solution and coordinate with load balancer
-				</para>
-				
+			</formalpara>	
+		
 			
-			
 </section>
 		<section id="Installation_Guide-JBoss_App_Servers-Common_Issues">
 			<title>Common issues</title>	

Modified: docs/enterprise/JON/2.3/Installation_Guide/en-US/JON_Server_Installation.xml
===================================================================
--- docs/enterprise/JON/2.3/Installation_Guide/en-US/JON_Server_Installation.xml	2009-09-11 05:25:49 UTC (rev 1185)
+++ docs/enterprise/JON/2.3/Installation_Guide/en-US/JON_Server_Installation.xml	2009-09-11 06:02:30 UTC (rev 1186)
@@ -8,6 +8,44 @@
 		This chapter describes the JBoss Operations Network 2.3 Server installation process. We recommended that you also read the <citetitle>JON Server Guide</citetitle> for more information about the JON Server.
 	</para>
 	
+	
+	
+	<section id="Installation_Guide-JON_Server_Installation_Guide-Overview">
+		<title>Overview</title>
+		
+		<para>
+			The JBoss ON Server can run on either a Windows or UNIX platform. The installation steps you need to perform are as follows:
+		</para>
+		
+	<orderedlist>
+		<listitem>
+			<para>
+				If you already have a JBoss ON Server installed and you need to upgrade it, go to Upgrading the Server.
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+				It is recommended you read through the High Availability documentation. This will help you decide if you need high availability features and if so, how many Servers you should install and how you should configure them.
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+				Before you install your Server, read Server Installation Preparation to prepare your environment.
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+				After you are familiar with the high availability features and you've prepared your environment for the Jopr Server, go through the Running The Installer documentation to get your Server installed.
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+				After the server has been installed and configured, you can run it as a Windows service, from a console, or run it as a daemon or init.d script in a UNIX environment. Go to Running the JBoss ON Server for more information.
+			</para>
+		</listitem>
+	</orderedlist>
+</section>
+	
 	<section id="Installation_Guide-JON_Server_Installation_Guide-JON_High_Availability">
 		<title>JON High Availability</title>
 		<para>
@@ -61,7 +99,7 @@
 			<title>Synchronized machine clocks</title>
 			
 			<para>
-				All JBoss ON Servers and Agents must have synchronized clocks. Clock variations will cause issues in resource synchronization and availabilities, metric measurements, graphing, and importing resources into inventory. Refer to <ulink url="http://www.ntp.org/">http://www.ntp.org/</ulink> for information on installing and configuring NTP to ensure your clocks are synchronized.
+				All JBoss ON Servers and Agents must have synchronized clocks. Clock variations will cause issues in resource synchronization and availabilities, metric measurements, graphing, and importing resources into inventory. Refer to <ulink url="http://www.ntp.org/">Network Time Protocol (NTP)</ulink> for information on installing and configuring NTP to ensure your clocks are synchronized.
 			</para>
 		</formalpara>
 	

Modified: docs/enterprise/JON/2.3/Installation_Guide/en-US/Prerequisites.xml
===================================================================
--- docs/enterprise/JON/2.3/Installation_Guide/en-US/Prerequisites.xml	2009-09-11 05:25:49 UTC (rev 1185)
+++ docs/enterprise/JON/2.3/Installation_Guide/en-US/Prerequisites.xml	2009-09-11 06:02:30 UTC (rev 1186)
@@ -36,7 +36,7 @@
 		
 	
 		<para>
-			After downloading and installing the latest JRE or JDK you will need to configuring your system. This consists of two tasks:
+			After downloading and installing the latest JRE or JDK you will need to configure your system. This consists of two tasks:
 		</para>
 			
 		<orderedlist>
@@ -220,12 +220,12 @@
 ## not necessary  if the database is started with the -i flag
 listen_addresses = &apos;*&apos; 
 
-## performance changes  for JBoss ON
+## performance changes for JBoss ON
 shared_buffers = 80MB 		#  default is 32MB 
 work_mem = 2048 		#  default is 1MB 
 statement_timeout = 30s 	#  default is 0s
 checkpoint_segments = 10	#  default is 3
-max_fsm_pages = 100000          #  default is 204800 
+max_fsm_pages = 100000        #  default is 204800 
 </screen>
 
 			<para>
@@ -244,7 +244,7 @@
 		<parameter>max_prepared_transactions</parameter>
 	</title>
 	<para>
-		Note that <parameter>max_prepared_transactions</parameter> is set to the same value as <parameter>max_connections</parameter> as explained in the  <ulink url="http://www.postgresql.org/docs/8.2/interactive/runtime-config-resource.html">PostgreSQl documentation</ulink>.
+		Note that <parameter>max_prepared_transactions</parameter> is set to the same value as <parameter>max_connections</parameter> as explained in the  <ulink url="http://www.postgresql.org/docs/8.2/interactive/runtime-config-resource.html">PostgreSQL documentation</ulink>.
 		See specifically the <emphasis role="bold">max_prepared_transactions (integer)</emphasis> section.
 	</para>
 </note>
@@ -255,12 +255,12 @@
 			<bridgehead>Kernel parameters</bridgehead>
 			
 			<para>
-				Depending on the operating system you are using, you may need to adjust some kernel parameters. Refer to <ulink url="http://www.postgresql.org/docs/8.2/interactive/kernel-resources.html">http://www.postgresql.org/docs/8.2/interactive/kernel-resources.html</ulink> for more information.
+				Depending on the operating system you are using, you may need to adjust some kernel parameters. Refer to the <ulink url="http://www.postgresql.org/docs/8.2/interactive/kernel-resources.html">Managing Kernel Resources</ulink> documentation for more information.
 			</para>
 			
 			<bridgehead>pg_hba.conf</bridgehead>
 			<para>
-				Update the <emphasis role="bold">pg_hba.conf</emphasis> file to allow the newly created role to connect from the machine the JBoss ON Server is installed on, (for example <emphasis>localhost</emphasis>). For details on how to do this refer to <ulink url="http://www.postgresql.org/docs/8.2/interactive/client-authentication.html">http://www.postgresql.org/docs/8.2/interactive/client-authentication.html</ulink>.
+				Update the <emphasis role="bold">pg_hba.conf</emphasis> file to allow the newly created role to connect from the machine the JBoss ON Server is installed on, (for example <emphasis>localhost</emphasis>). For details on how to do this please see <ulink url="http://www.postgresql.org/docs/8.2/interactive/client-authentication.html">Client Authentication</ulink>.
 			</para>
 			
 			<para>
@@ -268,7 +268,7 @@
 			</para>
 			
 			<para>
-				For more information on tuning Postgres, see <ulink url="http://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server">http://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server</ulink>.
+				For more information on tuning Postgres, see <ulink url="http://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server">Tuning your PostgreSQL Server</ulink>.
 			</para>
 			
 			<formalpara id="Installation_Guide-Postgres_Preparation-Fixes">
@@ -284,7 +284,7 @@
 				<orderedlist>
 					<listitem>
 						<para>
-							Using a database explorer, create an empty table called <parameter>RHQ_Principal</parameter> in the database used for JBoss ON.
+							Using a database explorer, create an empty table called <parameter>RHQ_PRINCIPAL</parameter> in the database used for JBoss ON.
 						</para>
 					</listitem>
 					<listitem>
@@ -321,10 +321,10 @@
 				</step>
 				<step>
 					<para> Install postgres. </para>
-					<para><emphasis role="bold">For UNIX:</emphasis> Build and install it as described here: <ulink url="http://www.postgresql.org/docs/8.3/static/install-short.html">http://www.postgresql.org/docs/8.3/static/install-short.html</ulink>		
+					<para><emphasis role="bold">For UNIX:</emphasis> To build and install PostgreSQL please refer to the <ulink url="http://www.postgresql.org/docs/8.3/static/install-short.html">Installation Instructions</ulink>
 					</para>
 					<para>
-						<emphasis role="bold">For Windows:</emphasis>  Follow the installations instructions described at: <ulink url="http://pginstaller.projects.postgresql.org/">http://pginstaller.projects.postgresql.org/</ulink>
+						<emphasis role="bold">For Windows:</emphasis>  Follow the installations instructions described at: <ulink url="http://pginstaller.projects.postgresql.org/">PostgreSQL Installer</ulink>
 					</para>
 					<para>
 						Postgres can also be installed via a package installer such as <command>yum</command> on Fedora.
@@ -377,7 +377,7 @@
 </programlisting>
 			</step>
 			<step>
-				<para> If you are using this PostgreSQL installation for more than just demonstration or testing purposes, refer to <xref linkend="Installation_Guide-Database-Postgres_Preparation"/> to configure your machine for production use with JON.
+				<para> If you are using this PostgreSQL installation for more than just demonstration or testing purposes, refer to <xref linkend="Installation_Guide-Database-Postgres_Preparation"/> to configure your machine for production use with JBoss ON.
 				</para>
 			</step>
              		</procedure>
@@ -510,7 +510,7 @@
 						
 				
 					<para>
-						Currently the recommended algorithm for determining the maximum number of Oracle processes (as kept in v$resource_limit) which JON 2.1 should use is the following:
+						Currently the recommended algorithm for determining the maximum number of Oracle processes (as kept in <envar>v$resource_limit</envar>) which JBoss ON should use is the following:
 					</para>
 				
 		
@@ -522,12 +522,12 @@
 				<orderedlist>
 					<listitem>
 						<para>
-							1.5 * total number of JON Agents in the environment, and;
+							1.5 * total number of JBoss ON Agents in the environment, and;
 						</para>	
 					</listitem>
 					<listitem>
 						<para>
-							60 * total number of JON Servers in the environment
+							60 * total number of JBoss ON Servers in the environment
 						</para>
 					</listitem>
 				</orderedlist>
@@ -538,7 +538,7 @@
 				</para>
 					
 				<para>
-					For example if you had 100 JON Agents and 2 JON Servers, and you were using Oracle EM, you would have:
+					For example if you had 100 JBoss ON Agents and 2 JBoss ON Servers, and you were using Oracle EM, you would have:
 				
 				</para>
 				
@@ -557,9 +557,22 @@
 				</orderedlist>
 					
 				<para>
-					So the max is 150, add 40 to give 190 processes. The number of sessions (as kept in v$resource_limit) should be 1.1 * number of processes, so in this example a maximum of 209 sessions should be sufficient. These settings should prevent you from seeing errors such as <literal>ORA-00018: maximum number of sessions exceeded</literal>.
-					
+					So the maximum of the two is 150. Then add 40 to support Oracle EM and that gives 190 processes.</para>
+				
+				<para>
+					The number of sessions (as kept in <envar>v$resource_limit</envar>) should be:
 				</para>
+			<itemizedlist>
+				<listitem>
+					<para>
+						1.1 * number of processes
+					</para>
+				</listitem>
+			</itemizedlist>
+				
+				<para>	
+					In this example a maximum of 209 sessions should be sufficient. These settings should prevent you from seeing errors such as <literal>ORA-00018: maximum number of sessions exceeded</literal>.
+				</para>
 					
 			</section>
 			
@@ -569,13 +582,13 @@
 			<title>SGA and PGA Sizes</title>
 	
 			<para>
-				Your Oracle settings for SGA and PGA sizes are very important in the performance of JBoss ON. If they are too small, your database will perform very slow, affecting JBoss ON in a very negative way. Talk to your DBA for proper sizing of your Oracle's SGA and PGA requirements. The settings you need to make sure you tune are <parameter>sga_target</parameter> and <parameter>pga_aggregate_target</parameter>.
+				Oracle settings for SGA and PGA sizes are very important in the performance of JBoss ON. If they are too small, your database will perform very slow, affecting JBoss ON in a very negative way. Talk to your DBA for proper sizing of your Oracle's SGA and PGA requirements. The settings you need to tune are <parameter>sga_target</parameter> and <parameter>pga_aggregate_target</parameter>.
 			</para>
 					
 </section>
 
 <section id="Installation_Guide-Oracle-Tuning_Open_Cursors">
-			<title>Tuning_Open_Cursors</title>
+			<title>Tuning Open Cursors</title>
 
 <para>
 	If the following sql:
@@ -607,7 +620,7 @@
 	<title>Advanced Oracle configuration</title>
 	
 	<para>
-		There are optional configurations that can help Oracle perform effectively with large JBoss ON environments. This configuration is not necessary for small to medium environments. An example of an environment where this type of configuration would help performance is an environment with hundreds of JON Agents.
+		There are optional configurations that can help Oracle perform effectively with large JBoss ON environments. This configuration is not necessary for small to medium environments. An example of an environment where this type of configuration would help performance is an environment with hundreds of JBoss ON Agents.
 	</para>
 	
 	<procedure>
@@ -636,15 +649,17 @@
 			<para>
 				Create the JBoss ON user.
 			</para>
-			<programlisting>
-				CREATE USER jon IDENTIFIED BY jon;
-			</programlisting>						
+<programlisting>
+CREATE USER jon IDENTIFIED BY jon;
+</programlisting>						
 		</step>
 		<step>
-			<para>Grant permissions to the new user.</para>
-			<programlisting>
-				GRANT CONNECT, RESOURCE TO jon; 
-			</programlisting>
+			<para>
+				Grant permissions to the new user.
+			</para>
+<programlisting>
+GRANT CONNECT, RESOURCE TO jon; 
+</programlisting>
 		</step>
 		
 		



More information about the jopr-commits mailing list