This is the documentation for Cloudera Manager 5.0.x. Documentation for other versions is available at Cloudera Documentation.

Oozie

Role groups:

Oozie Server Default Group

Advanced

Display Name Description Related Name Default Value Unit API Name Required
Oozie Server Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Heap Dump Directory Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it doesn't exist. However, if this directory already exists, role user must have write access to this directory. If this directory is shared amongst multiple roles, it should have 1777 permissions. Note that the heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role. /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. false oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
Oozie Server Advanced Configuration Snippet (Safety Valve) for oozie-site.xml For advanced use only, a string to be inserted into oozie-site.xml for this role only. oozie_config_safety_valve false
Java Configuration Options for Oozie Server These arguments will be passed as part of the Java command line. Commonly, garbage collection flags or extra debugging flags would be passed here. oozie_java_opts false
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. false process_auto_restart true

Database

Display Name Description Related Name Default Value Unit API Name Required
Oozie Server Data Directory Directory where the Oozie Server will place its data. Only applicable when using Derby as the database type. /var/lib/oozie/data oozie_data_dir false
Oozie Server Database Host Hostname of the database used by Oozie Server. If the port is non-default for your database type, use host:port notation. Does not apply if you are using Derby as the database type. localhost oozie_database_host false
Oozie Server Database Name Name of the database used by Oozie Server. oozie oozie_database_name false
Oozie Server Database Password Password for connecting to the database used by Oozie Server. Does not apply if you are using Derby as the database type. oozie.service.JPAService.jdbc.password oozie_database_password false
Oozie Server Database Type Type of the database used by Oozie Server. derby oozie_database_type false
Oozie Server Database User Username for connecting to the database used by Oozie Server. Does not apply if you are using Derby as the database type. oozie.service.JPAService.jdbc.username sa oozie_database_user false

Logs

Display Name Description Related Name Default Value Unit API Name Required
Oozie Server Logging Threshold The minimum log level for Oozie Server logs INFO log_threshold false
Oozie Server Maximum Log File Backups The maximum number of rolled log files to keep for Oozie Server logs. Typically used by log4j. 720 max_log_backup_index false

Monitoring

Display Name Description Related Name Default Value Unit API Name Required
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % oozie_server_fd_thresholds false
Oozie Server Host Health Test When computing the overall Oozie Server health, consider the host's health. true oozie_server_host_health_enabled false
Oozie Server Process Health Test Enables the health test that the Oozie Server's process state is consistent with the role configuration true oozie_server_scm_health_enabled false
Role Triggers The configured triggers for this role. This is a JSON formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has all of the following fields:
  • triggerName (mandatory) - the name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - a tsquery expression representing the trigger.
  • streamThreshold (optional) - the maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned will cause the condition to fire.
  • enabled (optional) - by default set to 'true'. If set to 'false' the trigger will not be evaluated.
For example, here is a JSON formatted trigger configured for a DataNode that fires if the DataNode has more than 1500 file-descriptors opened: 
[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:red",
  "streamThreshold": 0}, "enabled": "true"]
