Run Syncope in real environments

Transcription

1 Run Syncope in real environments Version Warning The content below is for Apache Syncope <= for later versions check the "System Administration" chapter of the Reference Guide Introduction Deployment directory Internal storage PostgreSQL MySQL MariaDB Oracle Microsoft SQL Server 4. JEE container 1. Apache Tomcat 7 1. Set Environment 1. GNU / Linux - Mac OS X 2. Windows 2. context.xml 2. Glassfish Update core glassfish-web.xml 3. JBoss AS Fixing error messages at core startup 4. Wildfly Fixing error messages at core startup 2. Use DataSource 1. core web.xml 2. core jboss-deployment-structure 5. Oracle WebLogic Update core web.xml 2. Update core weblogic.xml 5. Other setup tasks 1. Use datasource 2. Connect console to core 3. Build and deploy 1. Syncope >= Test your installation Introduction Once you have created your project, you can start adapting it to your own needs and requirements. Deployment directory Currently, Syncope needs three base directories to be defined: bundles - where ConnId bundles are stored (check what a connector bundle is); log - where all system logs are written; conf (optional) - where configuration files are located, if override is needed. Bundles directory should only contain connector bundle JAR files. The presence of any other file might cause the unavailability of any connector bundle in Apache Syncope. For example, you can create directories as follows:

2 $ mkdir /opt/syncope $ mkdir /opt/syncope/bundles $ mkdir /opt/syncope/log $ mkdir /opt/syncope/conf Internal storage Internal storage is a database where all information and configurations are stored. You may want to setup some default content to be loaded on internal storage upon schema creation: for this you need to edit core/src/main/resources/content.xml. Please note that Syncope core will populate internal storage with provided content only if the corresponding database is empty, i.e. does not contain any table or view. Depending on your DBMS, you will need to change your project setup accordingly; modify the content of core/src/main/resources/persistence.properties as indicated in the following. PostgreSQL jpa.driverclassname=org.postgresql.driver jpa.url=jdbc:postgresql://localhost:5432/syncope jpa.username=syncope jpa.password=syncope jpa.dialect=org.apache.openjpa.jdbc.sql.postgresdictionary jpa.pool.validationquery=select 1 #note: other connection pool settings can also be configured here, see persistencecontext.xml quartz.jobstore=org.quartz.impl.jdbcjobstore.postgresqldelegate quartz.sql=tables_postgres.sql audit.sql=audit.sql database.schema= This assumes that you have a PostgreSQL instance running on localhost, listening on its default port 5432 with a database syncope fully accessible by user syncope with password syncope. MySQL

3 jpa.driverclassname=com.mysql.jdbc.driver jpa.url=jdbc:mysql://localhost:3306/syncope?characterencoding=utf-8 jpa.username=syncope jpa.password=syncope jpa.dialect=org.apache.openjpa.jdbc.sql.mysqldictionary jpa.pool.validationquery=select 1 #note: other connection pool settings can also be configured here, see persistencecontext.xml quartz.jobstore=org.quartz.impl.jdbcjobstore.stdjdbcdelegate quartz.sql=tables_mysql_innodb.sql audit.sql=audit_mysql_innodb.sql database.schema= This assumes that you have a MySQL instance running on localhost, listening on its default port 3306 with a database syncope fully accessible by user syncope with password syncope. It also assumes that the InnoDB engine is enabled in your MySQL instance - if this is not the case, then change the value for 'quartz.sql' to quartz.sql=tables_mysql.sql MariaDB jpa.driverclassname=org.mariadb.jdbc.driver jpa.url=jdbc:mariadb://localhost:3306/syncope?characterencoding=utf-8 jpa.username=syncope jpa.password=syncope jpa.dialect=org.apache.openjpa.jdbc.sql.mariadbdictionary jpa.pool.validationquery=select 1 #note: other connection pool settings can also be configured here, see persistencecontext.xml quartz.jobstore=org.quartz.impl.jdbcjobstore.stdjdbcdelegate quartz.sql=tables_mariadb.sql audit.sql=audit.sql database.schema= This assumes that you have a MariaDB instance running on localhost, listening on its default port 3306 with a database syncope fully accessible by user syncope with password syncope. Oracle

