Author: jaredmorgs Date: 2012-03-06 23:47:08 -0500 (Tue, 06 Mar 2012) New Revision: 8544 Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Book_Info.xml epp/docs/branches/5.2/Installation_Guide/en-US/Getting_Started.xml epp/docs/branches/5.2/Installation_Guide/en-US/Installation_Guide.xml epp/docs/branches/5.2/Installation_Guide/en-US/Installation_With_ZIP_Download.xml epp/docs/branches/5.2/Installation_Guide/en-US/Native_Components.xml epp/docs/branches/5.2/Installation_Guide/en-US/Revision_History.xml Log: Incorporated https://bugzilla.redhat.com/show_bug.cgi?id=798839 by adding the Native Components section from EAP docs into guide, and modifying to suit EPP. Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Book_Info.xml 2012-03-06 17:33:12 UTC (rev 8543) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Book_Info.xml 2012-03-07 04:47:08 UTC (rev 8544) @@ -9,7 +9,7 @@ <productname>JBoss Enterprise Portal Platform</productname> <productnumber>5.2</productnumber> <edition>5.2.1</edition> - <pubsnumber>7</pubsnumber> + <pubsnumber>8</pubsnumber> <abstract> <para> This book provides information about obtaining, installing and running JBoss Enterprise Portal Platform. It forms part of the complete document suite along with the <citetitle>User Guide</citetitle> and <citetitle>Reference Guide</citetitle> available at <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... type="http"/>. Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Getting_Started.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Getting_Started.xml 2012-03-06 17:33:12 UTC (rev 8543) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Getting_Started.xml 2012-03-07 04:47:08 UTC (rev 8544) @@ -10,12 +10,10 @@ <remark>BZ#741683 - Adjusted section to reflect Site Publisher section in this guide now.</remark> <para>Read the notes below to ensure you choose the correct installation/migration path for your circumstances. </para> - <para>It is possible to upgrade from JBoss Enterprise Portal Platform version 5.1.0 or 5.1.1 to JBoss Enterprise Portal Platform &VZ;. - </para> - <para>To upgrade, copy any customized configuration files and database settings from your existing JBoss Enterprise Portal Platform installation to the corresponding location of the &VZ; installation. - </para> + <para>You can upgrade from JBoss Enterprise Portal Platform version 5.1.0 or 5.1.1 to JBoss Enterprise Portal Platform &VZ;. + Copy any customized configuration files and database settings from your existing JBoss Enterprise Portal Platform installation to the corresponding location of the &VZ; installation.</para> <para> - The Site Publisher add-on (commonly referred to as Site Publisher) that is part of the &VZ; release can only be installed onto a <emphasis>clean</emphasis> installation of JBoss Enterprise Portal Platform version 5.1 or later. + The Site Publisher add-on (commonly referred to as Site Publisher) that is part of the &VZ; release can only be installed onto a <firstterm>clean</firstterm> installation of JBoss Enterprise Portal Platform version 5.1 or later. </para> <para>If you already have a clean installation of JBoss Enterprise Portal Platform, you can go directly to <xref linkend="Site_Publisher_Installation"/>.</para> </section> @@ -61,7 +59,7 @@ </para> <variablelist> <varlistentry> - <term> Disk Space: 1.5 GB</term> + <term> Disk Space: 1.0 GB</term> <listitem> <para> The default server log file storage configuration is 500MB. Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Installation_Guide.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Installation_Guide.xml 2012-03-06 17:33:12 UTC (rev 8543) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Installation_Guide.xml 2012-03-07 04:47:08 UTC (rev 8544) @@ -9,6 +9,7 @@ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Introduction.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Getting_Started.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Installation_With_ZIP_Download.xml" encoding="UTF-8"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Native_Components.xml" encoding="UTF-8"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="SP_Installation.xml" encoding="UTF-8"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Post_Installation.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Test_Your_Installation.xml"/> Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Installation_With_ZIP_Download.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Installation_With_ZIP_Download.xml 2012-03-06 17:33:12 UTC (rev 8543) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Installation_With_ZIP_Download.xml 2012-03-07 04:47:08 UTC (rev 8544) @@ -117,10 +117,11 @@ with an installation of JBoss Enterprise Portal Platform in its default configuration.</para> </formalpara> </step> -<!--<step> - <title>Optional: Install Native Components</title> - <para>Refer to <xref linkend="Install_Native_Components"/> for Native Component installation instructions.</para> -</step>--> <step> + <step> + <title>Optional: Install Native Components</title> + <para>Refer to <xref linkend="Install_Native_Components"/> for Native Component installation instructions.</para> + </step> + <step> <title>Optional: Site Publisher</title> <para>If you need to install Site Publisher, complete the tasks in to <xref linkend="Site_Publisher_Installation"/>.</para> </step> Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Native_Components.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Native_Components.xml 2012-03-06 17:33:12 UTC (rev 8543) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Native_Components.xml 2012-03-07 04:47:08 UTC (rev 8544) @@ -2,27 +2,49 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ ]> <chapter id="Install_Native_Components"> - <title>Install Native Components</title> - <formalpara> - <title>The Native Components Package</title> - <para> - The Native Components package is an optional component for the JBoss Enterprise Application Platform that incorporates - native operating system components and connectors for web servers, including OpenSSL, JBoss Native, mod_jk, - mod_cluster, NSAPI for Solaris, ISAPI for Windows, HornetQ LibAIO Native for Red Hat Enterprise Linux. - </para> - </formalpara> - <para> - Installing JBoss Native results in higher server performance, as native operating system + <title><remark>BZ#798839 </remark>Install Native Components</title> + <remark>BZ#798839 - 20120307 - Converted this chapter from the EAP Installation Guide.</remark> + <para/> + <para>The Native Components package is an optional JBoss Enterprise Application Platform package that incorporates + native operating system components and connectors for web servers including:</para> + <itemizedlist> + <listitem> + <para>OpenSSL</para> + </listitem> + <listitem> + <para>JBoss Native</para> + </listitem> + <listitem> + <para>mod_jk</para> + </listitem> + <listitem> + <para>mod_cluster</para> + </listitem> + <listitem> + <para>NSAPI for Solaris</para> + </listitem> + <listitem> + <para>ISAPI for Windows</para> + </listitem> + <listitem> + <para>HornetQ LibAIO Native for Red Hat Enterprise Linux</para> + </listitem> + </itemizedlist> + <para>Installing JBoss Native can result in higher server performance, as native operating system code becomes available for the server to optimize tasks. - </para> - <para> - For more information on configuring the web server connectors, refer to the JBoss Enterprise Application Platform + <xref linkend="exam-Native_Web_vs_Java_IO"/> describes a scenario where Native Components perform better over standard components.</para> + <remark>BZ#798839 - 20120307 - Added this example based on peformance info from Andrig Miller, as recorded in the bug.</remark> + <example id="exam-Native_Web_vs_Java_IO"> + <title>Native Web Connector vs Java I/O</title> + <para>If your implementation has many thousands of users, all with active sessions, but only 20% of all active users are making concurrent requests, the native web connector is the correct choice. </para> + <para>If your implementation has higher concurrent user demands, the Java I/O connector is a better choice. However, the Java I/O connector has a limit to the number of clients and compensates for this limitation by consuming CPU resources faster than the native web connector.</para> + </example> + <para>For more information on configuring the web server connectors, refer to the JBoss Enterprise Application Platform <citetitle>HTTP Connectors Load Balancing Guide</citetitle>.</para> <itemizedlist> <title>Native Components Manifest</title> <listitem> - <para> - JBoss Native consists of the Apache Portable Runtime (APR), OpenSSL and Tomcat Native (TC-native); + <para>JBoss Native consists of the Apache Portable Runtime (APR), OpenSSL and Tomcat Native (TC-native); </para> <itemizedlist> <listitem> @@ -61,13 +83,15 @@ </para> </listitem> <listitem> - <para> - <literal>ISAPI</literal> is a connector for the Microsoft IIS web server. + <para><literal>ISAPI</literal> is a connector for the Microsoft IIS web server. </para> </listitem> <listitem> - <para> - HornetQ LibAIO is used as a bridge between HornetQ and Linux LibAIO. It is used in HornetQ&apos;s high performance journal, when configured. + <remark>BZ#798839 - 20120307 - Added this as part of the manifest, as it wasn&apos;t declared in the EAP version (NSAPI is now covered in the HTTP Connectors Guide for EAP).</remark> + <para><literal>NSAPI</literal> is a connector for the Netscape web server.</para> + </listitem> + <listitem> + <para>HornetQ <literal>LibAIO</literal> is used as a bridge between HornetQ and Linux LibAIO. It is used in HornetQ&apos;s high performance journal, when configured. </para> </listitem> </itemizedlist> @@ -84,7 +108,7 @@ </para> <programlisting>WARN [AprLifecycleListener] The Apache Tomcat Native library which allows optimal performance in production environments was not found on the java.library.path: -/home/eapuser/jboss-eap-5.1/native/lib. +/opt/user/jboss-epp-<replaceable>VERSION</replaceable>/native/lib. </programlisting> </section> <section> @@ -100,4 +124,143 @@ during the installation. </para> </section> + <section id="Native_Components_Download"> + <title>Download</title> + <remark>BZ#798839 - 20120307 - Adapted the EAP instructions to cater for the fact no native binaries are currently included in EPP.</remark> + <para>Read this section to learn how to download the required native libraries for JBoss Enterprise Portal Platform.</para> + <task id="task-Download_Native_Files"> + <title>Task: Download Native Files</title> + <tasksummary> + <para>Complete this task to download the native binary Zip archives from the Red Hat Customer Portal.</para> + </tasksummary> + <taskprerequisites> + <title>Prerequisites</title> + <itemizedlist> + <listitem> + <para>You have a login to the Red Hat Customer Portal ( + <ulink url="http://access.redhat.com">http://access.redhat.com</ulink> + ). + </para> + </listitem> + <listitem> + <para>You have a valid JBoss Enterprise Portal Platform subscription, with entitlements to JBoss Enterprise Application Platform native binaries. </para> + </listitem> + <listitem> + <para>You have reviewed the JBoss Enterprise Portal Platform <citetitle>Release Notes</citetitle> to identify which version of JBoss Enterprise Application Platform is included in the portal version you are installing. </para> + </listitem> + </itemizedlist> + </taskprerequisites> + <procedure> + <step> + <para>Open + <ulink url="http://access.redhat.com"/> + in a web browser. + </para> + </step> + <step> + <para>Click the + <guibutton>Downloads</guibutton> + option in the menu across the top of the page. + </para> + </step> + <step> + <para>Click on + <guibutton>Download your software</guibutton> + in the list under JBoss Enterprise Middleware. + </para> + </step> + <step> + <para>If you are not already authenticated, enter your login information.</para> + <formalpara> + <title>Result:</title> + <para>You are taken to the Software Downloads page.</para> + </formalpara> + </step> + <step> + <para>Select + <literal>Application Platform</literal> + from either the drop-down box or the menu on the left. + </para> + <formalpara> + <title>Result:</title> + <para>You are presented with a list of file downloads for the latest version of JBoss Enterprise Application Platform.</para> + </formalpara> + </step> + <step> + <para>From the Version drop-down, select the version number specified in the Portal <citetitle>Release Notes</citetitle>.</para> + <formalpara> + <title>Result:</title> + <para>You are presented with a list of file downloads for the applicable version of JBoss Enterprise Application Platform, as it relates to JBoss Enterprise Portal Platform.</para> + </formalpara> + </step> + <step> + <para>Click the + <filename>JBoss EAP <replaceable>VERSION</replaceable> Native Components for <replaceable>OPERATING_SYSTEM</replaceable><replaceable> OS_ARCHITECTURE</replaceable> </filename> + download link that corresponds with your native operating system.</para> + </step> + <step> + <para>Click the <guibutton>Download</guibutton> link to start the native components download.</para> + </step> + </procedure> + </task> + </section> + <section id="Native_Components_Install"> + <title>Install</title> + <remark>BZ#798839 - 20120307 - Converted this chapter from the EAP Installation Guide to cover EPP installation of EAP native binaries.</remark> + <para>Read this section to learn how to install the native libraries for JBoss Enterprise Portal Platform.</para> + <task> + <title>Install Native Components</title> + <tasksummary> + <para>Complete this task to install the native components for JBoss Enterprise Portal Platform.</para> + </tasksummary> + <taskprerequisites> + <title>Prerequisites</title> + <itemizedlist> + <listitem> + <para>Complete <xref linkend="task-Download_Native_Files"/> + </para> + </listitem> + </itemizedlist> + </taskprerequisites> + <procedure> + <step> + <para>Open the <filename>JBoss EAP <replaceable>VERSION</replaceable> Native Components for <replaceable>OPERATING_SYSTEM</replaceable><replaceable> OS_ARCHITECTURE</replaceable></filename> Zip archive.</para> + </step> + <step> + <para>Extract the <filename>native</filename> directory from the zip archive into the + <filename> + <replaceable>JBOSS_HOME</replaceable> + </filename> directory, so the <filename>native</filename> directory is at the same directory level as + the <filename>jboss-as</filename> directory. + </para> + </step> + <step> + <formalpara> + <title>Result</title> + <para>You have installed the native components into the correct directory. </para> + </formalpara> + </step> + </procedure> + <taskrelated> + <title>Related Information</title> + <itemizedlist> + <listitem> + <para>Refer to <xref linkend="task-Install_The_Platform"/> to verify all other base installation steps are complete.</para> + </listitem> + <listitem> + <para>Refer to <xref linkend="Post_Installation_Configuration"/> to ensure you meet all post installation requirements.</para> + </listitem> + </itemizedlist> + </taskrelated> + </task> + <para>Once you have completed all post installation configuration requirements, you can verify native components are loaded during server startup by reviewing the server startup terminal information.</para> + <screen>12:12:29,826 INFO [ServerInfo] VM arguments: -Dprogram.name=run.sh -Xms1303m -Xmx1303m + -XX:MaxPermSize=256m -Dorg.jboss.resolver.warning=true -Dsun.rmi.dgc.client.gcInterval=3600000 + -Dsun.rmi.dgc.server.gcInterval=3600000 -Dsun.lang.ClassLoader.allowArraySyntax=true + -Djava.protocol.handler.pkgs=org.jboss.handlers.stub -Djava.net.preferIPv4Stack=true + -Djava.library.path=/opt/user/jboss-epp-<replaceable>VERSION</replaceable>/native/lib64 + -Djava.endorsed.dirs=/opt/user/jboss-epp-<replaceable>VERSION</replaceable>/jboss-as/lib/endorsed</screen> + <para>The option <literal>-Djava.library.path=/opt/user/jboss-epp-<replaceable>VERSION</replaceable>/native/lib64</literal> shows that the + server is detecting and loading the Native libraries.</para> + </section> </chapter> Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Revision_History.xml 2012-03-06 17:33:12 UTC (rev 8543) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Revision_History.xml 2012-03-07 04:47:08 UTC (rev 8544) @@ -9,6 +9,20 @@ <simpara> <revhistory> <revision> + <revnumber>5.2.1-8</revnumber> + <date>Wed Mar 7 2012</date> + <author> + <firstname>Jared</firstname> + <surname>Morgan</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>Incorporated https://bugzilla.redhat.com/show_bug.cgi?id=798839 by adding the Native Components section from EAP docs into guide, and modifying to suit EPP. </member> + </simplelist> + </revdescription> + </revision> + <revision> <revnumber>5.2.1-7</revnumber> <date>Wed Feb 29 2012</date> <author>