7:10 p.m.
Author: jaredmorgs
Date: 2012-11-14 20:10:18 -0500 (Wed, 14 Nov 2012)
New Revision: 8962
Modified:
epp/docs/branches/6.0/Admin_Guide/en-US/Administration_Guide.xml
epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml
Log:
BZ#856436 - Added in changes to Admin Guide for Admin and Monitoring section
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/Administration_Guide.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/Administration_Guide.xml 2012-11-13 04:12:15
UTC (rev 8961)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/Administration_Guide.xml 2012-11-15 01:10:18
UTC (rev 8962)
@@ -3,7 +3,7 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent">
%BOOK_ENTITIES;
]>
-<book>
+<book status="draft">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="Book_Info.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="Preface.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="chapter-1-Introduction.xml"/>
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml 2012-11-13 04:12:15 UTC
(rev 8961)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml 2012-11-15 01:10:18 UTC
(rev 8962)
@@ -8,6 +8,21 @@
<simpara>
<revhistory>
<revision>
+ <revnumber>6.0.0-3</revnumber>
+ <date>Wed Nov 14 2012</date>
+ <author>
+ <firstname>Jared</firstname>
+ <surname>Morgan</surname>
+ <email/>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>BZ#856436 - Updated Administration and Monitoring section to
reflect the minor changes Nick Scavelli made in
https://docs.jboss.org/author/display/GTNPORTAL35/Administration+and+Moni.... With the
exception of the Installing RHQ, because that is community-specific. See the Installation
Guide for changes to installing JON Plugin info.</member>
+ <member>BZ#794408 - Petr Penicka updated the Import and Export
procedures, in both the 5.2 and 6.0 docs.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>6.0.0-2</revnumber>
<date>Tue Oct 30 2012</date>
<author>
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml 2012-11-13 04:12:15
UTC (rev 8961)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml 2012-11-15 01:10:18
UTC (rev 8962)
@@ -118,7 +118,7 @@
</section>
<section id="sid-8094332_GateInManagement-Goals">
<title>Goals</title>
- <para>The management component provides a foundation for managing portal side
components. By doing so it allows management extensions to register resources and
operations over a set of API's, which in turn allows us to expose these over
common interfaces like REST and CLI. In other words, management extensions don't
have to worry about the interfaces in which they will be managed over. This allows us to
add additional interfaces without needing to change anything. Also by providing a set of
API's to obtain managed resources, interfaces are built in a consistent manner.
So managing the same component in one interface should be very similar if you were to
manage it in another.</para>
+ <para>The management component provides a foundation for managing portal side
components. By doing so it allows management extensions to register resources and
operations over a set of API's, which in turn allows us to expose these over
common interfaces like REST and CLI. In other words, management extensions do not have to
worry about the interfaces in which they will be managed over. This allows us to add
additional interfaces without needing to change anything. Also by providing a set of
API's to obtain managed resources, interfaces are built in a consistent manner.
So managing the same component in one interface should be very similar if you were to
manage it in another.</para>
</section>
<section id="sid-8094332_GateInManagement-Operations">
<title>Operations</title>
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2012-11-13
04:12:15 UTC (rev 8961)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2012-11-15
01:10:18 UTC (rev 8962)
@@ -42,7 +42,7 @@
<code>import-resource</code>
operation can only be executed at the mop component (root managed resource of
the mop extension). This is because the exported zip file contains the path information
(like site type and site name). So executing an
<code>import-resource</code>
- operation on a group site, when the zip contains data from a portal site,
doesn't make sense.
+ operation on a group site, when the zip contains data from a portal site,
does not make sense.
</para>
<para>This operation is accessed through the portal using the
<application>Import/Export Site</application> tool. For more information about
this tool, refer to the <citetitle>Import and Export</citetitle> section in
the <citetitle>User Guide</citetitle>.</para>
<para>
@@ -489,7 +489,7 @@
</example>
<important>
<title>Important</title>
- <para>All three artifacts (site layout, navigation, and pages) are
included in export by default. In other words if you don't specify their path
template in the filter, the data will be included.</para>
+ <para>All three artifacts (site layout, navigation, and pages) are
included in export by default. In other words if you do not specify their path template
in the filter, the data will be included.</para>
</important>
</section>
</section>
Modified:
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml
===================================================================
---
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml 2012-11-13
04:12:15 UTC (rev 8961)
+++
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml 2012-11-15
01:10:18 UTC (rev 8962)
@@ -4,9 +4,10 @@
%BOOK_ENTITIES;
]>
<chapter id="Administration_and_Monitoring">
- <title>Administration and Monitoring</title>
+ <title><remark>BZ#856436</remark> Administration and
Monitoring</title>
<para>JBoss Portal Platform provides a JBoss Operations Network plug-in
(<firstterm>GateIn JON Plug-in</firstterm>) to assist with monitoring the
platform.</para>
- <para>The plug-in captures portlet and site statistics. A different set of
statistics are collected depending on the context of each portlet. <xref
linkend="fig-GateIn_JON_Plug-in_Interface"/> shows the basic JON
interface.</para>
+ <para>The plug-in captures application/portlet and site statistics. A different
set of statistics are collected depending on the context of each portlet. <xref
linkend="fig-GateIn_JON_Plug-in_Interface"/> shows the basic JON
interface.</para>
+ <para>Follow the download and installation instructions in the
<citetitle>Installation Guide</citetitle> to activate Administration and
Monitoring.</para>
<figure id="fig-GateIn_JON_Plug-in_Interface">
<title>GateIn JON Plug-in Interface</title>
<mediaobject>
@@ -20,7 +21,9 @@
</figure>
<section id="AdministrationandMonitoring-Metrics">
<title>Metrics</title>
- <para>The metrics collected by the GateIn JON Plug-in include Site and Portlet
statistics. Each portlet contains statistics relevant to the individual portlet, and one
additional Throughput statistic for site portlets. Refer to <xref
linkend="table-Site_and_Portlet_Statistics"/> for a description of the
available metrics.</para>
+ <para>The metrics collected by the GateIn JON Plug-in include Site and
Application/Portlet statistics. Each portlet contains statistics relevant to the
individual portlet, and one additional Throughput statistic for site portlets. Refer to
<xref linkend="table-Site_and_Portlet_Statistics"/> for a description of
the available metrics.</para>
+ <remark>BZ#856436 Added this next paragraph as part of the changes in
https://docs.jboss.org/author/display/GTNPORTAL35/Administration+and+Moni.... Also
added applications/portlets to the table to match the scope in the confluence
source.</remark>
+ <para>The metrics and statistics are runtime only values, and are not persisted
anywhere on the server. When the server is restarted, the runtime values are reset. JBoss
Operations Network keeps a history of these statistics and metrics to give an accurate
view of the data over time.</para>
<table id="table-Site_and_Portlet_Statistics">
<title>Site and Portlet Statistics</title>
<tgroup cols="2">
@@ -42,7 +45,7 @@
<para>Average Execution Time</para>
</entry>
<entry>
- <para>The average execution time in seconds for a page or portlet to
render within a site.</para>
+ <para>The average execution time in seconds for a page or
application/portlet to render within a site.</para>
</entry>
</row>
<row>
@@ -50,7 +53,7 @@
<para>Execution Count</para>
</entry>
<entry>
- <para>The amount of times the portlet or site has been
accessed.</para>
+ <para>The amount of times the application/portlet or site has been
accessed.</para>
</entry>
</row>
<row>
@@ -58,7 +61,7 @@
<para>Maximum Execution Time</para>
</entry>
<entry>
- <para>The maximum execution time in seconds for a page or portlet to
render within a site.</para>
+ <para>The maximum execution time in seconds for a page or
application/portlet to render within a site.</para>
</entry>
</row>
<row>
@@ -66,7 +69,7 @@
<para>Minimum Execution Time</para>
</entry>
<entry>
- <para>The minimum execution time in seconds for a page or portlet to
render within a site.</para>
+ <para>The minimum execution time in seconds for a page or
application/portlet to render within a site.</para>
</entry>
</row>
<row>
@@ -83,7 +86,7 @@
</section>
<section id="Administration_and_Monitoring-Operations">
<title>Operations</title>
- <para>The GateIn JON Plug-in itself does not provide any operations;
it's sole purpose is reporting and statistics relating to portlets and sites. The
JBoss Operations Network AS plug-in does support many management operations, and is
included in JBoss Portal Platform binaries. With the AS plug-in, the following
non-exhaustive list of actions are possible:</para>
+ <para>The GateIn JON Plug-in itself does not provide any operations;
it's sole purpose is reporting and statistics relating to applications/portlets
and sites. The JBoss Operations Network AS plug-in does support many management
operations, and is included in JBoss Portal Platform binaries. With the AS plug-in, the
following non-exhaustive list of actions are possible:</para>
<itemizedlist>
<listitem>
<para>Server control: start, stop, restart.</para>
@@ -92,9 +95,9 @@
<para>Application control: deploy, and remove EAR and WAR
applications.</para>
</listitem>
<listitem>
- <para>Resource control: manage other components of the platform, such as
datasources.</para>
+ <para>Resource control: manage other components of the platform, such as
data sources.</para>
</listitem>
</itemizedlist>
- <para>For detailed information about JBoss Operations Network, and how it can
be used to manage platforms, refer to the JBoss Operations Network <citetitle>How to
Manage JBoss Servers</citetitle> guide available from <ulink
url="http://docs.redhat.com/docs/en-US/JBoss_Operations_Network/inde...
+ <para>For detailed information about JBoss Operations Network, and how it can
be used to manage platforms, refer to the JBoss Operations Network <citetitle>How to
Manage JBoss Servers</citetitle> guide available from <ulink
url="http://access.redhat.com/knowledge/docs/JBoss_Operations_Networ...
</section>
</chapter>