Consult the trigger rules documentation for more details on how to write triggers using tsquery. The JSON format is evolving and may change in the future and as a result backward compatibility is not guaranteed between releases at this time. 		[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value Unit API Name Required
Oozie Email Action From Address The from address to be used for mailing all emails for Oozie email action oozie.email.from.address oozie@localhost oozie_email_from_address false
Oozie Email Action SMTP Authentication Enabled Enable SMTP authentication for Oozie email action oozie.email.smtp.auth false oozie_email_smtp_auth false
Oozie Email Action SMTP Host The SMTP server host to use for Oozie email action oozie.email.smtp.host localhost oozie_email_smtp_host false
Oozie Email Action SMTP Authentication Password SMTP password for Oozie email action oozie.email.smtp.password oozie_email_smtp_password false
Oozie Email Action SMTP Authentication Username SMTP username for Oozie email action oozie.email.smtp.username oozie_email_smtp_username false
Oozie ActionService Executor Extension Classes Comma-separated list of ActionService executor extension classes. Only action types with associated executors can be used in workflows. oozie.service.ActionService.executor.ext.classes org.apache.oozie.action.hadoop.HiveActionExecutor, org.apache.oozie.action.hadoop.SqoopActionExecutor, org.apache.oozie.action.email.EmailActionExecutor, org.apache.oozie.action.hadoop.ShellActionExecutor, org.apache.oozie.action.hadoop.DistcpActionExecutor oozie_executor_extension_classes false
Oozie Server Log Directory Directory where Oozie Server will place its log files. /var/log/oozie oozie_log_dir false
Oozie Server Plugins Comma-separated list of Oozie plug-ins to be activated. If one plugin cannot be loaded, all the plugins are ignored. oozie.services.ext oozie_plugins_list false
Maximum concurrency for a given callable type Maximum concurrency for a given callable type. Each command is a callable type: submit, start, run, etc. Each action type is a callable type: MapReduce, SSH, sub-workflow, etc. All commands that use action executors (action-start, action-end. etc.) use the action type as the callable type. oozie.service.callablequeueservice.callable.concurrency 3 oozie_service_callablequeueservice_callable_concurrency false
Maximum Callable Queue Size Maximum callable queue size oozie.service.callablequeueservice.queue.size 10000 oozie_service_callablequeueservice_queue_size false
Number Threads For Executing Callables Number of threads used for executing callables oozie.service.callablequeueservice.threads 10 oozie_service_callablequeueservice_threads false
Enable Oozie Server Web Console If true, enables the Oozie Server web console. ExtJS 2.2 zip archive must be extracted to /var/lib/oozie on the same host as the Oozie Server. false oozie_web_console false
Oozie SchemaService Workflow Extension Schemas Comma-separated list of SchemaService workflow extension schemas for additional action types. oozie.service.SchemaService.wf.ext.schemas hive-action-0.2.xsd, sqoop-action-0.2.xsd, email-action-0.1.xsd, distcp-action-0.1.xsd, shell-action-0.1.xsd, ssh-action-0.1.xsd, distcp-action-0.2.xsd, hive-action-0.3.xsd, hive-action-0.4.xsd, hive-action-0.5.xsd, oozie-sla-0.1.xsd, oozie-sla-0.2.xsd, sqoop-action-0.3.xsd, sqoop-action-0.4.xsd, shell-action-0.2.xsd, shell-action-0.3.xsd, ssh-action-0.2.xsd oozie_workflow_extension_schemas false

Performance

Display Name Description Related Name Default Value Unit API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false

Ports and Addresses

Display Name Description Related Name Default Value Unit API Name Required
Oozie Admin Port The admin port Oozie server runs. 11001 oozie_admin_port false
Oozie Email Action SMTP Port The SMTP server port to use for Oozie email action oozie.email.smtp.port 25 oozie_email_smtp_prt false
Oozie HTTP Port Port of Oozie Server 11000 oozie_http_port false

Proxy

Display Name Description Related Name Default Value Unit API Name Required
Hue Proxy User Groups Comma-delimited list of groups that you want to allow the Hue user to impersonate. The default '*' allows all groups. To disable entirely, use a string that doesn't correspond to a group name, such as '_no_group_'. oozie.service.ProxyUserService.proxyuser.hue.groups * hue_proxy_user_groups_list false
Hue Proxy User Hosts Comma-delimited list of hosts where you want to allow the Hue user to impersonate other users. The default '*' allows all hosts. To disable entirely, use a string that doesn't correspond to a host name, such as '_no_host'. oozie.service.ProxyUserService.proxyuser.hue.hosts * hue_proxy_user_hosts_list false

Resource Management

Display Name Description Related Name Default Value Unit API Name Required
Java Heap Size of Oozie Server in Bytes Maximum size for the Java Process heap memory. Passed to Java -Xmx. Measured in bytes. 1 GiB oozie_java_heapsize false
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Security

Display Name Description Related Name Default Value Unit API Name Required
Oozie SSL Keystore File Location of the keystore file on the local file system. /var/lib/oozie/.keystore oozie_https_keystore_file false
Oozie SSL Keystore Password Password for the keystore. oozie_https_keystore_password false
Oozie HTTPS Port Port of the Oozie Server while using SSL. 11443 oozie_https_port false

Service-Wide

Advanced

Display Name Description Related Name Default Value Unit API Name Required
Oozie Service Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of all roles in this service except client configuration. oozie_env_safety_valve false
System Group The group that this service's processes should run as. oozie process_groupname true
System User The user that this service's processes should run as. oozie process_username true

Monitoring

Display Name Description Related Name Default Value Unit API Name Required
Enable Service Level Health Alerts When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Healthy Oozie Server Monitoring Thresholds The health test thresholds of the overall Oozie Server health. The check returns "Concerning" health if the percentage of "Healthy" Oozie Servers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Oozie Servers falls below the critical threshold. Warning: 99.0 %, Critical: 51.0 % oozie_servers_healthy_thresholds false
Service Triggers The configured triggers for this service. This is a JSON formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has all of the following fields:
  • triggerName (mandatory) - the name of the trigger. This value must be unique for the specific service.
  • triggerExpression (mandatory) - a tsquery expression representing the trigger.
  • streamThreshold (optional) - the maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned will cause the condition to fire.
  • enabled (optional) - by default set to 'true'. If set to 'false' the trigger will not be evaluated.
For example, here is a JSON formatted trigger that fires if there are more than 10 DataNodes with more than 500 file-descriptors opened: 
[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:red",
  "streamThreshold": 10, "enabled": "true"}]
Consult the trigger rules documentation for more details on how to write triggers using tsquery. The JSON format is evolving and may change in the future and as a result backward compatibility is not guaranteed between releases at this time. 		[] service_triggers true
Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones. smon_derived_configs_safety_valve false

Other

Display Name Description Related Name Default Value Unit API Name Required
MapReduce Service Service to run MapReduce jobs against mapreduce_yarn_service true
Oozie Load Balancer Address of the load balancer used if Oozie HA is enabled. Should be specified in host:port format. oozie_load_balancer false
Coordinator Job Lookup Interval Coordinator Job Lookup trigger command is scheduled at this interval (in seconds). oozie.service.CoordMaterializeTriggerService.lookup.interval 5 minute(s) oozie_service_coord_lookup_interval false
Use ACLs on Znode Use ACLs on Znode while a secure ZooKeeper is used for Oozie High Availability. Note: This config is not emitted if ZooKeeper is not secure. oozie.zookeeper.secure true oozie_zk_secure false
ZooKeeper Namespace Namespace used by this Oozie service in ZooKeeper when High Availability is enabled. oozie.zookeeper.namespace oozie oozie_zookeeper_namespace false
ZooKeeper Service Name of the ZooKeeper service that this Oozie service instance depends on zookeeper_service false

Security

Display Name Description Related Name Default Value Unit API Name Required
Oozie Credential Classes A list of credential class mappings for CredentialsProvider. oozie.credentials.credentialclasses hcat=org.apache.oozie.action.hadoop.HCatCredentials, hbase=org.apache.oozie.action.hadoop.HbaseCredentials, hive2=org.apache.oozie.action.hadoop.Hive2Credentials oozie_credential_classes false
Use SSL Enable SSL for Oozie. Note:This is supported only from CDH 4.3 onwards. false oozie_use_ssl false
Page generated September 3, 2015.