Oozie Properties in CDH 5.13.0

Role groups:

Oozie Server

Advanced

Display Name Description Related Name Default Value 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 does not exist. If this directory already exists, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. 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. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true 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
Oozie ActionService Executor Extension Classes Comma-separated list of ActionService executor extension classes. Only action types with associated executors can be used in workflows. For CDH 5.4 and higher, this parameter is used only to specify additional classes for workflows. All executor extension classes included in that release will be added automatically and do not need to be specified. oozie.service.ActionService.executor.ext.classes oozie_executor_extension_classes false
Java Configuration Options for Oozie Server These arguments will be passed as part of the Java command line. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here. oozie_java_opts false
Oozie Server 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 this role except client configuration. OOZIE_SERVER_role_env_safety_valve false
Oozie SchemaService Workflow Extension Schemas Comma-separated list of SchemaService workflow extension schemas for additional action types. From CDH 5.4 and higher, this parameter is used only to specify additional schemas for workflows. All schemas included in that release will be added automatically and do not need to be specified. oozie.service.SchemaService.wf.ext.schemas oozie_workflow_extension_schemas 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
Enable Metric Collection Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. true process_should_monitor true

Database

Display Name Description Related Name Default Value API Name Required
Oozie Server Data Directory Directory where the Oozie Server places 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 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 or logback. 720 max_log_backup_index false
Oozie Server Log Directory Directory where Oozie Server will place its log files. /var/log/oozie oozie_log_dir false

Monitoring

Display Name Description Related Name Default Value 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
Heap Dump Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory. Warning: 10 GiB, Critical: 5 GiB heap_dump_directory_free_space_absolute_thresholds false
Heap Dump Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Heap Dump Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never heap_dump_directory_free_space_percentage_thresholds 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
Workflow Status Metrics Collection Interval Workflow Status metrics collection interval. oozie.service.DBLiteWorkflowStoreService.status.metrics.collection.interval 1 minute(s) oozie_job_metric_collection_interval false
Oozie Server Callable Queue Monitoring Threshold The health test thresholds of the weighted average size of the Oozie Server callable queue over a recent period. See also Oozie Server Callable Queue Monitoring Period. Warning: 80.0 %, Critical: 95.0 % oozie_server_callable_queue_threshold false
Oozie Server Callable Queue Monitoring Period The period over which to compute the moving average of the callable queue size. 5 minute(s) oozie_server_callable_queue_window 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
Pause Duration Thresholds The health test thresholds for the weighted average extra time the pause monitor spent paused. Specified as a percentage of elapsed wall clock time. Warning: 30.0, Critical: 60.0 oozie_server_pause_duration_thresholds false
Pause Duration Monitoring Period The period to review when computing the moving average of extra time the pause monitor spent paused. 5 minute(s) oozie_server_pause_duration_window 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
Enable Oozie Server Shared Libraries Version Check If true, enables version check for Oozie Server and installed shared libraries. true oozie_server_shared_lib_version_check_enabled false
Web Metric Collection Enables the health test that the Cloudera Manager Agent can successfully contact and gather metrics from the web server. true oozie_server_web_metric_collection_enabled false
Web Metric Collection Duration The health test thresholds on the duration of the metrics request to the web server. Warning: 10 second(s), Critical: Never oozie_server_web_metric_collection_thresholds false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. Warning: Any, Critical: Never process_swap_memory_thresholds 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 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 causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode 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:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.		 [] 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 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 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 10 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 50 oozie_service_callablequeueservice_threads false
Enable The Metrics Instrumentation Service Whether to use the Codehale-based metrics for instrumentation. Enabling this disables the 'instrumentation' REST endpoint and enables the 'metrics' REST endpoint (hostname:port/v2/admin/metrics). true oozie_use_metric_instrumentation 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
Days to Keep Completed Bundle Jobs Completed bundle jobs older than this value, in days, will be purged by the PurgeService. oozie.service.PurgeService.bundle.older.than 7 day(s) purgeservice_bundle_older_than false
Days to Keep Completed Coordinator Jobs Completed coordinator jobs older than this value, in days, will be purged by the PurgeService. oozie.service.PurgeService.coord.older.than 7 day(s) purgeservice_coord_older_than false
Days to Keep Completed Workflow Jobs Completed workflow jobs older than this value, in days, will be purged by the PurgeService. oozie.service.PurgeService.older.than 30 day(s) purgeservice_older_than false
Enable Purge for Long-Running Coordinator Jobs Whether to purge completed workflows and their corresponding coordinator actions of long-running coordinator jobs if the completed workflow jobs are older than the value specified in oozie.service.PurgeService.older.than. oozie.service.PurgeService.purge.old.coord.action true purgeservice_purge_old_coord_action false

Performance