4 jpa.driverclassname=oracle.jdbc.oracledriver jpa.username=syncope jpa.password=syncope jpa.dialect=org.apache.openjpa.jdbc.sql.oracledictionary jpa.pool.validationquery=select 1 FROM DUAL #note: other connection pool settings can also be configured here, see persistencecontext.xml quartz.jobstore=org.quartz.impl.jdbcjobstore.oracle.oracledelegate quartz.sql=tables_oracle.sql audit.sql=audit_oracle.sql database.schema=syncope This assumes that you have an Oracle instance running on localhost, listening on its default port 1521 with a database syncope under tablespace SYNCOPE fully accessible by user syncope with password syncope. You will also need to 1. create directory core/src/main/resources/meta-inf download Oracle mapping file for the version you are building ( 1_2_X, 1.1.X, 1.0.X) rename it to orm.xml and copy it under the directory created above Microsoft SQL Server jpa.driverclassname=com.microsoft.sqlserver.jdbc.sqlserverdriver jpa.url=jdbc:sqlserver://localhost:1344;database=syncope; selectmethod=cursor;sendstringparametersasunicode=false jpa.username=syncope jpa.password=syncope jpa.dialect=org.apache.openjpa.jdbc.sql.sqlserverdictionary jpa.pool.validationquery=select 1 #note: other connection pool settings can also be configured here, see persistencecontext.xml quartz.jobstore=org.quartz.impl.jdbcjobstore.mssqldelegate quartz.sql=tables_sqlserver.sql audit.sql=audit_sqlserver.sql database.schema= This assumes that you have an SQL Server instance running on localhost, listening on its default port 1344 with a database syncope fully accessible by user syncope with password syncope. You will also need to

5 1. create directory core/src/main/resources/meta-inf download MS SQL Server mapping file for the version you are building ( 1_2_X, 1.1.X, 1.0.X) rename it to orm.xml and copy it under the directory created above JEE container Apache Tomcat 7 This assumes that you have got Apache Tomcat 7 installed in directory $CATALINA_HOME. Debian / Ubuntu warning If you have installed Apache Tomcat 7 via Debian / Ubuntu package, you will also need to download the Tomcat JDBC Connection Pool JAR from Maven central repository, same version of the installed Tomcat 7 copy the downloaded JAR file under /usr/share/java Set Environment GNU / Linux - Mac OS X Create $CATALINA_HOME/bin/setenv.sh with content (keep everything on a single line). JAVA_OPTS="-Djava.awt.headless=true -Dfile.encoding=UTF-8 -server \ -Xms1536m -Xmx1536m -XX:NewSize=256m -XX:MaxNewSize=256m -XX:PermSize=256m \ -XX:MaxPermSize=256m -XX:+DisableExplicitGC" Windows Create %CATALINA_HOME%\bin\setenv.bat with content (keep everything on a single line). set JAVA_OPTS=-Djava.awt.headless=true -Dfile.encoding=UTF-8 -server -Xms1536m -Xmx1536m -XX:NewSize=256m -XX:MaxNewSize=256m -XX:PermSize=256m -XX:MaxPermSize=256m -XX:+DisableExplicitGC context.xml Uncomment <Manager pathname="" /> in $CATALINA_HOME/conf/context.xml.

6 Optionally, define a datasource for internal storage (following example is for MySQL): please check that the connection parameters are same as configured above. <Resource name="jdbc/syncopedatasource" auth="container" type="javax.sql. DataSource" factory="org.apache.tomcat.jdbc.pool.datasourcefactory" testwhileidle="true" testonborrow="true" testonreturn="true" validationquery="select 1" validationinterval="30000" maxactive="100" minidle="2" maxwait="10000" initialsize="2" removeabandonedtimeout="20" removeabandoned="true" logabandoned="true" suspecttimeout="20" timebetweenevictionrunsmillis="5000" minevictableidletimemillis=" 5000" jdbcinterceptors="org.apache.tomcat.jdbc.pool.interceptor. ConnectionState;org.apache.tomcat.jdbc.pool.interceptor.StatementFinalizer" username="syncope" password="syncope" driverclassname="com.mysql. jdbc.driver" url="jdbc:mysql://localhost:3306/syncope?characterencoding=utf-8" /> Be sure to put the JDBC driver JAR file under $CATALINA_HOME/lib for the Datasource you have defined above. Glassfish 4.1 Update core glassfish-web.xml When using a datasource for internal storage, be sure to add <resource-ref> <res-ref-name>jdbc/syncopedatasource</res-ref-name> <jndi-name>jdbc/syncopedatasource</jndi-name> </resource-ref> assuming that your Glassfish instance provides a datasource named jdbc/syncopedatasource. right after </context-root> in core/src/main/webapp/web-inf/glassfish-web.xml. JBoss AS 7.1 Version warning Content of this paragraph applies to Apache Syncope < Download this file, copy it under core/src/main/resources/ and replace

