[jopr-commits] JOPR SVN: r1188 - in docs/enterprise/JON/2.3/Installation_Guide/en-US: images and 1 other directory.
jopr-commits at lists.jboss.org
jopr-commits at lists.jboss.org
Sun Sep 13 22:14:52 EDT 2009
Author: smeehan
Date: 2009-09-13 22:14:52 -0400 (Sun, 13 Sep 2009)
New Revision: 1188
Added:
docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-linux-inventory.jpg
docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-linux-tree.jpg
docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-vm-services.jpg
docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-win-inventory.jpg
docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-win-tree.jpg
docs/enterprise/JON/2.3/Installation_Guide/en-US/images/update_plugins.jpg
Modified:
docs/enterprise/JON/2.3/Installation_Guide/en-US/Book_Info.xml
docs/enterprise/JON/2.3/Installation_Guide/en-US/JON_Agent_Installation.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/Running_the_JON_Agent.xml
Log:
New images for installation 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-14 02:10:47 UTC (rev 1187)
+++ docs/enterprise/JON/2.3/Installation_Guide/en-US/Book_Info.xml 2009-09-14 02:14:52 UTC (rev 1188)
@@ -8,7 +8,7 @@
<productname>JBoss Operations Network</productname>
<productnumber>2.3</productnumber>
<edition>1</edition>
- <pubsnumber>15</pubsnumber>
+ <pubsnumber>16</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_Agent_Installation.xml
===================================================================
--- docs/enterprise/JON/2.3/Installation_Guide/en-US/JON_Agent_Installation.xml 2009-09-14 02:10:47 UTC (rev 1187)
+++ docs/enterprise/JON/2.3/Installation_Guide/en-US/JON_Agent_Installation.xml 2009-09-14 02:14:52 UTC (rev 1188)
@@ -262,7 +262,7 @@
<orderedlist>
<listitem>
<para>
- Assuming the agent is imported in inventory, you can reconfigure the agent using Jopr itself. Go to the agent's "Configuration tab" in the UI and you can change the agent's configuration there.
+ Assuming the agent is imported in inventory, you can reconfigure the agent using JBoss ON itself. Go to the agent's <application>Configuration tab</application> in the UI and you can change the agent's configuration there.
</para>
</listitem>
@@ -281,11 +281,11 @@
<formalpara>
- <title>Configuring the Jopr Agent Runtime Environment</title>
+ <title>Configuring the JBoss ON Agents Runtime Environment</title>
<para>
- The agent has an environment script that is read when the agent is started up. This file is called <filename>rhq-agent-env.bat</filename> on Windows and <filename>rhq-agent-env.sh</filename> on UNIX. Edit this file to change the environment of the agent. The comments in that file document the different settings. Some of the settings are also explained in the Running the Jopr Agent pages.
+ The agent has an environment script that is read when the agent is started up. This file is called <filename>rhq-agent-env.bat</filename> on Windows and <filename>rhq-agent-env.sh</filename> on UNIX. Edit this file to change the environment of the agent. The comments in that file document the different settings. Some of the settings are also explained in the Running the JBoss ON Agent pages.
</para>
</formalpara>
@@ -495,7 +495,7 @@
You must also ensure that the agent has been fully configured prior to running it the very first time. This means you must either start the agent in a console to answer the setup questions or you must fully configure the agent's configuration file so it can start up without needing additional input from an administrator (i.e. so it does not have to ask the initial setup questions). Once fully configured, you can start the agent as a background daemon thereafter.
</para>
<para>
- You can fully configure the agent by changing the support scripts/configuration files directly. But if you have the agent imported into inventory, you can optionally use the GUI to configure the agent (in effect, we are using Jopr to manage Jopr).
+ You can fully configure the agent by changing the support scripts/configuration files directly. But if you have the agent imported into inventory, you can optionally use the GUI to configure the agent (in effect, we are using JBoss ON to manage JBoss ON).
</para>
</section>
@@ -595,24 +595,24 @@
Agent Auto-Updating
</title>
<para>
- Since Jopr 2.2, agents have the ability to auto-update themselves. So, under most conditions, it isn't necessary to manually upgrade agents. However, if the auto-update fails for some reason or you disabled agent auto-update and you want to manually upgrade yourself, you need to follow the steps below.
+ Since JBoss ON 2.2, agents have the ability to auto-update themselves. So, under most conditions, it isn't necessary to manually upgrade agents. However, if the auto-update fails for some reason or you disabled agent auto-update and you want to manually upgrade yourself, you need to follow the steps below.
</para>
</important>
<para>
- If you need to manually upgrade a JBoss ON Agent (i.e. you do not want or cannot utilize the agent auto-ugprade capabilities), then follow these steps below. You will need to follow these steps if you are upgrading the Jopr Agent to version 2.2.
+ If you need to manually upgrade a JBoss ON Agent (i.e. you do not want or cannot utilize the agent auto-ugprade capabilities), then follow these steps below. You will need to follow these steps if you are upgrading the JBoss ON Agent to version 2.2.
</para>
-
+ <note>
<para>
- Note that all agents must be upgraded at the same time, having agents of different versions in your Jopr environment is not supported.
+ All agents must be upgraded at the same time, having agents of different versions in your JBoss ON environment is not supported.
</para>
+ </note>
-
<orderedlist>
<listitem>
<para>
- Shutdown your Jopr Agent.
+ Shutdown your JBoss ON Agent.
</para>
</listitem>
<listitem>
@@ -633,13 +633,13 @@
<listitem>
<para>
- Restart your upgraded Jopr Servers if they are not yet started.
+ Restart your upgraded JBoss ON Servers if they are not yet started.
</para>
</listitem>
<listitem>
<para>
- If the current Jopr Agent that is to be upgraded is at version 2.2 or newer:
+ If the current JBoss ON Agent that is to be upgraded is at version 2.2 or newer:
</para>
<itemizedlist>
<listitem>
@@ -654,14 +654,14 @@
</listitem>
<listitem>
<para>
- Extract the new Jopr Agent from the agent update binary by running the following command:
+ Extract the new JBoss ON Agent from the agent update binary by running the following command:
</para>
<screen>
java -jar <agent-update-binary.jar> --upgrade
</screen>
<para>
- This will tell the agent update binary to extract the Jopr Agent distribution and update your currently existing agent that is found in "rhq-agent" subdirectory. At this point, you will have a fully upgraded Jopr Agent located in the original "rhq-agent" directory. The old agent has been backed up to the "rhq-agent-old" directory. If the upgrade encounters errors, you'll find log files that contain log messages that can help to diagnose the problem.
+ This will tell the agent update binary to extract the JBoss ON Agent distribution and update your currently existing agent that is found in "rhq-agent" subdirectory. At this point, you will have a fully upgraded JBoss ON Agent located in the original "rhq-agent" directory. The old agent has been backed up to the "rhq-agent-old" directory. If the upgrade encounters errors, you'll find log files that contain log messages that can help to diagnose the problem.
</para>
</listitem>
@@ -671,13 +671,13 @@
<listitem>
<para>
- If the current Jopr Agent that is to be upgraded is older than version 2.2:
+ If the current JBoss ON Agent that is to be upgraded is older than version 2.2:
</para>
<itemizedlist>
<listitem>
<para>
- Follow the instructions to install a Jopr Agent here: Jopr Agent Installation
+ Follow the instructions to install a JBoss ON Agent here: JBoss ON Agent Installation
</para>
</listitem>
@@ -697,12 +697,12 @@
<listitem>
<para>
- (optional) If you need to reconfigure the Jopr Agent before you restart it, read the documentation at Jopr Agent Installation that talks about configuring and reconfiguring the agent. Typically, you won't have to reconfigure the agent - the agent will pick up its previous configuration and update it as necessary.
+ (optional) If you need to reconfigure the JBoss ON Agent before you restart it, read the documentation at JBoss ON Agent Installation that talks about configuring and reconfiguring the agent. Typically, you won't have to reconfigure the agent - the agent will pick up its previous configuration and update it as necessary.
</para>
</listitem>
<listitem>
<para>
- Finally, start the Jopr Agent.
+ Finally, start the JBoss ON Agent.
</para>
</listitem>
</orderedlist>
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-14 02:10:47 UTC (rev 1187)
+++ docs/enterprise/JON/2.3/Installation_Guide/en-US/JON_Best_Practices.xml 2009-09-14 02:14:52 UTC (rev 1188)
@@ -177,7 +177,7 @@
</listitem>
<listitem>
<para>
- Parametrized configurations by further externalizing environment variables how to leverage check config against init files.
+ Parameterized configurations by further externalizing environment variables how to leverage check config against init files.
</para>
</listitem>
@@ -335,7 +335,7 @@
<section id="Installation_Guide-JBoss_Tomcat_Servers-Monitoring_Tomcat_Server">
- <title>Enabling Jopr monitoring of your Tomcat Server</title>
+ <title>Enabling JBoss ON monitoring of your Tomcat Server</title>
<important>
@@ -392,7 +392,7 @@
<title>Enabling Response Time metrics for your Tomcat Server</title>
<para>
- Before enabling Response Time metric collection in your Tomcat Server Monitoring Schedules you need to add a servlet filter to your application's web.xml and add the filter jar, provided by Jopr.
+ Before enabling Response Time metric collection in your Tomcat Server Monitoring Schedules you need to add a servlet filter to your application's web.xml and add the filter jar, provided by JBoss ON.
</para>
<para>
@@ -600,7 +600,7 @@
<title>Deciding on a Remote Client Approach</title>
<para>
- Jopr provides several options for remote clients:
+ JBoss ON provides several options for remote clients:
</para>
<itemizedlist>
@@ -625,7 +625,7 @@
<title>Command Line Interface (CLI)</title>
<para>
- The CLI is a powerful scripting tool for interacting with the Jopr Server. It offers Rhino Javascript as the scripting environment. Rhino is a Java-backed implementation of Javascript. Communication with the Jopr Server is through JBoss Remoting.
+ The CLI is a powerful scripting tool for interacting with the JBoss ON Server. It offers Rhino Javascript as the scripting environment. Rhino is a Java-backed implementation of Javascript. Communication with the JBoss ON Server is through JBoss Remoting.
</para>
<para>
@@ -650,7 +650,7 @@
</screen>
<para>
- This is the recommended approach for a programmatic remote client, if Java is an option. Communication with the Jopr Server is through JBoss Remoting.
+ This is the recommended approach for a programmatic remote client, if Java is an option. Communication with the JBoss ON Server is through JBoss Remoting.
</para>
</section>
@@ -658,7 +658,7 @@
<title>Web Services</title>
<para>
- For programmatic remote clients written in languages other than Java the Jopr Remote API methods are available as Web Services. Or, if for some reason a Java client does not want to utilize the Client object as mentioned above, a Web Service Java client is a possibility.
+ For programmatic remote clients written in languages other than Java the JBoss ON Remote API methods are available as Web Services. Or, if for some reason a Java client does not want to utilize the Client object as mentioned above, a Web Service Java client is a possibility.
</para>
</section>
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-14 02:10:47 UTC (rev 1187)
+++ docs/enterprise/JON/2.3/Installation_Guide/en-US/JON_Server_Installation.xml 2009-09-14 02:14:52 UTC (rev 1188)
@@ -35,7 +35,7 @@
</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.
+ After you are familiar with the high availability features and you've prepared your environment for the JBoss ON Server, go through the Running The Installer documentation to get your Server installed.
</para>
</listitem>
<listitem>
Modified: docs/enterprise/JON/2.3/Installation_Guide/en-US/Running_the_JON_Agent.xml
===================================================================
--- docs/enterprise/JON/2.3/Installation_Guide/en-US/Running_the_JON_Agent.xml 2009-09-14 02:10:47 UTC (rev 1187)
+++ docs/enterprise/JON/2.3/Installation_Guide/en-US/Running_the_JON_Agent.xml 2009-09-14 02:14:52 UTC (rev 1188)
@@ -661,7 +661,7 @@
</para>
<para>
- Because the agent can monitor its internal metrics, it allows you to track its behavior and ensure that it is operating properly. Like any other resource managed by Jopr, you can define alerts on this metric data which can be triggered when an agent starts behaving in an abnormal way. In addition, you can control the lifecycle of the agent by restarting it or shutting it down.
+ Because the agent can monitor its internal metrics, it allows you to track its behavior and ensure that it is operating properly. Like any other resource managed by JBoss ON, you can define alerts on this metric data which can be triggered when an agent starts behaving in an abnormal way. In addition, you can control the lifecycle of the agent by restarting it or shutting it down.
</para>
<important>
@@ -680,7 +680,26 @@
<para>
Here's the typical resource hierarchy for the agent running on Linux and Windows:
</para>
-
+
+
+
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/agent-linux-tree.jpg" format="JPEG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/agent-win-tree.jpg" format="JPEG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+
+
</section>
<section id="Installation_Guide-Using_the_Agent_Plugin-Top_level_resource">
@@ -721,6 +740,16 @@
The Agent JVM <emphasis role="bold">service</emphasis> is actually considered a child <emphasis role="bold">server</emphasis> that provides additional child services that give you more fine grained monitoring and management of the VM that is running the agent and all its plugins, which includes the classloader, threading and memory management subsystems, among others.
</para>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/agent-vm-services.jpg" format="JPEG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+
+
+
</section>
<section id="Installation_Guide-Plugin-Common_Services-Agent_Environment_Setup_Script">
@@ -797,6 +826,9 @@
You can do this by going to the Operations tab of the agent server's child service that corresponds to the agent launcher. On Windows, this is the Agent Java Service Wrapper Launcher service; on UNIX, this is the Agent Launcher Script service. Both of those resources provide an operation called "Restart" that shuts down the agent process and restarts it. This will effectively kill the original agent VM process and then ask the operating system to restart another one.
</para>
+
+
+
<note>
<para>
To configure the agent VM's settings, you can edit the configuration found in the <application>Configuration</application> tab of the "Environment Setup Script" child service.
Added: docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-linux-inventory.jpg
===================================================================
(Binary files differ)
Property changes on: docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-linux-inventory.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-linux-tree.jpg
===================================================================
(Binary files differ)
Property changes on: docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-linux-tree.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-vm-services.jpg
===================================================================
(Binary files differ)
Property changes on: docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-vm-services.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-win-inventory.jpg
===================================================================
(Binary files differ)
Property changes on: docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-win-inventory.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-win-tree.jpg
===================================================================
(Binary files differ)
Property changes on: docs/enterprise/JON/2.3/Installation_Guide/en-US/images/agent-win-tree.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/enterprise/JON/2.3/Installation_Guide/en-US/images/update_plugins.jpg
===================================================================
(Binary files differ)
Property changes on: docs/enterprise/JON/2.3/Installation_Guide/en-US/images/update_plugins.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
More information about the jopr-commits
mailing list