Display Name Description Related Name Default Value 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 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
Oozie HTTPS Port Port of the Oozie Server when using TLS/SSL. 11443 oozie_https_port false

Resource Management

Display Name Description Related Name Default Value API Name Required
Java Heap Size of Oozie Server in Bytes Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx. 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 API Name Required
Oozie TLS/SSL Server JKS Keystore File Location The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Oozie is acting as a TLS/SSL server. The keystore must be in JKS format. /var/lib/oozie/.keystore oozie_https_keystore_file false
Oozie TLS/SSL Server JKS Keystore File Password The password for the Oozie JKS keystore file. oozie_https_keystore_password false
Oozie TLS/SSL Certificate Trust Store File The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Oozie might connect to. This is used when Oozie is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead. oozie_https_truststore_file false
Oozie TLS/SSL Certificate Trust Store Password The password for the Oozie TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. oozie_https_truststore_password false

Stacks Collection

Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped. stacks_collection_method jstack stacks_collection_method false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Oozie Server Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Server Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Oozie Server Advanced Configuration Snippet (Safety Valve) for oozie-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Server Advanced Configuration Snippet (Safety Valve) for oozie-site.xml parameter. false role_config_suppression_oozie_config_safety_valve true
Suppress Parameter Validation: Oozie Server Data Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Server Data Directory parameter. false role_config_suppression_oozie_data_dir true
Suppress Parameter Validation: Oozie Server Database Host Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Server Database Host parameter. false role_config_suppression_oozie_database_host true
Suppress Parameter Validation: Oozie Server Database Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Server Database Name parameter. false role_config_suppression_oozie_database_name true
Suppress Parameter Validation: Oozie Server Database Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Server Database Password parameter. false role_config_suppression_oozie_database_password true
Suppress Parameter Validation: Oozie Server Database User Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Server Database User parameter. false role_config_suppression_oozie_database_user true
Suppress Parameter Validation: Oozie Email Action From Address Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Email Action From Address parameter. false role_config_suppression_oozie_email_from_address true
Suppress Parameter Validation: Oozie Email Action SMTP Host Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Email Action SMTP Host parameter. false role_config_suppression_oozie_email_smtp_host true
Suppress Parameter Validation: Oozie Email Action SMTP Authentication Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Email Action SMTP Authentication Password parameter. false role_config_suppression_oozie_email_smtp_password true
Suppress Parameter Validation: Oozie Email Action SMTP Authentication Username Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Email Action SMTP Authentication Username parameter. false role_config_suppression_oozie_email_smtp_username true
Suppress Parameter Validation: Oozie ActionService Executor Extension Classes Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie ActionService Executor Extension Classes parameter. false role_config_suppression_oozie_executor_extension_classes true
Suppress Parameter Validation: Oozie TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_oozie_https_keystore_file true
Suppress Parameter Validation: Oozie TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie TLS/SSL Server JKS Keystore File Password parameter. false role_config_suppression_oozie_https_keystore_password true
Suppress Parameter Validation: Oozie TLS/SSL Certificate Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie TLS/SSL Certificate Trust Store File parameter. false role_config_suppression_oozie_https_truststore_file true
Suppress Parameter Validation: Oozie TLS/SSL Certificate Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie TLS/SSL Certificate Trust Store Password parameter. false role_config_suppression_oozie_https_truststore_password true
Suppress Parameter Validation: Java Configuration Options for Oozie Server Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Configuration Options for Oozie Server parameter. false role_config_suppression_oozie_java_opts true
Suppress Parameter Validation: Oozie Server Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Server Log Directory parameter. false role_config_suppression_oozie_log_dir true
Suppress Parameter Validation: Oozie Server Plugins Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Server Plugins parameter. false role_config_suppression_oozie_plugins_list true
Suppress Parameter Validation: Oozie Server Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Server Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_oozie_server_role_env_safety_valve true
Suppress Parameter Validation: Oozie SchemaService Workflow Extension Schemas Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie SchemaService Workflow Extension Schemas parameter. false role_config_suppression_oozie_workflow_extension_schemas true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Health Test: Audit Pipeline Test Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_oozie_server_audit_health true
Suppress Health Test: Callable Queue Size Whether to suppress the results of the Callable Queue Size heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_oozie_server_callablequeue_size_health true
Suppress Health Test: File Descriptors Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_oozie_server_file_descriptor true
Suppress Health Test: Heap Dump Directory Free Space Whether to suppress the results of the Heap Dump Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_oozie_server_heap_dump_directory_free_space true
Suppress Health Test: Host Health Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_oozie_server_host_health true
Suppress Health Test: Log Directory Free Space Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_oozie_server_log_directory_free_space true
Suppress Health Test: Pause Duration Whether to suppress the results of the Pause Duration heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_oozie_server_pause_duration true
Suppress Health Test: Process Status Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_oozie_server_scm_health true
Suppress Health Test: Oozie Server Shared Library Check Whether to suppress the results of the Oozie Server Shared Library Check heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_oozie_server_shared_lib_version_health true
Suppress Health Test: Swap Memory Usage Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_oozie_server_swap_memory_usage true
Suppress Health Test: Unexpected Exits Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_oozie_server_unexpected_exits true
Suppress Health Test: Web Server Status Whether to suppress the results of the Web Server Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_oozie_server_web_metric_collection true

