Author: smumford Date: 2012-10-02 00:30:07 -0400 (Tue, 02 Oct 2012) New Revision: 8857 Modified: epp/docs/branches/5.2/Installation_Guide/en-US/ClusteringConfiguration.xml epp/docs/branches/6.0/Installation_Guide/en-US/ClusteringConfiguration.xml Log: BZ#840647 - Added cluster-specific run commands to 5.2 and 6.0 Installation Guides Modified: epp/docs/branches/5.2/Installation_Guide/en-US/ClusteringConfiguration.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/ClusteringConfiguration.xml 2012-10-02 03:52:14 UTC (rev 8856) +++ epp/docs/branches/5.2/Installation_Guide/en-US/ClusteringConfiguration.xml 2012-10-02 04:30:07 UTC (rev 8857) @@ -3,99 +3,151 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent"> %BOOK_ENTITIES; ]> -<section id="Clustering_Configuration"> - <title>Clustering Configuration</title> - <para>JBoss Enterprise Portal Platform supports high availability and high horizontal and vertical scalability. - The setup instructions have been kept to a minimum, however, a good understanding of clustering services in - JBoss Enterprise Application Platform and JBoss Cache are required in order to configure the optimal settings. - </para> - <para>The clustering services are available only in the <literal>all</literal> - and <literal>production</literal> server configurations. Additionally the following prerequisites - should be met: + <section id="Clustering_Configuration"> + <title>Clustering Configuration</title> + + <para> + JBoss Enterprise Portal Platform supports high availability and high horizontal and vertical scalability. The setup instructions have been kept to a minimum, however, a good understanding of clustering services in JBoss Enterprise Application Platform and JBoss Cache are required in order to configure the optimal settings. </para> - <itemizedlist> - <listitem> - <para>A rapid shared file system is required such as a Storage Area Network (SAN). - </para> - </listitem> - <listitem> - <para>All cluster nodes must be configured to point to the IDM and JCR shared databases. Refer to <xref linkend="sect-Reference_Guide-Database_Configuration"/> for detailed database set up procedures.</para> - </listitem> - <listitem> - <para>Each cluster node must have its own local swap directory configured.<remark>BZ#804839 - 20120320 - specified this to ensure customers are aware of specific requirement.</remark></para> - </listitem> - </itemizedlist> - <section id="Clustering_Configure"> - <title>Configure</title> - <task> - <title>Task: Configure Clustering Properties</title> - <tasksummary> - <para>Complete this task to configure clustering properties required for </para> - </tasksummary> - <taskprerequisites> - <title>Prerequisites</title> - <itemizedlist> - <listitem> - <para>You understand clustering fundamentals as described in the JBoss Enterprise Application Platform core documentation.</para> - </listitem> - </itemizedlist> - <itemizedlist> - <listitem> - <para>You have read, and understand the information about <citetitle>The Java Content Repository</citetitle> (JCR) in the JBoss Enterprise Portal Platform <citetitle>Reference Guide</citetitle>.</para> - </listitem> - </itemizedlist> - </taskprerequisites> - <procedure> - <step> - <para>Open the <filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/configuration.properties</filename> file in a text editor:</para> - </step> - <step> - <para>Add the following properties to the file. An explanation is provided to assist you.</para> - <variablelist> - <varlistentry> - <term>gatein.jcr.storage.data.dir;</term> - <listitem> - <para>Specifies the location of the Java Content Repository (JCR) value storage. The location you specify contains critical data required to run the portal, and must not be deleted. Refer to the </para> - </listitem> - </varlistentry> - <varlistentry> - <term>gatein.jcr.index.data.dir;</term> - <listitem> - <para>Specifies the location on a shared file system to store the JCR index. </para> - <para>If the directory is deleted, the JCR will recreate the indexes on next start of the server. This operation may take a very long time, depending on the size of the data stored in the JCR.</para> - </listitem> - </varlistentry> - <varlistentry> - <term>gatein.jcr.index.changefilterclass;</term> - <listitem> - <para>Specifies the filter class that should be used instead of the default filter class.</para> - <para> - This must be changed to <literal>org.exoplatform.services.jcr.impl.core.query.jbosscache.JBossCacheIndexChangesFilter</literal>. + + <para> + The clustering services are available only in the <literal>all</literal> and <literal>production</literal> server configurations. Additionally the following prerequisites should be met: + </para> + + <itemizedlist> + <listitem> + <para> + A rapid shared file system is required such as a Storage Area Network (SAN). + </para> + </listitem> + + <listitem> + <para> + All cluster nodes must be configured to point to the IDM and JCR shared databases. Refer to <xref linkend="sect-Reference_Guide-Database_Configuration"/> for detailed database set up procedures. + </para> + </listitem> + + <listitem> + <para> + Each cluster node must have its own local swap directory configured.<remark>BZ#804839 - 20120320 - specified this to ensure customers are aware of specific requirement.</remark> + </para> + </listitem> + </itemizedlist> + + <section id="Clustering_Configure"> + <title>Configure</title> + + <task> + <title>Task: Configure Clustering Properties</title> + + <tasksummary> + <para> + Complete this task to configure clustering properties required for </para> - </listitem> - </varlistentry> - <varlistentry> - <term>gatein.jcr.config.type;</term> - <listitem> - <para>Specifies the type of configuration the server should use across all nodes. </para> - <para> - This must be changed to <literal>cluster</literal>. - </para> - </listitem> - </varlistentry> - </variablelist> - </step> - <step> - <para>You have provided the mandatory clustering configuration as it relates to the portal in the <filename>configuration.properties</filename> file. This completes the procedure.</para> - </step> - </procedure> - </task> - <example> - <title>Default configuration.properties clustering directives</title> - <para> - The code sample depicts a <filename>configuration.properties</filename> directive file with the required clustering configuration set. -<remark>BZ#804839 - 20120320 - updated code block with specific information and replaceable formatting to ensure customers specify the correct data. </remark> </para> - <programlisting># + </tasksummary> + + <taskprerequisites> + <title>Prerequisites</title> + + <itemizedlist> + <listitem> + <para> + You understand clustering fundamentals as described in the JBoss Enterprise Application Platform core documentation. + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + You have read, and understand the information about <citetitle>The Java Content Repository</citetitle> (JCR) in the JBoss Enterprise Portal Platform <citetitle>Reference Guide</citetitle>. + </para> + </listitem> + </itemizedlist> + </taskprerequisites> + + <procedure> + <step> + <para> + Open the <filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/configuration.properties</filename> file in a text editor: + </para> + </step> + + <step> + <para> + Add the following properties to the file. An explanation is provided to assist you. + </para> + + <variablelist> + <varlistentry> + <term>gatein.jcr.storage.data.dir;</term> + + <listitem> + <para> + Specifies the location of the Java Content Repository (JCR) value storage. The location you specify contains critical data required to run the portal, and must not be deleted. Refer to the + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>gatein.jcr.index.data.dir;</term> + + <listitem> + <para> + Specifies the location on a shared file system to store the JCR index. + </para> + + <para> + If the directory is deleted, the JCR will recreate the indexes on next start of the server. This operation may take a very long time, depending on the size of the data stored in the JCR. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>gatein.jcr.index.changefilterclass;</term> + + <listitem> + <para> + Specifies the filter class that should be used instead of the default filter class. + </para> + + <para> + This must be changed to <literal>org.exoplatform.services.jcr.impl.core.query.jbosscache.JBossCacheIndexChangesFilter</literal>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>gatein.jcr.config.type;</term> + + <listitem> + <para> + Specifies the type of configuration the server should use across all nodes. + </para> + + <para> + This must be changed to <literal>cluster</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </step> + + <step> + <para> + You have provided the mandatory clustering configuration as it relates to the portal in the <filename>configuration.properties</filename> file. This completes the procedure. + </para> + </step> + </procedure> + </task> + + <example> + <title>Default configuration.properties clustering directives</title> + + <para> + The code sample depicts a <filename>configuration.properties</filename> directive file with the required clustering configuration set. <remark>BZ#804839 - 20120320 - updated code block with specific information and replaceable formatting to ensure customers specify the correct data. </remark> + </para> +<programlisting># gatein.conf.dir=${jboss.server.home.dir}/conf/gatein gatein.data.dir=${jboss.server.data.dir}/gatein @@ -119,6 +171,28 @@ gatein.jcr.workspace.default=collaboration gatein.jcr.workspace.system=system [...]</programlisting> - </example> - </section> -</section> + </example> + </section> + + <section id="sect-Reference_Guide-Clustering_Running"> + <title>Running with the cluster profile</title> + + <para> + To run the portal in high-availability mode, you would need to start all nodes with an extra profile configuration as follows: + </para> + + <formalpara> + <title>In Linux</title> <para> +<programlisting><command>run.sh -c all -Dexo.profiles=cluster</command> +</programlisting> + </para> + </formalpara> + + <formalpara> + <title>In Windows</title> <para> +<programlisting><command>run.bat -c all -Dexo.profiles=cluster</command> +</programlisting> + </para> + </formalpara> + </section> + </section> Modified: epp/docs/branches/6.0/Installation_Guide/en-US/ClusteringConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Installation_Guide/en-US/ClusteringConfiguration.xml 2012-10-02 03:52:14 UTC (rev 8856) +++ epp/docs/branches/6.0/Installation_Guide/en-US/ClusteringConfiguration.xml 2012-10-02 04:30:07 UTC (rev 8857) @@ -3,99 +3,151 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent"> %BOOK_ENTITIES; ]> -<section id="Clustering_Configuration"> - <title>Clustering Configuration</title> - <para>JBoss Enterprise Portal Platform supports high availability and high horizontal and vertical scalability. - The setup instructions have been kept to a minimum, however, a good understanding of clustering services in - JBoss Enterprise Application Platform and JBoss Cache are required in order to configure the optimal settings. - </para> - <para>The clustering services are available only in the <literal>all</literal> - and <literal>production</literal> server configurations. Additionally the following prerequisites - should be met: + <section id="Clustering_Configuration"> + <title>Clustering Configuration</title> + + <para> + JBoss Enterprise Portal Platform supports high availability and high horizontal and vertical scalability. The setup instructions have been kept to a minimum, however, a good understanding of clustering services in JBoss Enterprise Application Platform and JBoss Cache are required in order to configure the optimal settings. </para> - <itemizedlist> - <listitem> - <para>A rapid shared file system is required such as a Storage Area Network (SAN). - </para> - </listitem> - <listitem> - <para>All cluster nodes must be configured to point to the IDM and JCR shared databases. Refer to <xref linkend="sect-Reference_Guide-Database_Configuration"/> for detailed database set up procedures.</para> - </listitem> - <listitem> - <para>Each cluster node must have its own local swap directory configured.<remark>BZ#804839 - 20120320 - specified this to ensure customers are aware of specific requirement.</remark></para> - </listitem> - </itemizedlist> - <section id="Clustering_Configure"> - <title>Configure</title> - <task> - <title>Task: Configure Clustering Properties</title> - <tasksummary> - <para>Complete this task to configure clustering properties required for </para> - </tasksummary> - <taskprerequisites> - <title>Prerequisites</title> - <itemizedlist> - <listitem> - <para>You understand clustering fundamentals as described in the JBoss Enterprise Application Platform core documentation.</para> - </listitem> - </itemizedlist> - <itemizedlist> - <listitem> - <para>You have read, and understand the information about <citetitle>The Java Content Repository</citetitle> (JCR) in the JBoss Enterprise Portal Platform <citetitle>Reference Guide</citetitle>.</para> - </listitem> - </itemizedlist> - </taskprerequisites> - <procedure> - <step> - <para>Open the <filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/configuration.properties</filename> file in a text editor:</para> - </step> - <step> - <para>Add the following properties to the file. An explanation is provided to assist you.</para> - <variablelist> - <varlistentry> - <term>gatein.jcr.storage.data.dir;</term> - <listitem> - <para>Specifies the location of the Java Content Repository (JCR) value storage. The location you specify contains critical data required to run the portal, and must not be deleted. Refer to the </para> - </listitem> - </varlistentry> - <varlistentry> - <term>gatein.jcr.index.data.dir;</term> - <listitem> - <para>Specifies the location on a shared file system to store the JCR index. </para> - <para>If the directory is deleted, the JCR will recreate the indexes on next start of the server. This operation may take a very long time, depending on the size of the data stored in the JCR.</para> - </listitem> - </varlistentry> - <varlistentry> - <term>gatein.jcr.index.changefilterclass;</term> - <listitem> - <para>Specifies the filter class that should be used instead of the default filter class.</para> - <para> - This must be changed to <literal>org.exoplatform.services.jcr.impl.core.query.jbosscache.JBossCacheIndexChangesFilter</literal>. + + <para> + The clustering services are available only in the <literal>all</literal> and <literal>production</literal> server configurations. Additionally the following prerequisites should be met: + </para> + + <itemizedlist> + <listitem> + <para> + A rapid shared file system is required such as a Storage Area Network (SAN). + </para> + </listitem> + + <listitem> + <para> + All cluster nodes must be configured to point to the IDM and JCR shared databases. Refer to <xref linkend="sect-Reference_Guide-Database_Configuration"/> for detailed database set up procedures. + </para> + </listitem> + + <listitem> + <para> + Each cluster node must have its own local swap directory configured.<remark>BZ#804839 - 20120320 - specified this to ensure customers are aware of specific requirement.</remark> + </para> + </listitem> + </itemizedlist> + + <section id="Clustering_Configure"> + <title>Configure</title> + + <task> + <title>Task: Configure Clustering Properties</title> + + <tasksummary> + <para> + Complete this task to configure clustering properties required for </para> - </listitem> - </varlistentry> - <varlistentry> - <term>gatein.jcr.config.type;</term> - <listitem> - <para>Specifies the type of configuration the server should use across all nodes. </para> - <para> - This must be changed to <literal>cluster</literal>. - </para> - </listitem> - </varlistentry> - </variablelist> - </step> - <step> - <para>You have provided the mandatory clustering configuration as it relates to the portal in the <filename>configuration.properties</filename> file. This completes the procedure.</para> - </step> - </procedure> - </task> - <example> - <title>Default configuration.properties clustering directives</title> - <para> - The code sample depicts a <filename>configuration.properties</filename> directive file with the required clustering configuration set. -<remark>BZ#804839 - 20120320 - updated code block with specific information and replaceable formatting to ensure customers specify the correct data. </remark> </para> - <programlisting># + </tasksummary> + + <taskprerequisites> + <title>Prerequisites</title> + + <itemizedlist> + <listitem> + <para> + You understand clustering fundamentals as described in the JBoss Enterprise Application Platform core documentation. + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + You have read, and understand the information about <citetitle>The Java Content Repository</citetitle> (JCR) in the JBoss Enterprise Portal Platform <citetitle>Reference Guide</citetitle>. + </para> + </listitem> + </itemizedlist> + </taskprerequisites> + + <procedure> + <step> + <para> + Open the <filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/configuration.properties</filename> file in a text editor: + </para> + </step> + + <step> + <para> + Add the following properties to the file. An explanation is provided to assist you. + </para> + + <variablelist> + <varlistentry> + <term>gatein.jcr.storage.data.dir;</term> + + <listitem> + <para> + Specifies the location of the Java Content Repository (JCR) value storage. The location you specify contains critical data required to run the portal, and must not be deleted. Refer to the + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>gatein.jcr.index.data.dir;</term> + + <listitem> + <para> + Specifies the location on a shared file system to store the JCR index. + </para> + + <para> + If the directory is deleted, the JCR will recreate the indexes on next start of the server. This operation may take a very long time, depending on the size of the data stored in the JCR. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>gatein.jcr.index.changefilterclass;</term> + + <listitem> + <para> + Specifies the filter class that should be used instead of the default filter class. + </para> + + <para> + This must be changed to <literal>org.exoplatform.services.jcr.impl.core.query.jbosscache.JBossCacheIndexChangesFilter</literal>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>gatein.jcr.config.type;</term> + + <listitem> + <para> + Specifies the type of configuration the server should use across all nodes. + </para> + + <para> + This must be changed to <literal>cluster</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </step> + + <step> + <para> + You have provided the mandatory clustering configuration as it relates to the portal in the <filename>configuration.properties</filename> file. This completes the procedure. + </para> + </step> + </procedure> + </task> + + <example> + <title>Default configuration.properties clustering directives</title> + + <para> + The code sample depicts a <filename>configuration.properties</filename> directive file with the required clustering configuration set. <remark>BZ#804839 - 20120320 - updated code block with specific information and replaceable formatting to ensure customers specify the correct data. </remark> + </para> +<programlisting># gatein.conf.dir=${jboss.server.home.dir}/conf/gatein gatein.data.dir=${jboss.server.data.dir}/gatein @@ -119,6 +171,28 @@ gatein.jcr.workspace.default=collaboration gatein.jcr.workspace.system=system [...]</programlisting> - </example> - </section> -</section> + </example> + </section> + + <section id="sect-Reference_Guide-Clustering_Running"> + <title>Running with the cluster profile</title> + + <para> + To run the portal in high-availability mode, you would need to start all nodes with an extra profile configuration as follows: + </para> + + <formalpara> + <title>In Linux</title> <para> +<programlisting><command>run.sh -c all -Dexo.profiles=cluster</command> +</programlisting> + </para> + </formalpara> + + <formalpara> + <title>In Windows</title> <para> +<programlisting><command>run.bat -c all -Dexo.profiles=cluster</command> +</programlisting> + </para> + </formalpara> + </section> + </section>