From do-not-reply at jboss.org Mon Feb 27 22:37:36 2012 Content-Type: multipart/mixed; boundary="===============5404201298011616061==" MIME-Version: 1.0 From: do-not-reply at jboss.org To: gatein-commits at lists.jboss.org Subject: [gatein-commits] gatein SVN: r8474 - epp/docs/branches/5.2/Installation_Guide/en-US. Date: Mon, 27 Feb 2012 22:37:36 -0500 Message-ID: <201202280337.q1S3bao9029193@svn01.web.mwc.hst.phx2.redhat.com> --===============5404201298011616061== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: jaredmorgs Date: 2012-02-27 22:37:35 -0500 (Mon, 27 Feb 2012) New Revision: 8474 Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Book_Info.xml epp/docs/branches/5.2/Installation_Guide/en-US/DatabaseConfiguration.xml epp/docs/branches/5.2/Installation_Guide/en-US/HTTPSConfiguration.xml epp/docs/branches/5.2/Installation_Guide/en-US/Revision_History.xml epp/docs/branches/5.2/Installation_Guide/en-US/Uninstall_JBoss.xml Log: Incorporated feedback from theute in https://bugzilla.redhat.com/show_bug.c= gi?id=3D794386. New sections added to Database Configuration, specifically = Multiple Portal JCR and IDM. Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Book_Info.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- epp/docs/branches/5.2/Installation_Guide/en-US/Book_Info.xml 2012-02-27= 11:53:06 UTC (rev 8473) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Book_Info.xml 2012-02-28= 03:37:35 UTC (rev 8474) @@ -9,7 +9,7 @@ JBoss Enterprise Portal Platform 5.2 5.2.1 - 3 + 4 This book provides information about obtaining, installing and ru= nning JBoss Enterprise Portal Platform. It forms part of the complete docum= ent suite along with the User Guide and = Reference Guide available at . Modified: epp/docs/branches/5.2/Installation_Guide/en-US/DatabaseConfigurat= ion.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- epp/docs/branches/5.2/Installation_Guide/en-US/DatabaseConfiguration.xm= l 2012-02-27 11:53:06 UTC (rev 8473) +++ epp/docs/branches/5.2/Installation_Guide/en-US/DatabaseConfiguration.xm= l 2012-02-28 03:37:35 UTC (rev 8474) @@ -19,11 +19,12 @@ Identity Management (IDM) service, which depends on JBoss Hibe= rnate. + You must create a separate database for both the JCR and IDM servi= ces, for each portal container required in your instal= lation. + The formula to apply when provisioning JCR and IDM databases is: + (1 IDM + 1 JCR Database) * (Number of Portal Containers)= + For example, if you intend running Site Publisher with JBoss Enter= prise Portal Platform, you must create two separate JCR and IDM databases = for the portal container, and ecmdemo= container. + Refer to to p= rovision the required database based on the number of portal instances. Aft= er completing this task, refer to = and for instructions relating = to configuring the JNDI names in the directive files. - Warning: Separate JCR and IDM Databases - You must create a separate database for both the JCR and IDM ser= vices. If you do not create a separate database for each service, database = table conflicts will occur and JBoss Enterprise Portal Platform will not st= art. - - Warning: Do not delete <filename><replaceable>JBOSS_HOME</repla= ceable>/server/<replaceable>PROFILE</replaceable>/data</filename> The JCR can store information both in a database and on the file = system depending on the configuration of the value storage. Refer to the JB= oss Enterprise Portal Platform Reference Guide for more information. @@ -34,11 +35,11 @@ You can change this directory location by editing the <= replaceable>JBOSS_HOME/server/PROFILE/conf/gatein/configuration.properties file, the name of the p= roperty being: gatein.jcr.storage.data.dir - In the case of HSQLDB, databases are created automatically. For p= roduction databases, you must first install the database and create a defa= ult user so the platform can create the correct database schema when it is = first started. <remark>BZ#794386</remark>Task: Provision JCR and IDM Productio= n Databases - Read and understand the guideline steps in this task to prepar= e a JCR production database for JBoss Enterprise Portal Platform. + Read and understand the guideline steps in this task to prepar= e production databases for JBoss Enterprise Portal Platform. + Prerequisites @@ -52,6 +53,9 @@ A JDBC connector, which is compatible with the selected JD= BC-compliant production database. + + Understand the database provisioning formula discussed in = . + @@ -62,10 +66,10 @@ Copy the JDBC driver file (the .jar file) to the = JBOSS_HOME/server/PROFILE/lib directory. This adds the driver to the classpath. - Create a database that the JCR service will use exclusively.= + Create a separate database for each portal container's = JCR service. - Create a second database that the IDM service will use excl= usively. + Create a separate database for each portal container'= s IDM service. Create a database user that has access to all related datab= ases, with the following minimum permissions: @@ -83,120 +87,287 @@ - Now you have installed the database and created a user, you can se= t the JCR and IDM directives in the configuration files as described in and . - - <remark>BZ#794386</remark>Task: Configure the JCR Database Data= source - - Complete this task to configure the JCR datasource descriptor.= - - - Prerequisites - - - Complete - - - - - - Open JBOSS_HOME/server/= PROFILE/deploy/gatein-ds.xml in a tex= t editor. - - - Locate the <jndi-name>gatein-jcr</jndi-name> dir= ectives that affect JCR datasource descriptors: + More information about setting up specific datasources can be foun= d in the JBoss Enterprise Application Platform Getting Started G= uide, in the Using Other Databases chapt= er. +
+ <remark>BZ#794386 </remark>Single Portal JCR and IDM + For production instances that use a single portal container, yo= u can configure a single JCR and IDM database. If you run JBoss Enterprise = Portal Platform with the default configuration from a clean install, withou= t Site Publisher, you meet this requirement. + For customers installing Site Publisher, or customers that requi= re multiple portal containers in their JBoss Enterprise Portal Platform, fo= llow the tasks in to ensure you= configure the JNDI requirements for multiple platforms correctly. + + <remark>BZ#794386</remark>Task: Configure the JCR Database Da= tasource + + Complete this task to configure the JCR datasource descripto= r for instances that have one portal container (the default when you instal= l the platform for the first time, without Site Publisher). + + + Prerequisites - <connection-url> + Complete + + + + + Open JBOSS_HOME/serve= r/PROFILE/deploy/gatein-ds.xml in a t= ext editor. + + + Locate the <jndi-name>gatein-jcr</jndi-name> d= irectives that affect JCR datasource descriptors: + + + <connection-url> + + + <driver-class> + + + <user-name> + + + <password> + + + + + Change the <connection-url> and <driver-class>= directive values to match those specified in the JDBC documentation for yo= ur chosen production database. + + Ensure you specify the JCR-specific database in the <= connection-url>. + + + + Change the <user-name> and <password> directiv= e values to the default user created in . + + The password you specify in <password> is in plain= text, and anyone with access to the server can discover the password. Cons= ider encrypting this password. + + + + + Result + You have provided the key information in the g= atein-ds.xml directives, and the JCR datasource is ready for pr= oduction use. + + + + + + <remark>BZ#794386</remark>Task: Configure the IDM Database Da= tasource + + Complete this task to configure the IDM datasource descripto= r. + + + Prerequisites + - <driver-class> + Complete + + + + + Open JBOSS_HOME/serve= r/PROFILE/deploy/gatein-ds.xml in a t= ext editor. + + + Locate the <jndi-name>gatein-idm</jndi-name> d= irectives that affect JCR datasource descriptors: + + + <connection-url> + + + <driver-class> + + + <user-name> + + + <password> + + + + + Change the <connection-url> and <driver-class>= directive values to match those specified in the JDBC documentation for yo= ur chosen production database. + + Ensure you specify the IDM-specific database in the <= connection-url>. + + + + Change the <user-name> and <password> directiv= e values to the default user created in . + + The password you specify in <password> is in plain= text, and anyone with access to the server can discover the password. Cons= ider encrypting this password using a keypair. + + + + + Result + You have provided the key information in the g= atein-ds.xml directives, and the IDM datasource is ready for pr= oduction use. + + + + +
+
+ <remark>BZ#794386 </remark>Multiple Portal JCR and IDM + If you run Site Publisher with JBoss Enterprise Portal Platform,= or need to configure multiple portal containers in your installation of JB= oss Enterprise Portal Platform, JNDI requires a separate JCR and IDM dataso= urce definition for each portal container in JBOSS_HOME/server/PROFILE/deploy/gatein-ds.xml. + This requirement also means a separate JCR and IDM database is r= equired for each portal container. + + <remark>BZ#794386</remark>Task: Configure Multiple JCR Databa= se Datasources + + Complete this task to configure the JCR datasource descripto= rs for two portal containers. + + This task uses Site Publisher as the second database descr= iptor, however if you are not running Site Publisher you can substitute the= Site Publisher JNDI name ecmdemo with the name of your = second portal container. + + + + Prerequisites + - <user-name> + Complete , remembering to provision a JCR and IDM database for each portal conta= iner. - - <password> - - - - Change the <connection-url> and <driver-class> d= irective values to match those specified in the JDBC documentation for your= chosen production database. - - Ensure you specify the JCR-specific database in the <co= nnection-url>. - - - - Change the <user-name> and <password> directive = values to the default user created in . - - The password you specify in <password> is in plain t= ext, and anyone with access to the server can discover the password. Consid= er encrypting this password. - - - - - Result - You have provided the key information in the gat= ein-ds.xml directives, and the JCR datasource is ready for prod= uction use. - - - - - - <remark>BZ#794386</remark>Task: Configure the IDM Database Data= source - - Complete this task to configure the IDM datasource descriptor.= - - - Prerequisites - - - Complete - - - - - - Open JBOSS_HOME/server/= PROFILE/deploy/gatein-ds.xml in a tex= t editor. - - - Locate the <jndi-name>gatein-idm</jndi-name> dir= ectives that affect JCR datasource descriptors: + + + + Open JBOSS_HOME/serve= r/PROFILE/deploy/gatein-ds.xml in a t= ext editor. + + + Create two <local-tx-datasource> descriptors, with a= different <jndi-name> suffix. + You can copy the existing <local-tx-datasource> bloc= ks in the file and modify them to suit. For example: + + + <jndi-name>gatein-jcr_portal</jndi-name> + + + <jndi-name>gatein-jcr_ecmdemo</jndi-name> + + + + + Each <local-tx-datasource> block has a set of common= directives that affect datasource descriptors: + + + <connection-url> + + + <driver-class> + + + <user-name> + + + <password> + + + + + For <jndi-name>gatein-jcr_portal</jndi-name>, change the <connection-url> and <drive= r-class> directive values to match those specified in the JDBC documenta= tion for your chosen production database. + + Ensure you specify the JCR-specific database created for= the portal portal container in the <connection-url&= gt;. For example: + <connection-url>jdbc:mysql://mysql-hostn= ame:3306/portal</connection-url> +<driver-class>com.mysql.jdbc.Driver</driver-class> + + + + For <jndi-name>gatein-jcr_ecmdemo</jndi-name>, change the <connection-url> and <driv= er-class> directive values to match those specified in the JDBC document= ation for your chosen production database. + + Ensure you specify the JCR-specific database created for= the ecmdemo portal container in the <connection-url= >. For example: + <connection-url>jdbc:mysql://mysql-hostn= ame:3306/ecmdemo</connection-url> +<driver-class>com.mysql.jdbc.Driver</driver-class> + + + + Change the <user-name> and <password> directiv= es in all <local-tx-datasource> blocks to the values for the default= user created in . + + The password you specify in <password> is in plain= text, and anyone with access to the server can discover the password. Cons= ider encrypting this password. + + + + + Result + You have provided the key information in the g= atein-ds.xml directives, and the JCR datasources for both portal= containers are ready for production use. + + + + + + <remark>BZ#794386</remark>Task: Configure Multiple IDM Databa= se Datasource + + Complete this task to configure multiple IDM datasource desc= riptors. + + This task uses Site Publisher as the second portal contain= er, however if you are not running Site Publisher you can replace the Site = Publisher JNDI name ecmdemo with the name of your second= portal container. + + + + Prerequisites - <connection-url> + Complete - - <driver-class> - - - <user-name> - - - <password> - - - - Change the <connection-url> and <driver-class> d= irective values to match those specified in the JDBC documentation for your= chosen production database. - - Ensure you specify the IDM-specific database in the <co= nnection-url>. - - - - Change the <user-name> and <password> directive = values to the default user created in . - - The password you specify in <password> is in plain t= ext, and anyone with access to the server can discover the password. Consid= er encrypting this password using a keypair. - - - - - Result - You have provided the key information in the gat= ein-ds.xml directives, and the IDM datasource is ready for prod= uction use. - - - - - More information about setting up datasources can be found in the = JBoss Enterprise Application Platform Getting Started Guide, in the Using Other Databases chapter. + + + + Open JBOSS_HOME/serve= r/PROFILE/deploy/gatein-ds.xml in a t= ext editor. + + + Create two <no-tx-datasource> descriptors, with a di= fferent <jndi-name> suffix. + You can copy the existing <no-tx-datasource> blocks = in the file and modify them to suit. For example: + + + <jndi-name>gatein-idm_portal</jndi-name> + + + <jndi-name>gatein-idm_ecmdemo</jndi-name> + + + + + Each <no-tx-datasource> block has a set of common di= rectives that affect datasource descriptors: + + + <connection-url> + + + <driver-class> + + + <user-name> + + + <password> + + + + + For <jndi-name>gatein-idm_portal</jndi-name>, change the <connection-url> and <drive= r-class> directive values to match those specified in the JDBC documenta= tion for your chosen production database. + + Ensure you specify the IDM-specific database created for= the portal portal container in the <connection-url&= gt;. For example: + <connection-url>jdbc:mysql://mysql-hostn= ame:3306/portal</connection-url> +<driver-class>com.mysql.jdbc.Driver</driver-class> + + + + For <jndi-name>gatein-idm_ecmdemo</jndi-name>, change the <connection-url> and <driv= er-class> directive values to match those specified in the JDBC document= ation for your chosen production database. + + Ensure you specify the IDM-specific database created for= the ecmdemo portal container in the <connection-url= >. For example: + <connection-url>jdbc:mysql://mysql-hostn= ame:3306/ecmdemo</connection-url> +<driver-class>com.mysql.jdbc.Driver</driver-class> + + + + Change the <user-name> and <password> directiv= es in all <no-tx-datasource> blocks to the values for the default us= er created in . + + The password you specify in <password> is in plain= text, and anyone with access to the server can discover the password. Cons= ider encrypting this password. + + + + + Result + You have provided the key information in the g= atein-ds.xml directives, and the IDM datasources for both portal= containers are ready for production use. + + + + +
First-run Database Schema Creation When you start JBoss Enterprise Portal Platform for the first ti= me, - it will create the proper database schema based on the database confi= guration you specified in . + it will create the proper database schema based on the database confi= guration you specified in or . JBoss Enterprise Portal Platform assumes the default encoding = for your database is latin1. @@ -204,18 +375,9 @@ Before starting the server for the first time, continue to for the nex= t mandatory configuration requirement.
- Example with MySQL Server 5.1 - - Configuration - MySQL - - - Database - MySQL - - - MySQL - + <remark>BZ#794386 </remark>Example with MySQL Server 5.1 + This section describes an example how to configure MySQL to work= with a single portal container. Refer to if you need to configure multiple portal containers in your inst= allation, or intend to use Site Publisher. + More information about setting up other datasources can be found= in the JBoss Enterprise Application Platform Getting Started Gu= ide, in the Using Other Databases chapte= r. Installing the MySQL JDBC connector The MySQL JDBC connector is required for EPP to use a MySQL database: Modified: epp/docs/branches/5.2/Installation_Guide/en-US/HTTPSConfiguration= .xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- epp/docs/branches/5.2/Installation_Guide/en-US/HTTPSConfiguration.xml 2= 012-02-27 11:53:06 UTC (rev 8473) +++ epp/docs/branches/5.2/Installation_Guide/en-US/HTTPSConfiguration.xml 2= 012-02-28 03:37:35 UTC (rev 8474) @@ -6,7 +6,7 @@
<remark>BZ#794440 </remark>HTTPS Configuration https://bugzilla.redhat.com/show_bug.cgi?id=3D794440 - 20120221 = - Reworked the entire section to cover keystore and truststore configuratio= n specific to EPP. - JBoss Enterprise Portal Platform runs by default in HTTP mode. Fo= r security purposes, and to ensure portal gadgets run correctly, configure= it to run in HTTPS mode. + JBoss Enterprise Portal Platform runs by default in HTTP mode. Fo= r security purposes, configure your production platform to run in HTTPS mo= de. Understanding the fundamentals of keystore and truststore config= uration is critical to the tasks in this section. Refer to the JBoss Enterprise Application Platform Se= curity Guide "SSL Encryption Overview" chapter for detailed encryption theory and procedures relevant to = all JBoss Middleware platforms. @@ -49,7 +49,7 @@ - Navigate to JBOSS_HOME/= jboss-as/server/PROFILE/conf/ + Navigate toJBOSS_HOME/j= boss-as/server/PROFILE/conf/ Generate the keystore by executing the following command. E= nsure you substitute the values with informati= on relevant to your organization, and record the information for later use:= @@ -103,6 +103,6 @@ You have configured the platform to communicate using a secure c= onnection. - You can now access the portal via address: https://<ServerAddress>:8443/portal - + You can now access the portal from the address: http= s://<ServerAddress>:8443/portal + once you have completed the other configuration tasks in this gui= de.
Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Revision_History.x= ml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- epp/docs/branches/5.2/Installation_Guide/en-US/Revision_History.xml 201= 2-02-27 11:53:06 UTC (rev 8473) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Revision_History.xml 201= 2-02-28 03:37:35 UTC (rev 8474) @@ -9,6 +9,20 @@ + 5.2.1-4 + Tue Feb 28 2012 + + Jared + Morgan + + + + + Incorporated feedback from theute in https://bugzilla.= redhat.com/show_bug.cgi?id=3D794386. New sections added to Database Configu= ration, specifically Multiple Portal JCR and IDM. + + + + 5.2.1-3 Mon Feb 27 2012 Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Uninstall_JBoss.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- epp/docs/branches/5.2/Installation_Guide/en-US/Uninstall_JBoss.xml 2012= -02-27 11:53:06 UTC (rev 8473) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Uninstall_JBoss.xml 2012= -02-28 03:37:35 UTC (rev 8474) @@ -1,13 +1,11 @@ - + %BOOK_ENTITIES; ]> - - Uninstall JBoss Enterprise Portal Platform - - As JBoss Enterprise Portal Platform was installed from a zip file, you m= ay uninstall it by simply deleting the JBoss Enterprise Portal Platform dir= ectory installed on your system. = - + Uninstall JBoss Enterprise Portal Platform + + As JBoss Enterprise Portal Platform is installed from a Zip file, you ca= n remove it by deleting the JBoss Enterprise Portal Platform directory ins= talled on your system. = + - --===============5404201298011616061==--