::Go back to Oozie Documentation Index::
IMPORTANT: Oozie ignores any set value for OOZIE_HOME , Oozie computes its home automatically.
When running Oozie with its embedded Tomcat server, the conf/oozie-env.sh file can be used to configure the following environment variables used by Oozie:
CATALINA_OPTS : settings for the Embedded Tomcat that runs Oozie Java System properties for Oozie should be specified in this variable. No default value.
OOZIE_CONFIG_FILE : Oozie configuration file to load from Oozie configuration directory. Default value oozie-site.xml .
OOZIE_LOGS : Oozie logs directory. Default value logs/ directory in the Oozie installation directory.
OOZIE_LOG4J_FILE : Oozie Log4J configuration file to load from Oozie configuration directory. Default value oozie-log4j.properties .
OOZIE_LOG4J_RELOAD : Reload interval of the Log4J configuration file, in seconds. Default value 10
OOZIE_HTTP_PORT : The port Oozie server runs. Default value 11000 .
OOZIE_HTTP_HOSTNAME : The host name Oozie server runs on. Default value is the output of the command hostname -f .
OOZIE_BASE_URL : The base URL for actions callback URLs to Oozie. The default value is http://${OOZIE_HTTP_HOSTNAME}:${OOZIE_HTTP_PORT}/oozie .
OOZIE_CHECK_OWNER : If set to true , Oozie setup/start/run/stop scripts will check that the owner of the Oozie installation directory matches the user invoking the script. The default value is undefined and interpreted as a false .
The oozie-setup.sh script prepares the embedded Tomcat server to run Oozie.
The oozie-setup.sh script options are:
Usage : oozie-setup.sh <OPTIONS>"
[-extjs EXTJS_PATH] (expanded or ZIP, to enable the Oozie webconsole)"
[-hadoop HADOOP_VERSION HADOOP_PATH] (Hadoop version [0.20.1|0.20.2|0.20.104|0.20.200]"
and Hadoop install dir)"
[-jars JARS_PATH] (multiple JAR path separated by ':')"
(without options does default setup, without the Oozie webconsole.
Use Hadoop version 0.20.200 for any variants of 0.20.20x and 1.0.0)"
If a directory libext/ is present in Oozie installation directory, the oozie-setup.sh script include all JARs in the libext/ directory in Oozie WAR file.
If the ExtJS ZIP file is present in the libext/ directory, it will be added to Oozie WAR as well. The ExtJS library file name be ext-2.2.zip .
Use the addtowar.sh script to prepare the Oozie server only if Oozie will run with a different servlet container than the embedded Tomcat provided with the distribution.
The addtowar.sh script adds Hadoop JARs, JDBC JARs and the ExtJS library to the Oozie WAR file.
The addtowar.sh script options are:
Usage : addtowar <OPTIONS>
Options: -inputwar INPUT_OOZIE_WAR
-outputwar OUTPUT_OOZIE_WAR
[-hadoop HADOOP_VERSION HADOOP_PATH]
[-extjs EXTJS_PATH]
[-jars JARS_PATH] (multiple JAR path separated by ':')
The original oozie.war file is in the Oozie server installation directory.
After the Hadoop JARs and the ExtJS library has been added to the oozie.war file Oozie is ready to run.
Delete any previous deployment of the oozie.war from the servlet container (if using Tomcat, delete =oozie.war= and oozie directory from Tomcat's webapps/ directory)
Deploy the prepared oozie.war file (the one that contains the Hadoop JARs adn the ExtJS library) in the servlet container (if using Tomcat, copy the prepared oozie.war file to Tomcat's webapps/ directory).
IMPORTANT: Only one Oozie instance can be deployed per Tomcat instance.
Oozie works with HSQL, Derby, MySQL, Oracle and PostgreSQL databases.
By default, Oozie is configured to use Embedded Derby.
Oozie bundles the JDBC drivers for HSQL, Embedded Derby and PostgreSQL.
HSQL is normally used for testcases as it is an in-memory database and all data is lost everytime Oozie is stopped.
If using MySQL, Oracle or PostgreSQL, the Oozie database schema must be created. By default, Oozie creates its tables automatically.
The bin/addtowar.sh and the oozie-setup.sh scripts have an option -jars that can be used to add the Oracle or MySQL JDBC driver JARs to the Oozie WAR file.
The SQL database used by Oozie is configured using the following configuration properties (default values shown):
oozie.db.schema.name=oozie
oozie.service.JPAService.create.db.schema=true
oozie.service.JPAService.validate.db.connection=false
oozie.service.JPAService.jdbc.driver=org.apache.derby.jdbc.EmbeddedDriver
oozie.service.JPAService.jdbc.url=jdbc:derby:${oozie.data.dir}/${oozie.db.schema.name}-db;create=true
oozie.service.JPAService.jdbc.username=sa
oozie.service.JPAService.jdbc.password=
oozie.service.JPAService.pool.max.active.conn=10
If using HSQL, these following configuration properties have to be in oozie-site.xml:
oozie.db.schema.name=oozie
oozie.service.JPAService.create.db.schema=true
oozie.service.JPAService.validate.db.connection=false
oozie.service.JPAService.jdbc.driver=org.hsqldb.jdbcDriver
oozie.service.JPAService.jdbc.url=jdbc:hsqldb:mem:${oozie.db.schema.name}
oozie.service.JPAService.jdbc.username=sa
oozie.service.JPAService.jdbc.password=
oozie.service.JPAService.pool.max.active.conn=10
NOTE: If the oozie.db.schema.create property is set to true (default) the Oozie tables will be created automatically if they are not found in the database at Oozie start up time. In a production system this option should be set to false once the databaset tables have been created.
NOTE: If the oozie.db.schema.create property is set to true, the oozie.service.JPAService.validate.db.connection property value is ignored and Oozie handles it as set to false .
By default, Oozie configuration is read from Oozie's conf/ directory
The Oozie configuration is distributed in 3 different files:
All Oozie configuration properties and their default values are defined in the oozie-default.xml file.
Oozie resolves configuration property values in the following order:
NOTE: The oozie-default.xml file found in Oozie's conf/ directory is not used by Oozie, it is there for reference purposes only.
By default, Oozie log configuration is defined in the oozie-log4j.properties configuration file.
If the Oozie log configuration file changes, Oozie reloads the new settings automatically.
By default, Oozie logs to Oozie's logs/ directory.
Oozie logs in 4 different files:
The embedded Tomcat and embedded Derby log files are also written to Oozie's logs/ directory.
Oozie can work with Hadoop 20 with Security distribution which supports Kerberos authentication.
Oozie authentication is configured using the following configuration properties (default values shown):
oozie.service.HadoopAccessorService.kerberos.enabled=false
local.realm=LOCALHOST
oozie.service.HadoopAccessorService.keytab.file=${user.home}/oozie.keytab
oozie.service.HadoopAccessorService.kerberos.principal=${user.name}/localhost@{local.realm}
The above default values are for a Hadoop 0.20 secure distribution (with support for Kerberos authentication).
To use a Hadoop 20 distribution pre-security (i.e. 0.20.1) the following property must be set:
oozie.services.ext=org.apache.oozie.service.HadoopAccessorService
To enable Kerberos authentication, the following property must be set:
oozie.service.HadoopAccessorService.kerberos.enabled=true
When using Kerberos authentication, the following properties must be set to the correct values (default values shown):
local.realm=LOCALHOST
oozie.service.HadoopAccessorService.keytab.file=${user.home}/oozie.keytab
oozie.service.HadoopAccessorService.kerberos.principal=${user.name}/localhost@{local.realm}
IMPORTANT: When using Oozie with a Hadoop 20 with Security distribution, the Oozie user in Hadoop must be configured as a proxy user.
Oozie has a basic authorization model:
If security is disabled all users are admin users.
Oozie security is set via the following configuration property (default value shown):
oozie.service.AuthorizationService.security.enabled=false
If security is enabled, the admin users are read from the conf/adminusers.txt file:
Oozie has a system ID that is is used to generate the Oozie temporary runtime directory, the workflow job IDs, and the workflow action IDs.
Two Oozie systems running with the same ID will not have any conflict but in case of troubleshooting it will be easier to identify resources created/used by the different Oozie systems if they have different system IDs (default value shown):
oozie.system.id=oozie-${user.name}
Copy and expand the oozie-client TAR.GZ file bundled with the distribution. Add the bin/ directory to the PATH .
Refer to the Command Line Interface Utilities document for a a full reference of the oozie command line tool.
The Oozie share lib TAR.GZ file bundled with the distribution contains the necessary files to run Oozie map-reduce streaming and pig actions.
The bundled Streaming and Pig JARs are the ones used by Oozie testcases.
Oozie can be configured to use Unix standard filesystem hierarchy for its different files (configuration, logs, data and temporary files).
These settings must be done in the bin/oozie-env.sh script.
This script is sourced before the configuration oozie-env.sh and supports additional environment variables (shown with their default values):
export OOZIE_CONF=${OOZIE_HOME}/conf
export OOZIE_DATA={OOZIE_HOME}/data
export OOZIE_LOG={OOZIE_HOME}/logs
export CATALINA_BASE=${OOZIE_HOME}/oozie-server
export CATALINA_TMPDIR=${OOZIE_HOME}/oozie-server/temp
export CATALINA_OUT=${OOZIE_LOGS}/catalina.out
export CATALINA_PID=/tmp/oozie.pid
Sample values to make Oozie follow Unix standard filesystem hierarchy:
export OOZIE_CONFIG=/etc/oozie
export OOZIE_DATA=/var/lib/oozie
export OOZIE_LOG=/var/log/oozie
export CATALINA_BASE=${OOZIE_DATA}/oozie-server
export CATALINA_TMPDIR=/tmp
export CATALINA_PID=/tmp/oozie.pid