Service-Wide

Advanced

Display Name Description Related Name Default Value 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

Database

Display Name Description Related Name Default Value API Name Required
Database Dump File File where the database gets dumped to or loaded from. /tmp/oozie_database_dump.zip database_dump_file false

Monitoring

Display Name Description Related Name Default Value 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 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 causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the followig JSON formatted trigger 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:bad", "streamThreshold": 10, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.		 [] 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 API Name Required
Hive Service Name of the Hive service that this Oozie service instance depends on. This is used to configure Oozie HCat integration. hive_service false
MapReduce Service Service to run MapReduce jobs against mapreduce_yarn_service true
Oozie Event Listeners List of event listeners used by the Oozie service. Listeners needed for JMS or SLA integration are automatically emitted if they are enabled. oozie.service.EventHandlerService.event.listeners oozie_event_listeners false
JMS Broker URL of the JMS Broker used by the Oozie service in JMS integration is enabled. oozie.jms.producer.connection.properties tcp://localhost:61616 oozie_jms_broker false
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
Coordinator Action Input Check Default Timeout Default timeout for a Coordinator Action input check (in minutes) for a Coordinator Job. oozie.service.coord.normal.default.timeout 2 hour(s) oozie_service_coord_normal_default_timeout false
ShareLib Root Directory Root of the directory in HDFS where the Oozie ShareLibs are stored. The libraries are stored in the share/lib subdirectory under the specified root directory. oozie.service.WorkflowAppService.system.libpath /user/oozie oozie_sharelib_rootdir true
Oozie Upload ShareLib Command Timeout The timeout in seconds used for the Oozie Upload ShareLib command. When the value is zero, there is no timeout for the command. 270 oozie_upload_sharelib_cmd_timeout false
Oozie Upload ShareLib Command Concurrency Level The number of threads that Oozie will use for the Upload ShareLib command. 8 oozie_upload_sharelib_concurrency false
Enable JMS Integration Whether to configure Oozie properties needed for JMS integration false oozie_use_jms false
Enable SLA Integration Whether to configure Oozie properties needed for SLA integration false oozie_use_sla 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
Spark on Yarn Service Name of the Spark on Yarn service that this Oozie service instance depends on spark_on_yarn_service 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 API Name Required
Kerberos Principal Kerberos principal short name used by all roles of this service. oozie kerberos_princ_name true
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
Enable TLS/SSL for Oozie Encrypt communication between clients and Oozie using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). false oozie_use_ssl false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Parameter Validation: Database Dump File Whether to suppress configuration warnings produced by the built-in parameter validation for the Database Dump File parameter. false service_config_suppression_database_dump_file true
Suppress Parameter Validation: Kerberos Principal Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Principal parameter. false service_config_suppression_kerberos_princ_name true
Suppress Parameter Validation: Oozie Credential Classes Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Credential Classes parameter. false service_config_suppression_oozie_credential_classes true
Suppress Parameter Validation: Oozie Service Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Service Environment Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_oozie_env_safety_valve true
Suppress Parameter Validation: Oozie Event Listeners Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Event Listeners parameter. false service_config_suppression_oozie_event_listeners true
Suppress Parameter Validation: JMS Broker Whether to suppress configuration warnings produced by the built-in parameter validation for the JMS Broker parameter. false service_config_suppression_oozie_jms_broker true
Suppress Parameter Validation: Oozie Load Balancer Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Load Balancer parameter. false service_config_suppression_oozie_load_balancer true
Suppress Configuration Validator: Oozie Server Count Validator Whether to suppress configuration warnings produced by the Oozie Server Count Validator configuration validator. false service_config_suppression_oozie_server_count_validator true
Suppress Parameter Validation: ShareLib Root Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the ShareLib Root Directory parameter. false service_config_suppression_oozie_sharelib_rootdir true
Suppress Parameter Validation: ZooKeeper Namespace Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper Namespace parameter. false service_config_suppression_oozie_zookeeper_namespace true
Suppress Parameter Validation: System Group Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter. false service_config_suppression_process_groupname true
Suppress Parameter Validation: System User Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter. false service_config_suppression_process_username true
Suppress Parameter Validation: Service Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter. false service_config_suppression_service_triggers true
Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_smon_derived_configs_safety_valve true
Suppress Health Test: Oozie Server Health Whether to suppress the results of the Oozie Server Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false service_health_suppression_oozie_oozie_servers_healthy true