7 <entry key="openjpa.metadatafactory" value="org.apache.syncope.core. persistence.openjpa.jbosspersistencemappingfactory(urls=vfs:${project. build.directory}/cargo/configurations/jboss71x/deployments/${project.build. finalname}.war/web-inf/classes/, Resources=META-INF/orm.xml)"/> with <entry key="openjpa.metadatafactory" value="org.apache.syncope.core. persistence.openjpa.jbosspersistencemappingfactory(urls=vfs:/content /${project.build.finalname}.war/web-inf/classes/, Resources=META-INF/orm. xml)"/> Fixing error messages at core startup When core application starts up you will see many yet harmless error messages and stacktraces: this is due to an internal mechanism that looks for custom implementations of standard Apache Syncope interfaces. If you want to remove such messages you can provide an override of the org.apache.syncope.core.init. ImplementationClassNamesLoader class: see an example here. Wildfly 8.1 Version warning Content of this paragraph applies to Apache Syncope >= 1.2.X Download this file, copy it under core/src/main/resources/ and replace <entry key="openjpa.metadatafactory" value="jpa(urls=vfs:${project.build. directory}/cargo/configurations/jboss71x/deployments/${project.build. finalname}.war/web-inf/classes/, Resources=META-INF/orm.xml)"/> with <entry key="openjpa.metadatafactory" value="jpa(urls=vfs:/content /${project.build.finalname}.war/web-inf/classes/, Resources=META-INF/orm. xml)"/> Fixing error messages at core startup When core application starts up you will see many yet harmless error messages and stacktraces: this is due to an internal mechanism that looks for custom implementations of standard Apache Syncope interfaces. If you want to remove such messages you can provide an override of the org.apache.syncope.core.init. ImplementationClassNamesLoader class: see an example here.

8 Use DataSource When using a DataSource, a few additional adjustments are needed. core web.xml Change <resource-ref> <res-ref-name>jdbc/syncopedatasource</res-ref-name> <res-type>javax.sql.datasource</res-type> <res-auth>container</res-auth> </resource-ref> to <resource-ref> <res-ref-name>jdbc/syncopedatasource</res-ref-name> <res-type>javax.sql.datasource</res-type> <res-auth>container</res-auth> <lookup-name>java:/syncopedatasource</lookup-name> </resource-ref> assuming that you have defined a DataSource with JNDI name 'java:/syncopedatasource' in JBoss configuration. core jboss-deployment-structure Add <module name="com.mysql"/> right before </dependencies> assuming that 'com.mysql' is the name of the JBoss module you have deployed for your JDBC Driver (MySQL in this case). Oracle WebLogic 12 Update core web.xml Change classpath*:/*context.xml to

9 /WEB-INF/classes/*Context.xml at the beginning of core/src/main/webapp/web-inf/web.xml. Update core weblogic.xml When using a datasource for internal storage, be sure to add <resource-description> <jndi-name>syncopedatasource</jndi-name> <res-ref-name>jdbc/syncopedatasource</res-ref-name> </resource-description> assuming that your WebLogic instance provides a datasource named syncopedatasource. before </weblogic-web-app> in core/src/main/webapp/web-inf/weblogic.xml. Other setup tasks Use datasource Syncope, when not finding a datasource called jdbc/syncopedatasource, will connect to internal storage by instantiating a new connection upon request: this is of course strongly discouraged for any production environment. When using a container-managed datasource, be sure to uncomment the <resource-ref... /> element in core/src/main/webapp /WEB-INF/web.xml. Connect console to core Modify console/src/main/resources/console.properties so that provided properties reflects the scheme, hostname and port number where your JEE container is running and the URL context where Syncope core will be deployed. For example, when running your JEE container on port 9080, you should have scheme=http host=localhost port=8080 rootpath=/syncope/rest/ Build and deploy Assuming that you have created the two deployment directories defined above, just run Syncope >= 1.2.0

10 mvn clean package -Dconf.directory=/opt/syncope/conf -Dbundles.directory= /opt/syncope/bundles -Dlog.directory=/opt/syncope/log At this point you can deploy core/target/syncope.war and console/target/syncope-console.war to your JEE container. Test your installation 1. Point your favorite browser to administration console at (assuming that your JEE container is running on localhost, port 8080) 2. Login as 'admin' / 'password'