YARN Properties in Cloudera Runtime 7.2.15

Role groups:

Gateway

Advanced

Deploy Directory

Description: The directory where the client configs will be deployed
Related Name
Default Value: /etc/hadoop
API Name: client_config_root_dir
Required: true

Gateway Logging Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into log4j.properties for this role only.
Related Name
Default Value
API Name: log4j_safety_valve
Required: false

MapReduce Client Advanced Configuration Snippet (Safety Valve) for mapred-site.xml

Description: For advanced use only, a string to be inserted into the client configuration for mapred-site.xml.
Related Name
Default Value
API Name: mapreduce_client_config_safety_valve
Required: false

Gateway Client Environment Advanced Configuration Snippet (Safety Valve) for hadoop-env.sh

Description: For advanced use only, key-value pairs (one on each line) to be inserted into the client configuration for hadoop-env.sh
Related Name
Default Value
API Name: mapreduce_client_env_safety_valve
Required: false

Client Java Configuration Options

Description: These are Java command-line arguments. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here.
Related Name
Default Value: -Djava.net.preferIPv4Stack=true
API Name: mapreduce_client_java_opts
Required: false

YARN Client Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: For advanced use only, a string to be inserted into the client configuration for yarn-site.xml.
Related Name
Default Value
API Name: yarn_client_config_safety_valve
Required: false

Compression

Compression Level of Codecs

Description: Compression level for the codec used to compress MapReduce outputs. Default compression is a balance between speed and compression ratio.
Related Name: zlib.compress.level
Default Value: DEFAULT_COMPRESSION
API Name: zlib_compress_level
Required: false

Logs

Gateway Logging Threshold

Description: The minimum log level for Gateway logs
Related Name
Default Value: INFO
API Name: log_threshold
Required: false

Monitoring

Enable Log Event Capture

Description: When set, each role identifies important log events and forwards them to Cloudera Manager.
Related Name
Default Value: true
API Name: catch_events
Required: false

Enable Configuration Change Alerts

Description: When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value: false
API Name: enable_config_alerts
Required: false

Other

Alternatives Priority

Description: The priority level that the client configuration will have in the Alternatives system on the hosts. Higher priority levels will cause Alternatives to prefer this configuration over any others.
Related Name
Default Value: 92
API Name: client_config_priority
Required: true

Client Failover Sleep Base Time

Description: Base sleep time between failover attempts. Used only if RM HA is enabled.
Related Name: yarn.client.failover-sleep-base-ms
Default Value: 100 millisecond(s)
API Name: client_failover_sleep_base
Required: false

Client Failover Sleep Max Time

Description: Maximum sleep time between failover attempts. Used only if RM HA is enabled.
Related Name: yarn.client.failover-sleep-max-ms
Default Value: 2 second(s)
API Name: client_failover_sleep_max
Required: false

Running Job History Location

Description: Location to store the job history files of running jobs. This is a path on the host where the JobTracker is running.
Related Name: hadoop.job.history.location
Default Value: /var/log/hadoop-mapreduce/history
API Name: hadoop_job_history_dir
Required: false

SequenceFile I/O Buffer Size

Description: Size of buffer for read and write operations of SequenceFiles.
Related Name: io.file.buffer.size
Default Value: 64 KiB
API Name: io_file_buffer_size
Required: false

I/O Sort Factor

Description: The number of streams to merge at the same time while sorting files. That is, the number of sort heads to use during the merge sort on the reducer side. This determines the number of open file handles. Merging more files in parallel reduces merge sort iterations and improves run time by eliminating disk I/O. Note that merging more files in parallel uses more memory. If 'io.sort.factor' is set too high or the maximum JVM heap is set too low, excessive garbage collection will occur. The Hadoop default is 10, but Cloudera recommends a higher value. Will be part of generated client configuration.
Related Name: mapreduce.task.io.sort.factor
Default Value: 64
API Name: io_sort_factor
Required: false

I/O Sort Memory Buffer (MiB)

Description: The total amount of memory buffer, in megabytes, to use while sorting files. Note that this memory comes out of the user JVM heap size (meaning total user JVM heap - this amount of memory = total user usable heap space. Note that Cloudera's default differs from Hadoop's default; Cloudera uses a bigger buffer by default because modern machines often have more RAM. The smallest value across all TaskTrackers will be part of generated client configuration.
Related Name: mapreduce.task.io.sort.mb
Default Value: 256 MiB
API Name: io_sort_mb
Required: false

I/O Sort Spill Percent

Description: The soft limit in either the buffer or record collection buffers. When this limit is reached, a thread will begin to spill the contents to disk in the background. Note that this does not imply any chunking of data to the spill. A value less than 0.5 is not recommended. The syntax is in decimal units; the default is 80% and is formatted 0.8. Will be part of generated client configuration.
Related Name: mapreduce.map.sort.spill.percent
Default Value: 0.8
API Name: io_sort_spill_percent
Required: false

Use Compression on Map Outputs

Description: If enabled, uses compression on the map outputs before they are sent across the network. Will be part of generated client configuration.
Related Name: mapreduce.map.output.compress
Default Value: true
API Name: mapred_compress_map_output
Required: false

Compression Codec of MapReduce Map Output

Description: For MapReduce map outputs that are compressed, specify the compression codec to use. Will be part of generated client configuration.
Related Name: mapreduce.map.output.compress.codec
Default Value: org.apache.hadoop.io.compress.SnappyCodec
API Name: mapred_map_output_compression_codec
Required: false

Map Tasks Speculative Execution

Description: If enabled, multiple instances of some map tasks may be executed in parallel.
Related Name: mapreduce.map.speculative
Default Value: false
API Name: mapred_map_tasks_speculative_execution
Required: false

Compress MapReduce Job Output

Description: Compress the output of MapReduce jobs. Will be part of generated client configuration.
Related Name: mapreduce.output.fileoutputformat.compress
Default Value: false
API Name: mapred_output_compress
Required: false

Compression Codec of MapReduce Job Output

Description: For MapReduce job outputs that are compressed, specify the compression codec to use. Will be part of generated client configuration.
Related Name: mapreduce.output.fileoutputformat.compress.codec
Default Value: org.apache.hadoop.io.compress.DefaultCodec
API Name: mapred_output_compression_codec
Required: false

Compression Type of MapReduce Job Output

Description: For MapReduce job outputs that are compressed as SequenceFiles, you can select one of these compression type options: NONE, RECORD or BLOCK. Cloudera recommends BLOCK. Will be part of generated client configuration.
Related Name: mapreduce.output.fileoutputformat.compress.type
Default Value: BLOCK
API Name: mapred_output_compression_type
Required: false

Default Number of Parallel Transfers During Shuffle

Description: The default number of parallel transfers run by reduce during the copy (shuffle) phase. This number is calculated by the following formula: min(number_of_nodes, n * min(number_of_cores_per_node, number_of_spindles_per_node)) where the n represents how many streams you want to run per core/spindle. A value of 10 for n is appropriate in most cases. Will be part of generated client configuration.
Related Name: mapreduce.reduce.shuffle.parallelcopies
Default Value: 10
API Name: mapred_reduce_parallel_copies
Required: false

Number of Map Tasks to Complete Before Reduce Tasks

Description: Fraction of the number of map tasks in the job which should be completed before reduce tasks are scheduled for the job.
Related Name: mapreduce.job.reduce.slowstart.completedmaps
Default Value: 0.8
API Name: mapred_reduce_slowstart_completed_maps
Required: false

Default Number of Reduce Tasks per Job

Description: The default number of reduce tasks per job. Will be part of generated client configuration.
Related Name: mapreduce.job.reduces
Default Value: 1
API Name: mapred_reduce_tasks
Required: false

Reduce Tasks Speculative Execution

Description: If enabled, multiple instances of some reduce tasks may be executed in parallel.
Related Name: mapreduce.reduce.speculative
Default Value: false
API Name: mapred_reduce_tasks_speculative_execution
Required: false

Mapreduce Submit Replication

Description: The replication level for submitted job files.
Related Name: mapreduce.client.submit.file.replication
Default Value: 10
API Name: mapred_submit_replication
Required: false

Mapreduce Task Timeout

Description: The number of milliseconds before a task will be terminated if it neither reads an input, writes an output, nor updates its status string.
Related Name: mapreduce.task.timeout
Default Value: 10 minute(s)
API Name: mapred_task_timeout
Required: false

MR Application Environment

Description: Additional execution environment entries for map and reduce task processes.
Related Name: mapreduce.admin.user.env
Default Value: LD_LIBRARY_PATH=$HADOOP_COMMON_HOME/lib/native:$JAVA_LIBRARY_PATH
API Name: mapreduce_admin_user_env
Required: false

Maximum Number of Attempts for MapReduce Jobs

Description: The maximum number of application attempts for MapReduce jobs. The value of this parameter overrides ApplicationMaster Maximum Attempts for MapReduce jobs.
Related Name: mapreduce.am.max-attempts
Default Value: 2
API Name: mapreduce_am_max_attempts
Required: false

MR Application Classpath

Description: Classpaths to include for MapReduce applications. During evaluation, the string '{version}' in the value of this parameter will be replaced by the actual MapReduce version.
Related Name: mapreduce.application.classpath
Default Value: $HADOOP_CLIENT_CONF_DIR $PWD/mr-framework/* $MR2_CLASSPATH
API Name: mapreduce_application_classpath
Required: false

MR Application Framework Path

Description: Path for MapReduce application framework. During evaluation, the string '{version}' in the value of this parameter will be replaced by the actual MapReduce version.
Related Name: mapreduce.application.framework.path
Default Value: /user/yarn/mapreduce/mr-framework/version-mr-framework.tar.gz#mr-framework
API Name: mapreduce_application_framework_path
Required: false

Application Framework

Description: The application framework to run jobs with. If not set, jobs will be run with the local job runner.
Related Name: mapreduce.framework.name
Default Value: yarn
API Name: mapreduce_framework_name
Required: false

ACL For Modifying A Job

Description: Specifies a list of users and/or groups that are allowed to modify job operations. For specifying a list of users and groups the format to use is "user1,user2 group1,group". If set to '*', it allows all users/groups to modify this job. If set to ' '(i.e. space), it allows none. Irrespective of this ACL configuration, (a) job-owner, (b) the user who started the cluster, (c) members of an admin configured supergroup configured via mapreduce.cluster.permissions.supergroup and (d) queue administrators of the queue to which this job was submitted to configured via acl-administer-jobs for the specific queue in mapred-queues.xml can do all the modification operations on a job. Ignored unless mapreduce.clouster.acls.enabled is true.
Related Name: mapreduce.job.acl-modify-job
Default Value
API Name: mapreduce_job_acl_modify_job
Required: false

ACL For Viewing A Job

Description: Specifies a list of users and/or groups that are allowed to view private job details. For specifying a list of users and groups the format to use is "user1,user2 group1,group". If set to '*', it allows all users/groups to modify this job. If set to ' '(i.e. space), it allows none. Irrespective of this ACL configuration, (a) job-owner, (b) the user who started the cluster, (c) members of an admin configured supergroup configured via mapreduce.cluster.permissions.supergroup and (d) queue administrators of the queue to which this job was submitted to configured via acl-administer-jobs for the specific queue in mapred-queues.xml can do all the view operations on a job. Ignored unless mapreduce.cluster.acls.enabled is true.
Related Name: mapreduce.job.acl-view-job
Default Value
API Name: mapreduce_job_acl_view_job
Required: false

Redacted MapReduce Job Properties

Description: A comma-separated list of job properties to redact in MapReduce.
Related Name: mapreduce.job.redacted-properties
Default Value: fs.s3a.access.key fs.s3a.secret.key fs.adl.oauth2.credential dfs.adls.oauth2.credential fs.azure.account.oauth2.client.secret
API Name: mapreduce_job_redacted_properties
Required: false

JobTracker MetaInfo Maxsize

Description: The maximum permissible size of the split metainfo file. The JobTracker won't attempt to read split metainfo files bigger than the configured value. No limits if set to -1.
Related Name: mapreduce.job.split.metainfo.maxsize
Default Value: 10000000
API Name: mapreduce_jobtracker_split_metainfo_maxsize
Required: false

Map Task Java Opts Base

Description: Java opts for the map processes. The following symbol, if present, will be interpolated: @taskid@ is replaced by current TaskID. Any other occurrences of '@' will go unchanged. For example, to enable verbose gc logging to a file named for the taskid in /tmp pass a value of: "-verbose:gc -Xloggc:/tmp/@taskid@.gc". The configuration variable 'Map Task Memory' can be used to control the maximum memory of the map processes.
Related Name: mapreduce.map.java.opts
Default Value: -Djava.net.preferIPv4Stack=true
API Name: mapreduce_map_java_opts
Required: false

Reduce Task Java Opts Base

Description: Java opts for the reduce processes. The following symbol, if present, will be interpolated: @taskid@ is replaced by current TaskID. Any other occurrences of '@' will go unchanged. For example, to enable verbose gc logging to a file named for the taskid in /tmp pass a value of: "-verbose:gc -Xloggc:/tmp/@taskid@.gc". The configuration variable 'Reduce Task Memory' can be used to control the maximum memory of the reduce processes.
Related Name: mapreduce.reduce.java.opts
Default Value: -Djava.net.preferIPv4Stack=true
API Name: mapreduce_reduce_java_opts
Required: false

ApplicationMaster Environment

Description: Environment variables for the MapReduce ApplicationMaster. These settings can be overridden in the ApplicationMaster User Environment (yarn.app.mapreduce.am.env).
Related Name: yarn.app.mapreduce.am.admin.user.env
Default Value: LD_LIBRARY_PATH=$HADOOP_COMMON_HOME/lib/native:$JAVA_LIBRARY_PATH
API Name: yarn_app_mapreduce_am_admin_user_env
Required: false

ApplicationMaster Java Opts Base

Description: Java command line arguments passed to the MapReduce ApplicationMaster.
Related Name: yarn.app.mapreduce.am.command-opts
Default Value: -Djava.net.preferIPv4Stack=true
API Name: yarn_app_mapreduce_am_command_opts
Required: false

Performance

JHist File Format

Description: File format the AM will use when generating the .jhist file. Valid values are "json" for text output and "binary" for faster parsing.
Related Name: mapreduce.jobhistory.jhist.format
Default Value: binary
API Name: mapred_jobhistory_jhist_format
Required: false

Enable Optimized Map-side Output Collector

Description: Whether map tasks should attempt to use the optimized native implementation of the map-side output collector. This can improve performance of many jobs that are shuffle-intensive. Experimental in CDH 5.2.
Related Name
Default Value: false
API Name: mapreduce_enable_native_map_output_collector
Required: false

Job Counter Groups Limit

Description: Limit on the number of counter groups allowed per job.
Related Name: mapreduce.job.counters.groups.max
Default Value: 50
API Name: mapreduce_job_counter_groups_limit
Required: false

Job Counters Limit

Description: Limit on the number of counters allowed per job.
Related Name: mapreduce.job.counters.max
Default Value: 120
API Name: mapreduce_job_counters_limit
Required: false

Enable Ubertask Optimization

Description: Whether to enable ubertask optimization, which runs "sufficiently small" jobs sequentially within a single JVM. "Small" is defined by the mapreduce.job.ubertask.maxmaps, mapreduce.job.ubertask.maxreduces, and mapreduce.job.ubertask.maxbytes settings.
Related Name: mapreduce.job.ubertask.enable
Default Value: false
API Name: mapreduce_job_ubertask_enabled
Required: false

Ubertask Maximum Job Size

Description: Threshold for number of input bytes, beyond which a job is considered too big for ubertask optimization. If no value is specified, dfs.block.size is used as a default.
Related Name: mapreduce.job.ubertask.maxbytes
Default Value
API Name: mapreduce_job_ubertask_maxbytes
Required: false

Ubertask Maximum Maps

Description: Threshold for number of maps, beyond which a job is considered too big for ubertask optimization.
Related Name: mapreduce.job.ubertask.maxmaps
Default Value: 9
API Name: mapreduce_job_ubertask_maxmaps
Required: false

Ubertask Maximum Reduces

Description: Threshold for number of reduces, beyond which a job is considered too big for ubertask optimization. Note: As of CDH 5, MR2 does not support more than one reduce in an ubertask. (Zero is valid.)
Related Name: mapreduce.job.ubertask.maxreduces
Default Value: 1
API Name: mapreduce_job_ubertask_maxreduces
Required: false

Resource Management

Client Java Heap Size in Bytes

Description: Maximum size in bytes for the Java process heap memory. Passed to Java -Xmx.
Related Name
Default Value: 825955249 B
API Name: mapreduce_client_java_heapsize
Required: false

Heap to Container Size Ratio

Description: The ratio of heap size to container size for both map and reduce tasks. The heap should be smaller than the container size to allow for some overhead of the JVM.
Related Name: mapreduce.job.heap.memory-mb.ratio
Default Value: 0.8
API Name: mapreduce_job_heap_memory_mb_ratio
Required: false

Map Task CPU Virtual Cores

Description: The number of virtual CPU cores allocated for each map task of a job. This parameter has no effect prior to CDH 4.4.
Related Name: mapreduce.map.cpu.vcores
Default Value: 1
API Name: mapreduce_map_cpu_vcores
Required: false

Map Task Maximum Heap Size

Description: The maximum Java heap size, in bytes, of the map processes. This number will be formatted and concatenated with 'Map Task Java Opts Base' to pass to Hadoop.
Related Name
Default Value: 0 B
API Name: mapreduce_map_java_opts_max_heap
Required: false

Map Task Memory

Description: The amount of physical memory, in MiB, allocated for each map task of a job. For versions before CDH 5.5, if not specified, by default it is set to 1024. For CDH 5.5 and higher, a value less than 128 is not supported but if it is specified as 0, the amount of physical memory to request is inferred from Map Task Maximum Heap Size and Heap to Container Size Ratio. If Map Task Maximum Heap Size is not specified, by default the amount of physical memory to request is set to 1024.
Related Name: mapreduce.map.memory.mb
Default Value: 0 B
API Name: mapreduce_map_memory_mb
Required: false

Reduce Task CPU Virtual Cores

Description: The number of virtual CPU cores for each reduce task of a job.
Related Name: mapreduce.reduce.cpu.vcores
Default Value: 1
API Name: mapreduce_reduce_cpu_vcores
Required: false

Reduce Task Maximum Heap Size

Description: The maximum Java heap size, in bytes, of the reduce processes. This number will be formatted and concatenated with 'Reduce Task Java Opts Base' to pass to Hadoop.
Related Name
Default Value: 0 B
API Name: mapreduce_reduce_java_opts_max_heap
Required: false

Reduce Task Memory

Description: The amount of physical memory, in MiB, allocated for each reduce task of a job. For versions before CDH 5.5, if not specified, by default it is set to 1024. For CDH 5.5 and higher, a value less than 128 is not supported but if it is specified as 0, the amount of physical memory to request is inferred from Reduce Task Maximum Heap Size and Heap to Container Size Ratio. If Reduce Task Maximum Heap Size is not specified, by default the amount of physical memory to request is set to 1024. This parameter has no effect prior to CDH 4.4.
Related Name: mapreduce.reduce.memory.mb
Default Value: 0 B
API Name: mapreduce_reduce_memory_mb
Required: false

ApplicationMaster Java Maximum Heap Size

Description: The maximum heap size, in bytes, of the Java MapReduce ApplicationMaster. This number will be formatted and concatenated with 'ApplicationMaster Java Opts Base' to pass to Hadoop.
Related Name
Default Value: 825955249 B
API Name: yarn_app_mapreduce_am_max_heap
Required: false

ApplicationMaster Virtual CPU Cores

Description: The virtual CPU cores requirement, for the ApplicationMaster. This parameter has no effect prior to CDH 4.4.
Related Name: yarn.app.mapreduce.am.resource.cpu-vcores
Default Value: 1
API Name: yarn_app_mapreduce_am_resource_cpu_vcores
Required: false

ApplicationMaster Memory

Description: The physical memory requirement, in MiB, for the ApplicationMaster.
Related Name: yarn.app.mapreduce.am.resource.mb
Default Value: 1 GiB
API Name: yarn_app_mapreduce_am_resource_mb
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Deploy Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Deploy Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_client_config_root_dir
Required: true

Suppress Parameter Validation: Running Job History Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Running Job History Location parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hadoop_job_history_dir
Required: true

Suppress Parameter Validation: I/O Sort Factor

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the I/O Sort Factor parameter.
Related Name
Default Value: false
API Name: role_config_suppression_io_sort_factor
Required: true

Suppress Parameter Validation: Gateway Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway Logging Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Parameter Validation: Compression Codec of MapReduce Map Output

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Compression Codec of MapReduce Map Output parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapred_map_output_compression_codec
Required: true

Suppress Parameter Validation: Compression Codec of MapReduce Job Output

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Compression Codec of MapReduce Job Output parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapred_output_compression_codec
Required: true

Suppress Parameter Validation: MR Application Environment

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the MR Application Environment parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_admin_user_env
Required: true

Suppress Parameter Validation: Maximum Number of Attempts for MapReduce Jobs

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Maximum Number of Attempts for MapReduce Jobs parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_am_max_attempts
Required: true

Suppress Parameter Validation: MR Application Classpath

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the MR Application Classpath parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_application_classpath
Required: true

Suppress Parameter Validation: MR Application Framework Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the MR Application Framework Path parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_application_framework_path
Required: true

Suppress Parameter Validation: MapReduce Client Advanced Configuration Snippet (Safety Valve) for mapred-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the MapReduce Client Advanced Configuration Snippet (Safety Valve) for mapred-site.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_client_config_safety_valve
Required: true

Suppress Parameter Validation: Gateway Client Environment Advanced Configuration Snippet (Safety Valve) for hadoop-env.sh

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway Client Environment Advanced Configuration Snippet (Safety Valve) for hadoop-env.sh parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_client_env_safety_valve
Required: true

Suppress Parameter Validation: Client Java Configuration Options

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Client Java Configuration Options parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_client_java_opts
Required: true

Suppress Parameter Validation: ACL For Modifying A Job

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ACL For Modifying A Job parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_job_acl_modify_job
Required: true

Suppress Parameter Validation: ACL For Viewing A Job

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ACL For Viewing A Job parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_job_acl_view_job
Required: true

Suppress Parameter Validation: Redacted MapReduce Job Properties

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Redacted MapReduce Job Properties parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_job_redacted_properties
Required: true

Suppress Parameter Validation: Map Task Java Opts Base

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Map Task Java Opts Base parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_map_java_opts
Required: true

Suppress Configuration Validator: Map Task Maximum Heap Size Validator

Description: Whether to suppress configuration warnings produced by the Map Task Maximum Heap Size Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_map_java_opts_max_heap_mapreduce_map_memory_mb_validator
Required: true

Suppress Parameter Validation: Reduce Task Java Opts Base

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Reduce Task Java Opts Base parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_reduce_java_opts
Required: true

Suppress Configuration Validator: Reduce Task Maximum Heap Size Validator

Description: Whether to suppress configuration warnings produced by the Reduce Task Maximum Heap Size Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_reduce_java_opts_max_heap_mapreduce_reduce_memory_mb_validator
Required: true

Suppress Configuration Validator: Job Submit Replication Validator

Description: Whether to suppress configuration warnings produced by the Job Submit Replication Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_replication_validator
Required: true

Suppress Parameter Validation: ApplicationMaster Environment

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ApplicationMaster Environment parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_app_mapreduce_am_admin_user_env
Required: true

Suppress Parameter Validation: ApplicationMaster Java Opts Base

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ApplicationMaster Java Opts Base parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_app_mapreduce_am_command_opts
Required: true

Suppress Configuration Validator: ApplicationMaster Java Maximum Heap Size Validator

Description: Whether to suppress configuration warnings produced by the ApplicationMaster Java Maximum Heap Size Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_app_mapreduce_am_max_heap_yarn_app_mapreduce_am_resource_mb_validator
Required: true

Suppress Parameter Validation: YARN Client Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Client Advanced Configuration Snippet (Safety Valve) for yarn-site.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_client_config_safety_valve
Required: true

JobHistory Server

Advanced

Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve)

Description: Advanced Configuration Snippet (Safety Valve) for Hadoop Metrics2. Properties will be inserted into hadoop-metrics2.properties.
Related Name
Default Value
API Name: hadoop_metrics2_safety_valve
Required: false

System Group

Description: The group that the JobHistory Server process should run as.
Related Name
Default Value: hadoop
API Name: history_process_groupname
Required: true

System User

Description: The user that the JobHistory Server process should run as.
Related Name
Default Value: mapred
API Name: history_process_username
Required: true

JobHistory Server Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: For advanced use only. A string to be inserted into yarn-site.xml for this role only.
Related Name
Default Value
API Name: jobhistory_config_safety_valve
Required: false

JobHistory Server Advanced Configuration Snippet (Safety Valve) for mapred-site.xml

Description: For advanced use only. A string to be inserted into mapred-site.xml for this role only.
Related Name
Default Value
API Name: jobhistory_mapred_safety_valve
Required: false

JobHistory Server Environment Advanced Configuration Snippet (Safety Valve)

Description: 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.
Related Name
Default Value
API Name: JOBHISTORY_role_env_safety_valve
Required: false

JobHistory Server Logging Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into log4j.properties for this role only.
Related Name
Default Value
API Name: log4j_safety_valve
Required: false

Enable auto refresh for metric configurations

Description: When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value: false
API Name: metric_config_auto_refresh
Required: false

Java Configuration Options for JobHistory Server

Description: 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. Note: When CM version is 6.3.0 or greater, {{JAVA_GC_ARGS}} will be replaced by JVM Garbage Collection arguments based on the runtime Java JVM version.
Related Name
Default Value: JAVA_GC_ARGS -Dlibrary.leveldbjni.path=CMF_CONF_DIR
API Name: mr2_jobhistory_java_opts
Required: false

Heap Dump Directory

Description: 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, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. 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.
Related Name: oom_heap_dump_dir
Default Value: /tmp
API Name: oom_heap_dump_dir
Required: false

Dump Heap When Out of Memory

Description: When set, generates a heap dump file when when an out-of-memory error occurs.
Related Name
Default Value: true
API Name: oom_heap_dump_enabled
Required: true

Kill When Out of Memory

Description: When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value: true
API Name: oom_sigkill_enabled
Required: true

Automatically Restart Process

Description: When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
Related Name
Default Value: false
API Name: process_auto_restart
Required: true

Enable Metric Collection

Description: 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.
Related Name
Default Value: true
API Name: process_should_monitor
Required: true

Process Start Retry Attempts

Description: Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
Related Name
Default Value: 3
API Name: process_start_retries
Required: false

Process Start Wait Timeout

Description: The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
Related Name
Default Value: 20
API Name: process_start_secs
Required: false

Logs

JobHistory Server Logging Threshold

Description: The minimum log level for JobHistory Server logs
Related Name
Default Value: INFO
API Name: log_threshold
Required: false

JobHistory Server Maximum Log File Backups

Description: The maximum number of rolled log files to keep for JobHistory Server logs. Typically used by log4j or logback.
Related Name
Default Value: 10
API Name: max_log_backup_index
Required: false

JobHistory Server Max Log Size

Description: The maximum size, in megabytes, per log file for JobHistory Server logs. Typically used by log4j or logback.
Related Name
Default Value: 200 MiB
API Name: max_log_size
Required: false

JobHistory Server Log Directory

Description: Directory where JobHistory Server will place its log files.
Related Name: hadoop.log.dir
Default Value: /var/log/hadoop-mapreduce
API Name: mr2_jobhistory_log_dir
Required: false

Monitoring

Enable Health Alerts for this Role

Description: 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
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

Description: When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value: false
API Name: enable_config_alerts
Required: false

Heap Dump Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: heap_dump_directory_free_space_absolute_thresholds
Required: false

Heap Dump Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: heap_dump_directory_free_space_percentage_thresholds
Required: false

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: jobhistory_fd_thresholds
Required: false

Garbage Collection Duration Thresholds

Description: The health test thresholds for the weighted average time spent in Java garbage collection. Specified as a percentage of elapsed wall clock time.
Related Name
Default Value: Warning: 30.0, Critical: 60.0
API Name: jobhistory_gc_duration_thresholds
Required: false

Garbage Collection Duration Monitoring Period

Description: The period to review when computing the moving average of garbage collection time.
Related Name
Default Value: 5 minute(s)
API Name: jobhistory_gc_duration_window
Required: false

JobHistory Server Host Health Test

Description: When computing the overall JobHistory Server health, consider the host's health.
Related Name
Default Value: true
API Name: jobhistory_host_health_enabled
Required: false

JobHistory Server Process Health Test

Description: Enables the health test that the JobHistory Server's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: jobhistory_scm_health_enabled
Required: false

Web Metric Collection

Description: Enables the health test that the Cloudera Manager Agent can successfully contact and gather metrics from the web server.
Related Name
Default Value: true
API Name: jobhistory_web_metric_collection_enabled
Required: false

Web Metric Collection Duration

Description: The health test thresholds on the duration of the metrics request to the web server.
Related Name
Default Value: Warning: 10 second(s), Critical: Never
API Name: jobhistory_web_metric_collection_thresholds
Required: false

Log Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: log_directory_free_space_absolute_thresholds
Required: false

Log Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: log_directory_free_space_percentage_thresholds
Required: false

Rules to Extract Events from Log Files

Description

This file contains the rules that govern how log messages are turned into events by the custom log4j appender that this role loads. It is in JSON format, and is composed of a list of rules. Every log message is evaluated against each of these rules in turn to decide whether or not to send an event for that message. If a log message matches multiple rules, the first matching rule is used.. Each rule has some or all of the following fields:

alert - whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".
rate (mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more than rate matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.
periodminutes - the number of minutes during which the publisher will only publish rate events or fewer. If not specified, the default is one minute
threshold - apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.
content - match only those messages for which contents match this regular expression.
exceptiontype - match only those messages that are part of an exception message. The exception type must match this regular expression.

Example:

{"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}This rule sends events to Cloudera Manager for every StringIndexOutOfBoundsException, up to a maximum of 10 every minute.
{"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.

Related Name

Default Value

version: 0, rules: [ alert: false, rate: 1, periodminutes: 1, threshold: FATAL , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Instead, use .* , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Use .* instead , alert: false, rate: 1, periodminutes: 2, exceptiontype: .* , alert: false, rate: 1, periodminutes: 1, threshold: WARN ]

API Name

log_event_whitelist

Required

false

Metric Filter

Description

Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:

Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
Metric Name - The name of a metric that will be included or excluded during metric collection.

If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:

Include only Health Test Metric Set: Selected.
Include/Exclude Custom Metrics: Set to Include.
Metric Name: jvm_heap_used_mb

You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:

{
  "includeHealthTestMetricSet": true, 
  "filterType": "whitelist",
  "metrics": ["jvm_heap_used_mb"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

Swap Memory Usage Rate Thresholds

Description: The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_swap_memory_rate_thresholds
Required: false

Swap Memory Usage Rate Window

Description: The period to review when computing unexpected swap memory usage change of the process.
Related Name: common.process.swap_memory_rate_window
Default Value: 5 minute(s)
API Name: process_swap_memory_rate_window
Required: false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

Role Triggers

Description

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.

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: unexpected_exits_thresholds
Required: false

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Related Name
Default Value: 5 minute(s)
API Name: unexpected_exits_window
Required: false

Other

Enable Job ACL

Description: Specifies whether ACLs should be checked for authorization when users perform various operations. If enabled, access control checks are made by MapReduce when requests are made by users for queue operations and job operations. Queue operations include submitting job to a queue or killing a job in the queue. Job operations include viewing the job-details (See mapreduce.job.acl-view-job), or modifying a job (See mapreduce.job.acl-modify-job).
Related Name: mapreduce.cluster.acls.enabled
Default Value: false
API Name: mapreduce_cluster_acls_enabled
Required: false

Job History Files Cleaner Interval

Description: Time interval for history cleaner to check for files to delete. Files are only deleted if they are older than mapreduce.jobhistory.max-age-ms.
Related Name: mapreduce.jobhistory.cleaner.interval
Default Value: 1 day(s)
API Name: mapreduce_jobhistory_cleaner_interval
Required: false

Job History Files Maximum Age

Description: Job history files older than this time duration will deleted when the history cleaner runs.
Related Name: mapreduce.jobhistory.max-age-ms
Default Value: 7 day(s)
API Name: mapreduce_jobhistory_max_age_ms
Required: false

Max Shuffle Connections

Description: Maximum allowed connections for the shuffle. Set to 0 (zero) to indicate no limit on the number of connections.
Related Name: mapreduce.jobhistory.loadedjob.tasks.max
Default Value: -1
API Name: mapreduce_shuffle_max_connections
Required: false

MapReduce ApplicationMaster Staging Root Directory

Description: The root HDFS directory of the staging area for users' MR2 jobs; for example /user. The staging directories are always named after the user.
Related Name: yarn.app.mapreduce.am.staging-dir
Default Value: /user
API Name: yarn_app_mapreduce_am_staging_dir
Required: false

Performance

Maximum Process File Descriptors

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

Ports and Addresses

MapReduce JobHistory Server Port

Description: The port of the MapReduce JobHistory Server. Together with the hostname of the JobHistory role, forms the address.
Related Name: mapreduce.jobhistory.address
Default Value: 10020
API Name: mapreduce_jobhistory_address
Required: false

MapReduce JobHistory Server Admin Interface Port

Description: The port of the MapReduce JobHistory Server administrative interface. Together with the host name of the JobHistory role forms the address.
Related Name: mapreduce.jobhistory.admin.address
Default Value: 10033
API Name: mapreduce_jobhistory_admin_address
Required: false

MapReduce JobHistory Web Application HTTP Port

Description: The HTTP port of the MapReduce JobHistory Server web application. Together with the host name of the JobHistory role forms the address.
Related Name: mapreduce.jobhistory.webapp.address
Default Value: 19888
API Name: mapreduce_jobhistory_webapp_address
Required: false

MapReduce JobHistory Web Application HTTPS Port (TLS/SSL)

Description: The HTTPS port of the MapReduce JobHistory Server web application. Together with the host name of the JobHistory role forms the address.
Related Name: mapreduce.jobhistory.webapp.https.address
Default Value: 19890
API Name: mapreduce_jobhistory_webapp_https_address
Required: false

Bind JobHistory Server to Wildcard Address

Description: If enabled, the JobHistory Server binds to the wildcard address ("0.0.0.0") on all of its ports.
Related Name
Default Value: false
API Name: yarn_jobhistory_bind_wildcard
Required: false

Resource Management

Java Heap Size of JobHistory Server in Bytes

Description: Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx.
Related Name
Default Value: 1 GiB
API Name: mr2_jobhistory_java_heapsize
Required: false

Cgroup CPU Shares

Description: 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.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup I/O Weight

Description: 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.
Related Name: blkio.weight
Default Value: 500
API Name: rm_io_weight
Required: true

Cgroup Memory Hard Limit

Description: 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 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit
Required: true

Cgroup Memory Soft Limit

Description: 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 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit
Required: true

Security

Role-Specific Kerberos Principal

Description: Kerberos principal used by the JobHistory Server roles.
Related Name
Default Value: mapred
API Name: kerberos_role_princ_name
Required: true

Stacks Collection

Stacks Collection Data Retention

Description: The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name: stacks_collection_data_retention
Default Value: 100 MiB
API Name: stacks_collection_data_retention
Required: false

Stacks Collection Directory

Description: The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name: stacks_collection_directory
Default Value
API Name: stacks_collection_directory
Required: false

Stacks Collection Enabled

Description: Whether or not periodic stacks collection is enabled.
Related Name: stacks_collection_enabled
Default Value: false
API Name: stacks_collection_enabled
Required: true

Stacks Collection Frequency

Description: The frequency with which stacks are collected.
Related Name: stacks_collection_frequency
Default Value: 5.0 second(s)
API Name: stacks_collection_frequency
Required: false

Stacks Collection Method

Description: 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.
Related Name: stacks_collection_method
Default Value: jstack
API Name: stacks_collection_method
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hadoop_metrics2_safety_valve
Required: true

Suppress Parameter Validation: System Group

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter.
Related Name
Default Value: false
API Name: role_config_suppression_history_process_groupname
Required: true

Suppress Parameter Validation: System User

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter.
Related Name
Default Value: false
API Name: role_config_suppression_history_process_username
Required: true

Suppress Parameter Validation: JobHistory Server Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JobHistory Server Advanced Configuration Snippet (Safety Valve) for yarn-site.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jobhistory_config_safety_valve
Required: true

Suppress Parameter Validation: JobHistory Server Advanced Configuration Snippet (Safety Valve) for mapred-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JobHistory Server Advanced Configuration Snippet (Safety Valve) for mapred-site.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jobhistory_mapred_safety_valve
Required: true

Suppress Parameter Validation: JobHistory Server Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JobHistory Server Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jobhistory_role_env_safety_valve
Required: true

Suppress Parameter Validation: Role-Specific Kerberos Principal

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role-Specific Kerberos Principal parameter.
Related Name
Default Value: false
API Name: role_config_suppression_kerberos_role_princ_name
Required: true

Suppress Parameter Validation: JobHistory Server Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JobHistory Server Logging Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Parameter Validation: Rules to Extract Events from Log Files

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Rules to Extract Events from Log Files parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log_event_whitelist
Required: true

Suppress Parameter Validation: MapReduce JobHistory Server Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the MapReduce JobHistory Server Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_jobhistory_address
Required: true

Suppress Parameter Validation: MapReduce JobHistory Server Admin Interface Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the MapReduce JobHistory Server Admin Interface Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_jobhistory_admin_address
Required: true

Suppress Parameter Validation: MapReduce JobHistory Web Application HTTP Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the MapReduce JobHistory Web Application HTTP Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_jobhistory_webapp_address
Required: true

Suppress Parameter Validation: MapReduce JobHistory Web Application HTTPS Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the MapReduce JobHistory Web Application HTTPS Port (TLS/SSL) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_jobhistory_webapp_https_address
Required: true

Suppress Parameter Validation: Java Configuration Options for JobHistory Server

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Configuration Options for JobHistory Server parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mr2_jobhistory_java_opts
Required: true

Suppress Parameter Validation: JobHistory Server Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JobHistory Server Log Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mr2_jobhistory_log_dir
Required: true

Suppress Parameter Validation: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: Role Triggers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Parameter Validation: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Parameter Validation: MapReduce ApplicationMaster Staging Root Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the MapReduce ApplicationMaster Staging Root Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_app_mapreduce_am_staging_dir
Required: true

Suppress Health Test: Audit Pipeline Test

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_jobhistory_audit_health
Required: true

Suppress Health Test: File Descriptors

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_jobhistory_file_descriptor
Required: true

Suppress Health Test: GC Duration

Description: Whether to suppress the results of the GC 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.
Related Name
Default Value: false
API Name: role_health_suppression_jobhistory_gc_duration
Required: true

Suppress Health Test: Heap Dump Directory Free Space

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_jobhistory_heap_dump_directory_free_space
Required: true

Suppress Health Test: Host Health

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_jobhistory_host_health
Required: true

Suppress Health Test: Log Directory Free Space

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_jobhistory_log_directory_free_space
Required: true

Suppress Health Test: Process Status

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_jobhistory_scm_health
Required: true

Suppress Health Test: Swap Memory Usage

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_jobhistory_swap_memory_usage
Required: true

Suppress Health Test: Swap Memory Usage Rate Beta

Description: Whether to suppress the results of the Swap Memory Usage Rate Beta 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.
Related Name
Default Value: false
API Name: role_health_suppression_jobhistory_swap_memory_usage_rate
Required: true

Suppress Health Test: Unexpected Exits

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_jobhistory_unexpected_exits
Required: true

Suppress Health Test: Web Server Status

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_jobhistory_web_metric_collection
Required: true

NodeManager

Advanced

Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve)

Description: Advanced Configuration Snippet (Safety Valve) for Hadoop Metrics2. Properties will be inserted into hadoop-metrics2.properties.
Related Name
Default Value
API Name: hadoop_metrics2_safety_valve
Required: false

CGroups Hierarchy

Description: Path (rooted in the cgroups hierarchy on the machine) where to place YARN-managed cgroups.
Related Name: yarn.nodemanager.linux-container-executor.cgroups.hierarchy
Default Value: /hadoop-yarn
API Name: linux_container_executor_cgroups_hierarchy
Required: false

NodeManager Logging Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into log4j.properties for this role only.
Related Name
Default Value
API Name: log4j_safety_valve
Required: false

Healthchecker Script Arguments

Description: Comma-separated list of arguments which are to be passed to node health script when it is being launched.
Related Name: yarn.nodemanager.health-checker.script.opts
Default Value
API Name: mapred_healthchecker_script_args
Required: false

Healthchecker Script Path

Description: Absolute path to the script which is periodically run by the node health monitoring service to determine if the node is healthy or not. If the value of this key is empty or the file does not exist in the location configured here, the node health monitoring service is not started.
Related Name: yarn.nodemanager.health-checker.script.path
Default Value
API Name: mapred_healthchecker_script_path
Required: false

Enable auto refresh for metric configurations

Description: When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value: false
API Name: metric_config_auto_refresh
Required: false

Java Configuration Options for NodeManager

Description: 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. Note: When CM version is 6.3.0 or greater, {{JAVA_GC_ARGS}} will be replaced by JVM Garbage Collection arguments based on the runtime Java JVM version.
Related Name
Default Value: JAVA_GC_ARGS -Dlibrary.leveldbjni.path=CMF_CONF_DIR
API Name: node_manager_java_opts
Required: false

NodeManager Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: For advanced use only. A string to be inserted into yarn-site.xml for this role only.
Related Name
Default Value
API Name: nodemanager_config_safety_valve
Required: false

Enable Container Launch Debug Information

Description: Generate additional logs about container launches for e.g. a copy of the launch script and lists the directory contents of the container work dir also following symlinks to a max-depth of 5.
Related Name: yarn.nodemanager.log-container-debug-info.enabled
Default Value: false
API Name: nodemanager_log_container_debug_info_enabled
Required: false

NodeManager Advanced Configuration Snippet (Safety Valve) for mapred-site.xml

Description: For advanced use only. A string to be inserted into mapred-site.xml for this role only.
Related Name
Default Value
API Name: nodemanager_mapred_safety_valve
Required: false

NodeManager Environment Advanced Configuration Snippet (Safety Valve)

Description: 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.
Related Name
Default Value
API Name: NODEMANAGER_role_env_safety_valve
Required: false

Heap Dump Directory

Description: 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, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. 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.
Related Name: oom_heap_dump_dir
Default Value: /tmp
API Name: oom_heap_dump_dir
Required: false

Dump Heap When Out of Memory

Description: When set, generates a heap dump file when when an out-of-memory error occurs.
Related Name
Default Value: true
API Name: oom_heap_dump_enabled
Required: true

Kill When Out of Memory

Description: When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value: true
API Name: oom_sigkill_enabled
Required: true

Automatically Restart Process

Description: When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
Related Name
Default Value: true
API Name: process_auto_restart
Required: true

Enable Metric Collection

Description: 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.
Related Name
Default Value: true
API Name: process_should_monitor
Required: true

Process Start Retry Attempts

Description: Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
Related Name
Default Value: 3
API Name: process_start_retries
Required: false

Process Start Wait Timeout

Description: The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
Related Name
Default Value: 20
API Name: process_start_secs
Required: false

Localized Dir Deletion Delay

Description: Number of seconds after an application finishes before the NodeManager's DeletionService will delete the application's localized file and log directory. To diagnose YARN application problems, set this property's value large enough (for example, to 600 = 10 minutes) to permit examination of these directories.
Related Name: yarn.nodemanager.delete.debug-delay-sec
Default Value: 0
API Name: yarn_nodemanager_delete_debug_delay_sec
Required: false

Disk Health Checker Disk Utilization Watermark Low Threshold Percentage

Description: The low threshold percentage of disk space used when a bad disk is marked as good. Values can range from 0.0 to 100.0. This applies to yarn.nodemanager.local-dirs and yarn.nodemanager.log-dirs. Note that if its value is more than yarn.nodemanager.disk-health-checker.max-disk-utilization-per-disk-percentage or not set, it will be set to the same value as yarn.nodemanager.disk-health-checker.max-disk-utilization-per-disk-percentage.
Related Name: yarn.nodemanager.disk-health-checker.disk-utilization-watermark-low-per-disk-percentage
Default Value
API Name: yarn_nodemanager_disk_health_checker_disk_utilization_watermark_low_per_disk_percentage
Required: false

Disk Health Checker Frequency

Description: Frequency, in milliseconds, of running disk health checker.
Related Name: yarn.nodemanager.disk-health-checker.interval-ms
Default Value: 2 minute(s)
API Name: yarn_nodemanager_disk_health_checker_interval_ms
Required: false

Dish Health Checker Max Disk Utilization Percent

Description: The maximum percentage of disk space utilization allowed after which a disk is marked as bad. Values can range from 0.0 to 100.0. If the value is greater than or equal to 100, the NodeManager will check for full disk. This applies to local directories and log directories.
Related Name: yarn.nodemanager.disk-health-checker.max-disk-utilization-per-disk-percentage
Default Value: 90.0 %
API Name: yarn_nodemanager_disk_health_checker_max_disk_utilization_per_disk_percentage
Required: false

Disk Health Checker Minimum Health Disk Space

Description: The minimum space that must be available on a disk for it to be used. This applies to local directories and log directories.
Related Name: yarn.nodemanager.disk-health-checker.min-free-space-per-disk-mb
Default Value: 0 B
API Name: yarn_nodemanager_disk_health_checker_min_free_space_per_disk_mb
Required: false

Disk Health Checker Minimum Health Disks Fraction

Description: The minimum fraction of number of disks to be healthy for the NodeManager to launch new containers. This correspond to both local directories and log directories; that is, if there are fewer healthy local directories (or log directories) available, then new containers will not be launched on this node.
Related Name: yarn.nodemanager.disk-health-checker.min-healthy-disks
Default Value: 0.25
API Name: yarn_nodemanager_disk_health_checker_min_healthy_disks
Required: false

Docker on YARN

Enable Docker Containers

Description: Specifies if Docker containers in YARN are enabled.
Related Name
Default Value: false
API Name: docker_on_yarn_enabled
Required: false

Allowed Devices for Docker Containers

Description: Specifies the devices that Docker containers are allowed to mount. By default, no devices are allowed to be mounted.
Related Name: docker.allowed.devices
Default Value
API Name: yarn_docker_allowed_devices
Required: false

Allowed Read-Only Mounts for Docker Containers

Description: Specifies the directories that Docker containers are allowed to mount in read-only mode. NodeManager Local Directories and Cgroups root are always added to this list. Ensure that any additional default read-only mounts are also added here.
Related Name: docker.allowed.ro-mounts
Default Value
API Name: yarn_docker_allowed_ro_mounts
Required: false

Allowed Read-Write Mounts for Docker Containers

Description: Specifies the directories that Docker containers are allowed to mount in read-write mode. NodeManager Local Directories and NodeManager Container Log Directories are always added to this list. Ensure that any additional default read-write mounts are also added here.
Related Name: docker.allowed.rw-mounts
Default Value
API Name: yarn_docker_allowed_rw_mounts
Required: false

Allowed Volume Drivers for Docker Containers

Description: Specifies the volume drivers which are alllowed to be used with Docker. By default, no volume drivers are allowed.
Related Name: docker.allowed.volume-drivers
Default Value
API Name: yarn_docker_allowed_volume_drivers
Required: false

Docker Binary Path

Description: Specifies the path of the binary in the hosts that is used to launch Docker containers. Its default value is /usr/bin/docker.
Related Name: docker.binary
Default Value: /usr/bin/docker
API Name: yarn_docker_binary
Required: false

Enable No-new-privileges Flag for Docker Containers

Description: Specifies if the no-new-privileges flag for docker run is enabled. The no-new-privileges flag ensures that the process or its children processes do not gain any additional privileges. Set to 'true' to enable.
Related Name: docker.no-new-privileges.enabled
Default Value: false
API Name: yarn_docker_no_new_privileges_enabled
Required: false

Trusted Registries for Docker Containers

Description: Specifies the list of trusted docker registries for running trusted docker containers. By default, no registries are defined.
Related Name: docker.trusted.registries
Default Value
API Name: yarn_docker_trusted_registries
Required: false

Allowed Docker Container Networks

Description: Specifies the networks that are allowed for Docker containers. Valid values are determined by Docker networks available from the docker network ls command.
Related Name: yarn.nodemanager.runtime.linux.docker.allowed-container-networks
Default Value: host none bridge
API Name: yarn_nodemanager_runtime_linux_docker_allowed_container_networks
Required: false

Docker Capabilities

Description: Specifies the capabilities assigned to Docker containers when they are launched. The values may not be case-sensitive from a docker perspective, but Cloudera recommends to keep them uppercase.
Related Name: yarn.nodemanager.runtime.linux.docker.capabilities
Default Value: CHOWN, DAC_OVERRIDE, FSETID, FOWNER, MKNOD, NET_RAW, SETGID, SETUID, SETFCAP, SETPCAP, NET_BIND_SERVICE, SYS_CHROOT, KILL, AUDIT_WRITE
API Name: yarn_nodemanager_runtime_linux_docker_capabilities
Required: false

Default Docker Container Network

Description: Specifies which allowed network is used when launching Docker containers but no network is specified in the request. This network must be added to yarn.nodemanager.runtime.linux.docker.allowed-container-networks.
Related Name: yarn.nodemanager.runtime.linux.docker.default-container-network
Default Value: host
API Name: yarn_nodemanager_runtime_linux_docker_default_container_network
Required: false

Default Read-Only Mounts for Docker Containers

Description: A list that specifies the default read-only mounts to be bind-mounted into all Docker containers that use DockerContainerRuntime. NodeManager Local Directories and Cgroups root are always added to this list. Ensure that any additional default read-only mounts are also added to the Allowed Read-Only Mounts list.
Related Name: yarn.nodemanager.runtime.linux.docker.default-ro-mounts
Default Value
API Name: yarn_nodemanager_runtime_linux_docker_default_ro_mounts
Required: false

Default Read-Write Mounts for Docker Containers

Description: A list that specifies the default read-write mounts to be bind-mounted into all Docker containers that use DockerContainerRuntime. NodeManager Local Directories and NodeManager Container Log Directories are always added to this list. Ensure that any additional default read-write mounts are also added to the Allowed Read-Write Mounts list.
Related Name: yarn.nodemanager.runtime.linux.docker.default-rw-mounts
Default Value
API Name: yarn_nodemanager_runtime_linux_docker_default_rw_mounts
Required: false

Default Tempfs Mounts for Docker Containers

Description: Specifies the directories in tmpfs that Docker containers are allowed to mount. By default, no directories are allowed in tmpfs to be mounted.
Related Name: yarn.nodemanager.runtime.linux.docker.default-tmpfs-mounts
Default Value
API Name: yarn_nodemanager_runtime_linux_docker_default_tmpfs_mounts
Required: false

Allow Delayed Removal of Docker Containers

Description: Specifies if Debug Deletion Delay is used for Docker containers. Debug Deletion Delay is useful for troubleshooting Docker container related launch failures. For more information, see yarn.nodemanager.delete.debug-delay-sec.
Related Name: yarn.nodemanager.runtime.linux.docker.delayed-removal.allowed
Default Value: false
API Name: yarn_nodemanager_runtime_linux_docker_delayed_removal_allowed
Required: false

Enable User Remapping for Docker Containers

Description: Specifies if Docker containers can run with the UID (User Identifier) and GID (Group Identifier) of the calling user.
Related Name: yarn.nodemanager.runtime.linux.docker.enable-userremapping.allowed
Default Value: true
API Name: yarn_nodemanager_runtime_linux_docker_enable_userremapping_allowed
Required: false

Allow Using Host PID Namespace for Docker Containers

Description: Specifies if Docker containers are allowed to use the host PID namespace.
Related Name: yarn.nodemanager.runtime.linux.docker.host-pid-namespace.allowed
Default Value: false
API Name: yarn_nodemanager_runtime_linux_docker_host_pid_namespace_allowed
Required: false

ACL for Privileged Docker Containers

Description: A comma-separated list that specifies the users who can request privileged Docker containers if privileged Docker containers are allowed.
Related Name: yarn.nodemanager.runtime.linux.docker.privileged-containers.acl
Default Value
API Name: yarn_nodemanager_runtime_linux_docker_privileged_containers_acl
Required: false

Allow Privileged Docker Containers

Description: Specifies if applications are allowed to run in privileged containers. Privileged containers are granted the complete set of capabilities and are not subject to the limitations imposed by the device cgroup controller. Use with extreme care!
Related Name: yarn.nodemanager.runtime.linux.docker.privileged-containers.allowed
Default Value: false
API Name: yarn_nodemanager_runtime_linux_docker_privileged_containers_allowed
Required: false

User Remapping GID Threshold for Docker Containers

Description: Specifies the minimum GID (Group Identifier) for a remapped user. Users with GIDs lower then this minimum value are not allowed to launch Docker containers when user remapping (yarn.nodemanager.runtime.linux.docker.enable-userremapping.allowed) is enabled.
Related Name: yarn.nodemanager.runtime.linux.docker.userremapping-gid-threshold
Default Value: 1
API Name: yarn_nodemanager_runtime_linux_docker_userremapping_gid_threshold
Required: false

User Remapping UID Threshold for Docker Containers

Description: Specifies the minimum UID (User Identifier) for a remapped user. Users with UIDs lower than this minimum value are not allowed to launch Docker containers when user remapping (yarn.nodemanager.runtime.linux.docker.enable-userremapping.allowed) is enabled.
Related Name: yarn.nodemanager.runtime.linux.docker.userremapping-uid-threshold
Default Value: 1
API Name: yarn_nodemanager_runtime_linux_docker_userremapping_uid_threshold
Required: false

FPGA Management

Enable FPGA Usage

Description: Allows NodeManagers to provide FPGA devices to YARN applications that request them.
Related Name: yarn.nodemanager.fpga_enabled
Default Value: false
API Name: yarn_nodemanager_fpga_enabled
Required: false

FPGA device major number

Description: The major device number of the FPGA card
Related Name: yarn.nodemanager.fpga_major_device_number
Default Value: 238
API Name: yarn_nodemanager_fpga_major_device_number
Required: false

FPGA initializer script

Description: The shell script which sets up the environment for the FPGA device. It is usually a short shell script which sources other scripts and exports environment variables.
Related Name: yarn.nodemanager.fpga_plugin_initializer_script
Default Value
API Name: yarn_nodemanager_fpga_plugin_initializer_script
Required: false

Allowed FPGA devices

Description: Specifies FPGA devices which can be managed by YARN NodeManager (in a comma-separated list). Manually specify FPGA devices if you only want a subset of FPGA devices to be managed by YARN. An FPGA device is identified by the minor device number. An example of manual specification is "0,1" to allow YARN NodeManager to manage FPGA devices with minor numbers 0/1. Default is "auto", which allows all devices.
Related Name: yarn.nodemanager.resource-plugins.fpga.allowed-fpga-devices
Default Value: auto
API Name: yarn_nodemanager_resource_plugins_fpga_allowed_fpga_devices
Required: false

List of available FPGA devices

Description: Specifies the available FPGA devices in a given format: deviceA/N:M,deviceB/X:Y. Example: acl0/243:0,acl1/243:1. The numbers after the "/" character are the device major and minor numbers.
Related Name: yarn.nodemanager.resource-plugins.fpga.available-devices
Default Value
API Name: yarn_nodemanager_resource_plugins_fpga_available_devices
Required: false

Path to FPGA (aocl) tool

Description: Full local path to the Intel "aocl" tool installed on the node.
Related Name: yarn.nodemanager.resource-plugins.fpga.path-to-discovery-executables
Default Value
API Name: yarn_nodemanager_resource_plugins_fpga_path_to_discovery_executables
Required: false

GPU Management

Enable GPU Usage

Description: Allows NodeManagers to provide GPU devices to YARN applications that request them.
Related Name
Default Value: false
API Name: gpu_enabled
Required: false

NodeManager GPU Devices Allowed

Description: Specifies GPU devices which can be managed by YARN NodeManager (comma-separated). Manually specify GPU devices if auto detection of GPU devices failed or you only want a subset of GPU devices to be managed by YARN. A GPU device is identified by the minor device number and index: An example of manual specification is "0:0,1:1,2:2,3:4" to allow YARN NodeManager to manage GPU devices with indices 0/1/2/3 and minor number 0/1/2/4 numbers.
Related Name: yarn.nodemanager.resource-plugins.gpu.allowed-gpu-devices
Default Value: auto
API Name: gpu_plugin_allowed_devices
Required: false

NodeManager GPU Detection Executable

Description: Path to the executable program which YARN runs to get GPU-related information. When this value is empty (default), YARN NodeManager will try to locate the executable itself. An example value is: /usr/local/bin/nvidia-smi
Related Name: yarn.nodemanager.resource-plugins.gpu.path-to-discovery-executables
Default Value
API Name: gpu_plugin_detector_path
Required: false

Log Aggregation

Log Aggregation Policy

Description: Specifies the types of container logs that are uploaded during the log aggregation.
Related Name: yarn.nodemanager.log-aggregation.policy.class
Default Value: org.apache.hadoop.yarn.server.nodemanager.containermanager.logaggregation.AllContainerLogAggregationPolicy
API Name: yarn_nodemanager_log_aggregation_policy_class
Required: false

Log Aggregation Roll Monitoring Interval

Description: Defines how often NodeManagers wake up to upload log files. If this value is 0 or less than 0, the logs are uploaded when the application is completed.
Related Name: yarn.nodemanager.log-aggregation.roll-monitoring-interval-seconds
Default Value: -1 second(s)
API Name: yarn_nodemanager_log_aggregation_roll_monitoring_interval_seconds
Required: false

Minimum Hard Limit for Log Aggregation Roll Monitoring Interval

Description: Defines the hard minimum value for yarn.nodemanager.log-aggregation.roll-monitoring-interval-seconds, if Log Aggregation Roll Monitoring Interval has been set to a positive value.
Related Name: yarn.nodemanager.log-aggregation.roll-monitoring-interval-seconds.min
Default Value: 1 hour(s)
API Name: yarn_nodemanager_log_aggregation_roll_monitoring_interval_seconds_min
Required: false

Remote App Log Directory

Description: Specifies the path of the directory where application logs are stored after an application is completed.
Related Name: yarn.nodemanager.remote-app-log-dir
Default Value: /tmp/logs
API Name: yarn_nodemanager_remote_app_log_dir
Required: false

Remote App Log Directory Suffix

Description: The remote log directory is created at {yarn.nodemanager.remote-app-log-dir}/${user}/{thisParam}
Related Name: yarn.nodemanager.remote-app-log-dir-suffix
Default Value: logs
API Name: yarn_nodemanager_remote_app_log_dir_suffix
Required: false

Logs

NodeManager Logging Threshold

Description: The minimum log level for NodeManager logs
Related Name
Default Value: INFO
API Name: log_threshold
Required: false

NodeManager Maximum Log File Backups

Description: The maximum number of rolled log files to keep for NodeManager logs. Typically used by log4j or logback.
Related Name
Default Value: 10
API Name: max_log_backup_index
Required: false

NodeManager Max Log Size

Description: The maximum size, in megabytes, per log file for NodeManager logs. Typically used by log4j or logback.
Related Name
Default Value: 200 MiB
API Name: max_log_size
Required: false

NodeManager Log Directory

Description: Directory where NodeManager will place its log files.
Related Name: hadoop.log.dir
Default Value: /var/log/hadoop-yarn
API Name: node_manager_log_dir
Required: false

Monitoring

Enable Health Alerts for this Role

Description: 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
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

Description: When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value: false
API Name: enable_config_alerts
Required: false

Heap Dump Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: heap_dump_directory_free_space_absolute_thresholds
Required: false

Heap Dump Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: heap_dump_directory_free_space_percentage_thresholds
Required: false

Log Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: log_directory_free_space_absolute_thresholds
Required: false

Log Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: log_directory_free_space_percentage_thresholds
Required: false

Rules to Extract Events from Log Files

Description

alert - whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".
rate (mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more than rate matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.
periodminutes - the number of minutes during which the publisher will only publish rate events or fewer. If not specified, the default is one minute
threshold - apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.
content - match only those messages for which contents match this regular expression.
exceptiontype - match only those messages that are part of an exception message. The exception type must match this regular expression.

Example:

{"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}This rule sends events to Cloudera Manager for every StringIndexOutOfBoundsException, up to a maximum of 10 every minute.
{"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.

Related Name

Default Value

API Name

log_event_whitelist

Required

false

Metric Filter

Description

Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:

Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
Metric Name - The name of a metric that will be included or excluded during metric collection.

Include only Health Test Metric Set: Selected.
Include/Exclude Custom Metrics: Set to Include.
Metric Name: jvm_heap_used_mb

You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:

{
  "includeHealthTestMetricSet": true, 
  "filterType": "whitelist",
  "metrics": ["jvm_heap_used_mb"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

NodeManager Connectivity Health Check

Description: Enables the health check that verifies the NodeManager is connected to the ResourceManager.
Related Name
Default Value: true
API Name: nodemanager_connectivity_health_enabled
Required: false

NodeManager Connectivity Tolerance at Startup

Description: The amount of time to wait for the NodeManager to fully start up and connect to the ResourceManager before enforcing the connectivity check.
Related Name
Default Value: 3 minute(s)
API Name: nodemanager_connectivity_tolerance_seconds
Required: false

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: nodemanager_fd_thresholds
Required: false

Garbage Collection Duration Thresholds

Description: The health test thresholds for the weighted average time spent in Java garbage collection. Specified as a percentage of elapsed wall clock time.
Related Name
Default Value: Warning: 30.0, Critical: 60.0
API Name: nodemanager_gc_duration_thresholds
Required: false

Garbage Collection Duration Monitoring Period

Description: The period to review when computing the moving average of garbage collection time.
Related Name
Default Value: 5 minute(s)
API Name: nodemanager_gc_duration_window
Required: false

NodeManager Health Checker Health Check

Description: Enables the health check that verifies the NodeManager is seen as healthy by the ResourceManager.
Related Name
Default Value: true
API Name: nodemanager_health_checker_health_enabled
Required: false

NodeManager Host Health Test

Description: When computing the overall NodeManager health, consider the host's health.
Related Name
Default Value: true
API Name: nodemanager_host_health_enabled
Required: false

NodeManager Local Directories Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's NodeManager Local Directories.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: nodemanager_local_data_directories_free_space_absolute_thresholds
Required: false

NodeManager Local Directories Free Space Monitoring Percentage Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's NodeManager Local Directories. Specified as a percentage of the capacity on that filesystem. This setting is not used if a NodeManager Local Directories Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: nodemanager_local_data_directories_free_space_percentage_thresholds
Required: false

NodeManager Container Log Directories Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's NodeManager Container Log Directories.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: nodemanager_log_directories_free_space_absolute_thresholds
Required: false

NodeManager Container Log Directories Free Space Monitoring Percentage Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's NodeManager Container Log Directories. Specified as a percentage of the capacity on that filesystem. This setting is not used if a NodeManager Container Log Directories Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: nodemanager_log_directories_free_space_percentage_thresholds
Required: false

NodeManager Recovery Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's NodeManager Recovery Directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: nodemanager_recovery_directory_free_space_absolute_thresholds
Required: false

NodeManager Recovery Directory Free Space Monitoring Percentage Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's NodeManager Recovery Directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a NodeManager Recovery Directory Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: nodemanager_recovery_directory_free_space_percentage_thresholds
Required: false

NodeManager Process Health Test

Description: Enables the health test that the NodeManager's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: nodemanager_scm_health_enabled
Required: false

Web Metric Collection

Description: Enables the health test that the Cloudera Manager Agent can successfully contact and gather metrics from the web server.
Related Name
Default Value: true
API Name: nodemanager_web_metric_collection_enabled
Required: false

Web Metric Collection Duration

Description: The health test thresholds on the duration of the metrics request to the web server.
Related Name
Default Value: Warning: 10 second(s), Critical: Never
API Name: nodemanager_web_metric_collection_thresholds
Required: false

Swap Memory Usage Rate Thresholds

Description: The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_swap_memory_rate_thresholds
Required: false

Swap Memory Usage Rate Window

Description: The period to review when computing unexpected swap memory usage change of the process.
Related Name: common.process.swap_memory_rate_window
Default Value: 5 minute(s)
API Name: process_swap_memory_rate_window
Required: false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

Role Triggers

Description

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"}]

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: unexpected_exits_thresholds
Required: false

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Related Name
Default Value: 5 minute(s)
API Name: unexpected_exits_window
Required: false

Other

Enable Shuffle Auxiliary Service

Description: If enabled, adds 'org.apache.hadoop.mapred.ShuffleHandler' to the NodeManager auxiliary services. This is required for MapReduce applications.
Related Name
Default Value: true
API Name: mapreduce_aux_service
Required: false

Support for keep-alive connections

Description: Enable support for keep-alive connections. Set to true to support keep-alive connections.
Related Name: mapreduce.shuffle.connection-keep-alive.enable
Default Value: true
API Name: mapreduce_shuffle_connection_keep_alive_enable
Required: false

Max Shuffle Connections

Description: Maximum allowed connections for the shuffle. Set to 0 (zero) to indicate no limit on the number of connections.
Related Name: mapreduce.shuffle.max.connections
Default Value: 0
API Name: mapreduce_shuffle_max_connections
Required: false

Containers Environment Variable

Description: Environment variables that should be forwarded from the NodeManager's environment to the container's.
Related Name: yarn.nodemanager.admin-env
Default Value: MALLOC_ARENA_MAX=$MALLOC_ARENA_MAX
API Name: yarn_nodemanager_admin_env
Required: false

Container Manager Thread Count

Description: Number of threads container manager uses.
Related Name: yarn.nodemanager.container-manager.thread-count
Default Value: 20
API Name: yarn_nodemanager_container_manager_thread_count
Required: false

Cleanup Thread Count

Description: Number of threads used in cleanup.
Related Name: yarn.nodemanager.delete.thread-count
Default Value: 4
API Name: yarn_nodemanager_delete_thread_count
Required: false

Containers Environment Variables Whitelist

Description: Environment variables that containers may override rather than use NodeManager's default.
Related Name: yarn.nodemanager.env-whitelist
Default Value: JAVA_HOME, HADOOP_COMMON_HOME, HADOOP_HDFS_HOME, HADOOP_CLIENT_CONF_DIR, HADOOP_YARN_HOME, HADOOP_MAPRED_HOME, MR2_CLASSPATH, JAVA_LIBRARY_PATH, HADOOP_HOME, PATH, LANG, TZ
API Name: yarn_nodemanager_env_whitelist
Required: false

Heartbeat Interval

Description: Heartbeat interval to ResourceManager
Related Name: yarn.resourcemanager.nodemanagers.heartbeat-interval-ms
Default Value: 1 second(s)
API Name: yarn_nodemanager_heartbeat_interval_ms
Required: false

NodeManager Local Directories

Description: List of directories on the local filesystem where a NodeManager stores intermediate data files.
Related Name: yarn.nodemanager.local-dirs
Default Value
API Name: yarn_nodemanager_local_dirs
Required: true

Localizer Cache Cleanup Interval

Description: Address where the localizer IPC is.
Related Name: yarn.nodemanager.localizer.cache.cleanup.interval-ms
Default Value: 10 minute(s)
API Name: yarn_nodemanager_localizer_cache_cleanup_interval_ms
Required: false

Localizer Cache Target Size

Description: Target size of localizer cache in MB, per local directory.
Related Name: yarn.nodemanager.localizer.cache.target-size-mb
Default Value: 10 GiB
API Name: yarn_nodemanager_localizer_cache_target_size_mb
Required: false

Localizer Client Thread Count

Description: Number of threads to handle localization requests.
Related Name: yarn.nodemanager.localizer.client.thread-count
Default Value: 5
API Name: yarn_nodemanager_localizer_client_thread_count
Required: false

Localizer Fetch Thread Count

Description: Number of threads to use for localization fetching.
Related Name: yarn.nodemanager.localizer.fetch.thread-count
Default Value: 4
API Name: yarn_nodemanager_localizer_fetch_thread_count
Required: false

NodeManager Container Log Directories

Description: List of directories on the local filesystem where a NodeManager stores container log files.
Related Name: yarn.nodemanager.log-dirs
Default Value: /var/log/hadoop-yarn/container
API Name: yarn_nodemanager_log_dirs
Required: true

Log Retain Duration

Description: Time in seconds to retain user logs. Only applicable if log aggregation is disabled.
Related Name: yarn.nodemanager.log.retain-seconds
Default Value: 3 hour(s)
API Name: yarn_nodemanager_log_retain_seconds
Required: false

NodeManager Recovery Directory

Description: The local filesystem directory in which the NodeManager stores state when recovery is enabled. Recovery is enabled by default.
Related Name: yarn.nodemanager.recovery.dir
Default Value: /var/lib/hadoop-yarn/yarn-nm-recovery
API Name: yarn_nodemanager_recovery_dir
Required: false

Enable NodeManager Recovery

Description: When enabled, any applications that were running on the cluster before the NodeManager was restarted or died will be recovered after the NodeManager is restarted. Recovery is enabled by default.
Related Name: yarn.nodemanager.recovery.enabled
Default Value: true
API Name: yarn_nodemanager_recovery_enabled
Required: false

Enable NodeManager Supervision under Recovery

Description: When enabled, the NodeManager running will not try to cleanup containers as it exits with the assumption it will be immediately restarted and recover containers. Supervision is enabled by default.
Related Name: yarn.nodemanager.recovery.supervised
Default Value: true
API Name: yarn_nodemanager_recovery_supervised
Required: false

Allowed Linux Runtimes

Description: Specifies the runtimes that are allowed when LinuxContainerExecutor is used.
Related Name: yarn.nodemanager.runtime.linux.allowed-runtimes
Default Value: default
API Name: yarn_nodemanager_runtime_linux_allowed_runtimes
Required: false

Sleep Delay Before SIGKILL

Description: Specifies the time in milliseconds between sending a SIGTERM and a SIGKILL signal to a running container.
Related Name: yarn.nodemanager.sleep-delay-before-sigkill.ms
Default Value: 10 second(s)
API Name: yarn_nodemanager_sleep_delay_before_sigkill_ms
Required: false

Performance

Max Shuffle Threads

Description: Maximum allowed threads for serving shuffle connections. Set to zero to indicate the default of 2 times the number of available processors.
Related Name: mapreduce.shuffle.max.threads
Default Value: 80
API Name: mapreduce_shuffle_max_threads
Required: false

Maximum Process File Descriptors

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

Ports and Addresses

NodeManager Web Application HTTPS Port (TLS/SSL)

Description: The HTTPS port of the NodeManager web application.
Related Name: yarn.nodemanager.webapp.https.address
Default Value: 8044
API Name: nodemanager_webserver_https_port
Required: false

NodeManager Web Application HTTP Port

Description: The HTTP Port of the NodeManager web application.
Related Name: yarn.nodemanager.webapp.address
Default Value: 8042
API Name: nodemanager_webserver_port
Required: false

NodeManager IPC Address

Description: The address of the NodeManager IPC.
Related Name: yarn.nodemanager.address
Default Value: 8041
API Name: yarn_nodemanager_address
Required: false

Localizer Port

Description: Address where the localizer IPC is.
Related Name: yarn.nodemanager.localizer.address
Default Value: 8040
API Name: yarn_nodemanager_localizer_address
Required: false

Resource Management

Java Heap Size of NodeManager in Bytes

Description: Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx.
Related Name
Default Value: 1 GiB
API Name: node_manager_java_heapsize
Required: false

Cgroup CPU Shares

Description: 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.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup I/O Weight

Description: 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.
Related Name: blkio.weight
Default Value: 500
API Name: rm_io_weight
Required: true

Cgroup Memory Hard Limit

Description: 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 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit
Required: true

Cgroup Memory Soft Limit

Description: 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 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit
Required: true

Strict CGroup Resource Usage

Description: CGroups allows cpu usage limits to be hard or soft. When this setting is true, containers cannot use more CPU usage than allocated even if spare CPU is available. This ensures that containers can only use CPU that they were allocated. When set to false, containers can use spare CPU if available. It should be noted that irrespective of whether set to true or false, at no time can the combined CPU usage of all containers exceed the value specified in Containers CPU Limit Percentage.
Related Name: yarn.nodemanager.linux-container-executor.cgroups.strict-resource-usage
Default Value: false
API Name: yarn_nodemanager_linux_container_executor_cgroups_strict_resource_usage
Required: false

Container Virtual CPU Cores

Description: Number of virtual CPU cores that can be allocated for containers. This parameter has no effect prior to CDH 4.4.
Related Name: yarn.nodemanager.resource.cpu-vcores
Default Value: 8
API Name: yarn_nodemanager_resource_cpu_vcores
Required: true

Container Memory

Description: Amount of physical memory, in MiB, that can be allocated for containers.
Related Name: yarn.nodemanager.resource.memory-mb
Default Value: 8 GiB
API Name: yarn_nodemanager_resource_memory_mb
Required: true

Containers CPU Limit Percentage

Description: Amount of CPU reserved for all the containers on each node.
Related Name: yarn.nodemanager.resource.percentage-physical-cpu-limit
Default Value: 100
API Name: yarn_nodemanager_resource_percentage_physical_cpu_limit
Required: false

Enable Virtual Memory Check

Description: Enforce virtual memory limit on containers, given as a ratio to physical memory.
Related Name: yarn.nodemanager.vmem-check-enabled
Default Value: false
API Name: yarn_nodemanager_vmem_check_enabled
Required: false

Virtual Memory to Physical Memory Ratio

Description: Ratio between virtual memory to physical memory when setting yarn.nodemanager.vmem-check-enabled to true. Container allocations are expressed in terms of physical memory, and virtual memory usage is allowed to exceed this allocation by this ratio. At least 2.1 is suggested to be set.
Related Name: yarn.nodemanager.vmem-pmem-ratio
Default Value: 2.1
API Name: yarn_nodemanager_vmem_pmem_ratio
Required: false

Resource Types

Resource Allocations

Description: Each NodeManager can independently define the resources that are available from that node.
Related Name
Default Value
API Name: resource_allocations
Required: false

Security

Allowed System Users

Description: List of users explicitly whitelisted to be allowed to run containers. Users with IDs lower than the "Minimum User Id" setting may be whitelisted by using this setting.
Related Name: allowed.system.users
Default Value: nobody impala hive llama hbase
API Name: container_executor_allowed_system_users
Required: false

Banned System Users

Description: List of users banned from running containers.
Related Name: banned.users
Default Value: hdfs yarn mapred bin
API Name: container_executor_banned_users
Required: false

Container Executor Group

Description: The system group that owns the container-executor binary. This does not need to be changed unless the ownership of the binary is explicitly changed.
Related Name: yarn.nodemanager.linux-container-executor.group
Default Value: yarn
API Name: container_executor_group
Required: false

Minimum User ID

Description: The minimum Linux user ID allowed. Used to prevent other super users.
Related Name: min.user.id
Default Value: 1000
API Name: container_executor_min_user_id
Required: false

Stacks Collection

Stacks Collection Data Retention

Description: The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name: stacks_collection_data_retention
Default Value: 100 MiB
API Name: stacks_collection_data_retention
Required: false

Stacks Collection Directory

Description: The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name: stacks_collection_directory
Default Value
API Name: stacks_collection_directory
Required: false

Stacks Collection Enabled

Description: Whether or not periodic stacks collection is enabled.
Related Name: stacks_collection_enabled
Default Value: false
API Name: stacks_collection_enabled
Required: true

Stacks Collection Frequency

Description: The frequency with which stacks are collected.
Related Name: stacks_collection_frequency
Default Value: 5.0 second(s)
API Name: stacks_collection_frequency
Required: false

Stacks Collection Method

Description: 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.
Related Name: stacks_collection_method
Default Value: jstack
API Name: stacks_collection_method
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Allowed System Users

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Allowed System Users parameter.
Related Name
Default Value: false
API Name: role_config_suppression_container_executor_allowed_system_users
Required: true

Suppress Parameter Validation: Banned System Users

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Banned System Users parameter.
Related Name
Default Value: false
API Name: role_config_suppression_container_executor_banned_users
Required: true

Suppress Parameter Validation: Container Executor Group

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Container Executor Group parameter.
Related Name
Default Value: false
API Name: role_config_suppression_container_executor_group
Required: true

Suppress Parameter Validation: NodeManager GPU Devices Allowed

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the NodeManager GPU Devices Allowed parameter.
Related Name
Default Value: false
API Name: role_config_suppression_gpu_plugin_allowed_devices
Required: true

Suppress Parameter Validation: NodeManager GPU Detection Executable

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the NodeManager GPU Detection Executable parameter.
Related Name
Default Value: false
API Name: role_config_suppression_gpu_plugin_detector_path
Required: true

Suppress Parameter Validation: Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hadoop_metrics2_safety_valve
Required: true

Suppress Parameter Validation: CGroups Hierarchy

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the CGroups Hierarchy parameter.
Related Name
Default Value: false
API Name: role_config_suppression_linux_container_executor_cgroups_hierarchy
Required: true

Suppress Parameter Validation: NodeManager Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the NodeManager Logging Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Parameter Validation: Rules to Extract Events from Log Files

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Rules to Extract Events from Log Files parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log_event_whitelist
Required: true

Suppress Parameter Validation: Healthchecker Script Arguments

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Healthchecker Script Arguments parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapred_healthchecker_script_args
Required: true

Suppress Parameter Validation: Healthchecker Script Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Healthchecker Script Path parameter.
Related Name
Default Value: false
API Name: role_config_suppression_mapred_healthchecker_script_path
Required: true

Suppress Parameter Validation: Java Configuration Options for NodeManager

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Configuration Options for NodeManager parameter.
Related Name
Default Value: false
API Name: role_config_suppression_node_manager_java_opts
Required: true

Suppress Parameter Validation: NodeManager Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the NodeManager Log Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_node_manager_log_dir
Required: true

Suppress Parameter Validation: NodeManager Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the NodeManager Advanced Configuration Snippet (Safety Valve) for yarn-site.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_nodemanager_config_safety_valve
Required: true

Suppress Parameter Validation: NodeManager Advanced Configuration Snippet (Safety Valve) for mapred-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the NodeManager Advanced Configuration Snippet (Safety Valve) for mapred-site.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_nodemanager_mapred_safety_valve
Required: true

Suppress Parameter Validation: NodeManager Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the NodeManager Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_nodemanager_role_env_safety_valve
Required: true

Suppress Parameter Validation: NodeManager Web Application HTTPS Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the NodeManager Web Application HTTPS Port (TLS/SSL) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_nodemanager_webserver_https_port
Required: true

Suppress Parameter Validation: NodeManager Web Application HTTP Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the NodeManager Web Application HTTP Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_nodemanager_webserver_port
Required: true

Suppress Parameter Validation: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: Role Triggers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Parameter Validation: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Parameter Validation: Allowed Devices for Docker Containers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Allowed Devices for Docker Containers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_docker_allowed_devices
Required: true

Suppress Parameter Validation: Allowed Read-Only Mounts for Docker Containers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Allowed Read-Only Mounts for Docker Containers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_docker_allowed_ro_mounts
Required: true

Suppress Parameter Validation: Allowed Read-Write Mounts for Docker Containers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Allowed Read-Write Mounts for Docker Containers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_docker_allowed_rw_mounts
Required: true

Suppress Parameter Validation: Allowed Volume Drivers for Docker Containers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Allowed Volume Drivers for Docker Containers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_docker_allowed_volume_drivers
Required: true

Suppress Parameter Validation: Docker Binary Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Docker Binary Path parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_docker_binary
Required: true

Suppress Configuration Validator: Validates configuration of YARN NodeManagers when Docker on YARN feature is enabled.

Description: Whether to suppress configuration warnings produced by the Validates configuration of YARN NodeManagers when Docker on YARN feature is enabled. configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_docker_on_yarn_validator
Required: true

Suppress Parameter Validation: Trusted Registries for Docker Containers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Trusted Registries for Docker Containers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_docker_trusted_registries
Required: true

Suppress Configuration Validator: YARN FPGA Resources Validator

Description: Whether to suppress configuration warnings produced by the YARN FPGA Resources Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_fpga_validator
Required: true

Suppress Configuration Validator: YARN GPU Resources Validator

Description: Whether to suppress configuration warnings produced by the YARN GPU Resources Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_gpu_validator
Required: true

Suppress Parameter Validation: NodeManager IPC Address

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the NodeManager IPC Address parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_address
Required: true

Suppress Parameter Validation: Containers Environment Variable

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Containers Environment Variable parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_admin_env
Required: true

Suppress Parameter Validation: Containers Environment Variables Whitelist

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Containers Environment Variables Whitelist parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_env_whitelist
Required: true

Suppress Parameter Validation: FPGA initializer script

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the FPGA initializer script parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_fpga_plugin_initializer_script
Required: true

Suppress Parameter Validation: NodeManager Local Directories

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the NodeManager Local Directories parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_local_dirs
Required: true

Suppress Parameter Validation: Localizer Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Localizer Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_localizer_address
Required: true

Suppress Parameter Validation: Minimum Hard Limit for Log Aggregation Roll Monitoring Interval

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Minimum Hard Limit for Log Aggregation Roll Monitoring Interval parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_log_aggregation_roll_monitoring_interval_seconds_min
Required: true

Suppress Configuration Validator: Log Aggregation Roll Monitoring Interval Minimum Validator

Description: Whether to suppress configuration warnings produced by the Log Aggregation Roll Monitoring Interval Minimum Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_log_aggregation_roll_monitoring_interval_seconds_minimum_validator
Required: true

Suppress Parameter Validation: NodeManager Container Log Directories

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the NodeManager Container Log Directories parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_log_dirs
Required: true

Suppress Parameter Validation: NodeManager Recovery Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the NodeManager Recovery Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_recovery_dir
Required: true

Suppress Parameter Validation: Remote App Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Remote App Log Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_remote_app_log_dir
Required: true

Suppress Parameter Validation: Remote App Log Directory Suffix

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Remote App Log Directory Suffix parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_remote_app_log_dir_suffix
Required: true

Suppress Parameter Validation: Allowed FPGA devices

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Allowed FPGA devices parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_resource_plugins_fpga_allowed_fpga_devices
Required: true

Suppress Parameter Validation: List of available FPGA devices

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the List of available FPGA devices parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_resource_plugins_fpga_available_devices
Required: true

Suppress Parameter Validation: Path to FPGA (aocl) tool

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Path to FPGA (aocl) tool parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_resource_plugins_fpga_path_to_discovery_executables
Required: true

Suppress Parameter Validation: Allowed Linux Runtimes

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Allowed Linux Runtimes parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_allowed_runtimes
Required: true

Suppress Parameter Validation: Allowed Docker Container Networks

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Allowed Docker Container Networks parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_docker_allowed_container_networks
Required: true

Suppress Parameter Validation: Docker Capabilities

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Docker Capabilities parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_docker_capabilities
Required: true

Suppress Parameter Validation: Default Docker Container Network

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Default Docker Container Network parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_docker_default_container_network
Required: true

Suppress Parameter Validation: Default Read-Only Mounts for Docker Containers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Default Read-Only Mounts for Docker Containers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_docker_default_ro_mounts
Required: true

Suppress Parameter Validation: Default Read-Write Mounts for Docker Containers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Default Read-Write Mounts for Docker Containers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_docker_default_rw_mounts
Required: true

Suppress Parameter Validation: Default Tempfs Mounts for Docker Containers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Default Tempfs Mounts for Docker Containers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_docker_default_tmpfs_mounts
Required: true

Suppress Parameter Validation: ACL for Privileged Docker Containers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ACL for Privileged Docker Containers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_docker_privileged_containers_acl
Required: true

Suppress Configuration Validator: YARN Resource Types Validator

Description: Whether to suppress configuration warnings produced by the YARN Resource Types Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_resources_validator
Required: true

Suppress Health Test: Audit Pipeline Test

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_node_manager_audit_health
Required: true

Suppress Health Test: ResourceManager Connectivity

Description: Whether to suppress the results of the ResourceManager Connectivity 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.
Related Name
Default Value: false
API Name: role_health_suppression_node_manager_connectivity
Required: true

Suppress Health Test: File Descriptors

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_node_manager_file_descriptor
Required: true

Suppress Health Test: GC Duration

Description: Whether to suppress the results of the GC 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.
Related Name
Default Value: false
API Name: role_health_suppression_node_manager_gc_duration
Required: true

Suppress Health Test: NodeManager Health Checker

Description: Whether to suppress the results of the NodeManager Health Checker 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.
Related Name
Default Value: false
API Name: role_health_suppression_node_manager_health_checker
Required: true

Suppress Health Test: Heap Dump Directory Free Space

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_node_manager_heap_dump_directory_free_space
Required: true

Suppress Health Test: Host Health

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_node_manager_host_health
Required: true

Suppress Health Test: Log Directory Free Space

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_node_manager_log_directory_free_space
Required: true

Suppress Health Test: Process Status

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_node_manager_scm_health
Required: true

Suppress Health Test: Swap Memory Usage

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_node_manager_swap_memory_usage
Required: true

Suppress Health Test: Swap Memory Usage Rate Beta

Description: Whether to suppress the results of the Swap Memory Usage Rate Beta 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.
Related Name
Default Value: false
API Name: role_health_suppression_node_manager_swap_memory_usage_rate
Required: true

Suppress Health Test: Unexpected Exits

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_node_manager_unexpected_exits
Required: true

Suppress Health Test: Web Server Status

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_node_manager_web_metric_collection
Required: true

Suppress Health Test: NodeManager Local Directories Free Space

Description: Whether to suppress the results of the NodeManager Local Directories 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.
Related Name
Default Value: false
API Name: role_health_suppression_nodemanager_local_data_directories_free_space
Required: true

Suppress Health Test: NodeManager Container Log Directories Free Space

Description: Whether to suppress the results of the NodeManager Container Log Directories 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.
Related Name
Default Value: false
API Name: role_health_suppression_nodemanager_log_directories_free_space
Required: true

Suppress Health Test: NodeManager Recovery Directory Free Space

Description: Whether to suppress the results of the NodeManager Recovery 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.
Related Name
Default Value: false
API Name: role_health_suppression_nodemanager_recovery_directory_free_space
Required: true

ResourceManager

Advanced

Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve)

Description: Advanced Configuration Snippet (Safety Valve) for Hadoop Metrics2. Properties will be inserted into hadoop-metrics2.properties.
Related Name
Default Value
API Name: hadoop_metrics2_safety_valve
Required: false

ResourceManager Logging Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into log4j.properties for this role only.
Related Name
Default Value
API Name: log4j_safety_valve
Required: false

Enable auto refresh for metric configurations

Description: When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value: false
API Name: metric_config_auto_refresh
Required: false

Heap Dump Directory

Description: 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, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. 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.
Related Name: oom_heap_dump_dir
Default Value: /tmp
API Name: oom_heap_dump_dir
Required: false

Dump Heap When Out of Memory

Description: When set, generates a heap dump file when when an out-of-memory error occurs.
Related Name
Default Value: true
API Name: oom_heap_dump_enabled
Required: true

Kill When Out of Memory

Description: When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value: true
API Name: oom_sigkill_enabled
Required: true

Automatically Restart Process

Description: When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
Related Name
Default Value: false
API Name: process_auto_restart
Required: true

Enable Metric Collection

Description: 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.
Related Name
Default Value: true
API Name: process_should_monitor
Required: true

Process Start Retry Attempts

Description: Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
Related Name
Default Value: 3
API Name: process_start_retries
Required: false

Process Start Wait Timeout

Description: The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
Related Name
Default Value: 20
API Name: process_start_secs
Required: false

Java Configuration Options for ResourceManager

Description: 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. Note: When CM version is 6.3.0 or greater, {{JAVA_GC_ARGS}} will be replaced by JVM Garbage Collection arguments based on the runtime Java JVM version.
Related Name
Default Value: JAVA_GC_ARGS -Dlibrary.leveldbjni.path=CMF_CONF_DIR
API Name: resource_manager_java_opts
Required: false

ResourceManager Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: For advanced use only. A string to be inserted into yarn-site.xml for this role only.
Related Name
Default Value
API Name: resourcemanager_config_safety_valve
Required: false

ResourceManager Advanced Configuration Snippet (Safety Valve) for mapred-site.xml

Description: For advanced use only. A string to be inserted into mapred-site.xml for this role only.
Related Name
Default Value
API Name: resourcemanager_mapred_safety_valve
Required: false

ResourceManager Environment Advanced Configuration Snippet (Safety Valve)

Description: 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.
Related Name
Default Value
API Name: RESOURCEMANAGER_role_env_safety_valve
Required: false

ResourceManager Advanced Configuration Snippet (Safety Valve) for nodes_allow.txt

Description: For advanced use only. A string to be inserted into nodes_allow.txt for this role only.
Related Name
Default Value
API Name: rm_hosts_allow_safety_valve
Required: false

ResourceManager Advanced Configuration Snippet (Safety Valve) for nodes_exclude.txt

Description: For advanced use only. A string to be inserted into nodes_exclude.txt for this role only.
Related Name
Default Value
API Name: rm_hosts_exclude_safety_valve
Required: false

Logs

ResourceManager Logging Threshold

Description: The minimum log level for ResourceManager logs
Related Name
Default Value: INFO
API Name: log_threshold
Required: false

ResourceManager Maximum Log File Backups

Description: The maximum number of rolled log files to keep for ResourceManager logs. Typically used by log4j or logback.
Related Name
Default Value: 10
API Name: max_log_backup_index
Required: false

ResourceManager Max Log Size

Description: The maximum size, in megabytes, per log file for ResourceManager logs. Typically used by log4j or logback.
Related Name
Default Value: 200 MiB
API Name: max_log_size
Required: false

ResourceManager Log Directory

Description: Directory where ResourceManager will place its log files.
Related Name: hadoop.log.dir
Default Value: /var/log/hadoop-yarn
API Name: resource_manager_log_dir
Required: false

Monitoring

Enable Health Alerts for this Role

Description: 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
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

Description: When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value: false
API Name: enable_config_alerts
Required: false

Heap Dump Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: heap_dump_directory_free_space_absolute_thresholds
Required: false

Heap Dump Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: heap_dump_directory_free_space_percentage_thresholds
Required: false

Log Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: log_directory_free_space_absolute_thresholds
Required: false

Log Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: log_directory_free_space_percentage_thresholds
Required: false

Rules to Extract Events from Log Files

Description

alert - whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".
rate (mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more than rate matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.
periodminutes - the number of minutes during which the publisher will only publish rate events or fewer. If not specified, the default is one minute
threshold - apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.
content - match only those messages for which contents match this regular expression.
exceptiontype - match only those messages that are part of an exception message. The exception type must match this regular expression.

Example:

{"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}This rule sends events to Cloudera Manager for every StringIndexOutOfBoundsException, up to a maximum of 10 every minute.
{"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.

Related Name

Default Value

API Name

log_event_whitelist

Required

false

Metric Filter

Description

Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:

Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
Metric Name - The name of a metric that will be included or excluded during metric collection.

Include only Health Test Metric Set: Selected.
Include/Exclude Custom Metrics: Set to Include.
Metric Name: jvm_heap_used_mb

You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:

{
  "includeHealthTestMetricSet": true, 
  "filterType": "whitelist",
  "metrics": ["jvm_heap_used_mb"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

Swap Memory Usage Rate Thresholds

Description: The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_swap_memory_rate_thresholds
Required: false

Swap Memory Usage Rate Window

Description: The period to review when computing unexpected swap memory usage change of the process.
Related Name: common.process.swap_memory_rate_window
Default Value: 5 minute(s)
API Name: process_swap_memory_rate_window
Required: false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: resourcemanager_fd_thresholds
Required: false

Garbage Collection Duration Thresholds

Description: The health test thresholds for the weighted average time spent in Java garbage collection. Specified as a percentage of elapsed wall clock time.
Related Name
Default Value: Warning: 30.0, Critical: 60.0
API Name: resourcemanager_gc_duration_thresholds
Required: false

Garbage Collection Duration Monitoring Period

Description: The period to review when computing the moving average of garbage collection time.
Related Name
Default Value: 5 minute(s)
API Name: resourcemanager_gc_duration_window
Required: false

ResourceManager Host Health Test

Description: When computing the overall ResourceManager health, consider the host's health.
Related Name
Default Value: true
API Name: resourcemanager_host_health_enabled
Required: false

ResourceManager Process Health Test

Description: Enables the health test that the ResourceManager's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: resourcemanager_scm_health_enabled
Required: false

Health Test Startup Tolerance

Description: The amount of time allowed after this role is started that failures of health tests that rely on communication with this role will be tolerated.
Related Name
Default Value: 5 minute(s)
API Name: resourcemanager_startup_tolerance_minutes
Required: false

Web Metric Collection

Description: Enables the health test that the Cloudera Manager Agent can successfully contact and gather metrics from the web server.
Related Name
Default Value: true
API Name: resourcemanager_web_metric_collection_enabled
Required: false

Web Metric Collection Duration

Description: The health test thresholds on the duration of the metrics request to the web server.
Related Name
Default Value: Warning: 10 second(s), Critical: Never
API Name: resourcemanager_web_metric_collection_thresholds
Required: false

Role Triggers

Description

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"}]

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: unexpected_exits_thresholds
Required: false

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Related Name
Default Value: 5 minute(s)
API Name: unexpected_exits_window
Required: false

Other

Capacity Scheduler Configuration Advanced Configuration Snippet (Safety Valve)

Description: Enter an XML string that represents the Capacity Scheduler configuration.
Related Name
Default Value: <configuration> <property> <name>yarn.scheduler.capacity.root.queues</name> <value>default</value> </property> <property> <name>yarn.scheduler.capacity.root.capacity</name> <value>100</value> </property> <property> <name>yarn.scheduler.capacity.root.default.capacity</name> <value>100</value> </property> <property> <name>yarn.scheduler.capacity.root.default.maximum-am-resource-percent</name> <value>0.2</value> </property> <property> <name>yarn.scheduler.capacity.schedule-asynchronously.enable</name> <value>true</value> </property> </configuration>
API Name: resourcemanager_capacity_scheduler_configuration
Required: true

Fair Scheduler Assign Multiple Tasks

Description: Enables multiple Fair Scheduler container assignments in one heartbeat, which improves cluster throughput when there are many small tasks to run.
Related Name: yarn.scheduler.fair.assignmultiple
Default Value: true
API Name: resourcemanager_fair_scheduler_assign_multiple
Required: true

Fair Scheduler XML Advanced Configuration Snippet (Safety Valve)

Description: An XML string that will be inserted verbatim into the Fair Scheduler allocations file. For CDH 5, overrides the configuration set using the Pools configuration UI. For CDH 4, this is the only way to configure the Fair Scheduler for YARN.
Related Name
Default Value
API Name: resourcemanager_fair_scheduler_configuration
Required: false

Fair Scheduler Dynamic Max Assign

Description: During node heartbeat, the ResourceManager will allocate up to half the available resources on a node. Only valid if yarn.scheduler.fair.assignmultiple is set to true.
Related Name: yarn.scheduler.fair.dynamic.max.assign
Default Value: true
API Name: resourcemanager_fair_scheduler_dynamic_max_assign
Required: false

Fair Scheduler Max Assign

Description: Limit the number of containers allocated by the ResourceManager with each node heartbeat. -1 is equivalent to unlimited. Only valid if yarn.scheduler.fair.assignmultiple is true and yarn.scheduler.fair.dynamic.max.assign is false.
Related Name: yarn.scheduler.fair.max.assign
Default Value: -1
API Name: resourcemanager_fair_scheduler_max_assign
Required: false

Enable Fair Scheduler Preemption

Description: When enabled, if a pool's minimum share is not met for some period of time, the Fair Scheduler preempts applications in other pools. Preemption guarantees that production applications are not starved while also allowing the cluster to be used for experimental and research applications. To minimize wasted computation, the Fair Scheduler preempts the most recently launched applications.
Related Name: yarn.scheduler.fair.preemption
Default Value: false
API Name: resourcemanager_fair_scheduler_preemption
Required: true

Fair Scheduler Size-Based Weight

Description: When enabled, the Fair Scheduler will assign shares to individual apps based on their size, rather than providing an equal share to all apps regardless of size.
Related Name: yarn.scheduler.fair.sizebasedweight
Default Value: false
API Name: resourcemanager_fair_scheduler_size_based_weight
Required: true

Fair Scheduler User As Default Queue

Description: When set to true, the Fair Scheduler uses the username as the default pool name, in the event that a pool name is not specified. When set to false, all applications are run in a shared pool, called default.
Related Name: yarn.scheduler.fair.user-as-default-queue
Default Value: true
API Name: resourcemanager_fair_scheduler_user_as_default_queue
Required: true

ApplicationMaster Monitor Expiry

Description: The expiry interval to wait until an ApplicationMaster is considered dead.
Related Name: yarn.am.liveness-monitor.expiry-interval-ms
Default Value: 10 minute(s)
API Name: yarn_am_liveness_monitor_expiry_interval_ms
Required: false

NodeManager Monitor Expiry

Description: The expiry interval to wait until a NodeManager is considered dead.
Related Name: yarn.nm.liveness-monitor.expiry-interval-ms
Default Value: 10 minute(s)
API Name: yarn_nm_liveness_monitor_expiry_interval_ms
Required: false

Admin Client Thread Count

Description: Number of threads used to handle the ResourceManager admin interface.
Related Name: yarn.resourcemanager.admin.client.thread-count
Default Value: 1
API Name: yarn_resourcemanager_admin_client_thread_count
Required: false

ApplicationMaster Maximum Attempts

Description: The maximum number of application attempts. This is a global setting for all ApplicationMasters.. Each ApplicationMaster can specify its individual maximum through the API, but if the individual maximum is more than the global maximum, the ResourceManager overrides it.
Related Name: yarn.resourcemanager.am.max-attempts
Default Value: 2
API Name: yarn_resourcemanager_am_max_retries
Required: false

ApplicationMaster Monitor Interval

Description: The periodic interval that the ResourceManager will check whether ApplicationMasters is still alive.
Related Name: yarn.resourcemanager.amliveliness-monitor.interval-ms
Default Value: 1 second(s)
API Name: yarn_resourcemanager_amliveliness_monitor_interval_ms
Required: false

Client Thread Count

Description: The number of threads used to handle applications manager requests.
Related Name: yarn.resourcemanager.client.thread-count
Default Value: 50
API Name: yarn_resourcemanager_client_thread_count
Required: false

Container Monitor Interval

Description: The periodic interval that the ResourceManager will check whether containers are still alive.
Related Name: yarn.resourcemanager.container.liveness-monitor.interval-ms
Default Value: 10 minute(s)
API Name: yarn_resourcemanager_container_liveness_monitor_interval_ms
Required: false

Max Completed Applications

Description: The maximum number of completed applications that the ResourceManager keeps.
Related Name: yarn.resourcemanager.max-completed-applications
Default Value: 10000
API Name: yarn_resourcemanager_max_completed_applications
Required: false

NodeManager Monitor Interval

Description: The periodic interval that the ResourceManager will check whether NodeManagers are still alive.
Related Name: yarn.resourcemanager.nm.liveness-monitor.interval-ms
Default Value: 1 second(s)
API Name: yarn_resourcemanager_nm_liveness_monitor_interval_ms
Required: false

Enable ResourceManager Proxy User Privileges

Description: When enabled, ResourceManager has proxy user privileges.
Related Name: yarn.resourcemanager.proxy-user-privileges.enabled
Default Value: true
API Name: yarn_resourcemanager_proxy_user_privileges_enabled
Required: false

Enable ResourceManager Recovery

Description: When enabled, any applications that were running on the cluster when the ResourceManager died will be recovered when the ResourceManager next starts. Note: If RM-HA is enabled, then this configuration is always enabled.
Related Name: yarn.resourcemanager.recovery.enabled
Default Value: true
API Name: yarn_resourcemanager_recovery_enabled
Required: false

Resource Tracker Thread Count

Description: Number of threads to handle resource tracker calls.
Related Name: yarn.resourcemanager.resource-tracker.client.thread-count
Default Value: 50
API Name: yarn_resourcemanager_resource_tracker_client_thread_count
Required: false

Scheduler Class

Description: The class to use as the resource scheduler. FairScheduler is only supported in CDH 4.2.1 and later.
Related Name: yarn.resourcemanager.scheduler.class
Default Value: org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.CapacityScheduler
API Name: yarn_resourcemanager_scheduler_class
Required: false

Scheduler Thread Count

Description: The number of threads used to handle requests through the scheduler interface.
Related Name: yarn.resourcemanager.scheduler.client.thread-count
Default Value: 50
API Name: yarn_resourcemanager_scheduler_client_thread_count
Required: false

ZooKeeper Session Timeout

Description: The timeout for the ResourceManager session with ZooKeeper. The session expires if the ZooKeeper ensemble does not hear from the ResourceManager within the specified timeout period (no heartbeat). Session expiration is managed by the ZooKeeper ensemble, not by the ResourceManager.
Related Name: yarn.resourcemanager.zk-timeout-ms
Default Value: 1 minute(s)
API Name: yarn_resourcemanager_zk_timeout_ms
Required: false

Resource Calculator Class

Description: The Resource Calculator implementation to be used to compare Resources in the scheduler. The DefaultResourceCalculator only uses Memory while DominantResourceCalculator uses Dominant-resource to compare multi-dimensional resources such as Memory, CPU etc.
Related Name: yarn.scheduler.capacity.resource-calculator
Default Value: org.apache.hadoop.yarn.util.resource.DominantResourceCalculator
API Name: yarn_scheduler_capacity_resource_calculator
Required: false

Fair Scheduler Preemption Utilization Threshold

Description: The utilization threshold after which preemption kicks in. The utilization is computed as the maximum ratio of usage to capacity among all resources.
Related Name: yarn.scheduler.fair.preemption.cluster-utilization-threshold
Default Value: 0.8
API Name: yarn_scheduler_fair_preemption_cluster_utilization_threshold
Required: false

Performance

Maximum Process File Descriptors

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

Ports and Addresses

ResourceManager Web Application HTTPS Port (TLS/SSL)

Description: The HTTPS port of the ResourceManager web application.
Related Name: yarn.resourcemanager.webapp.https.address
Default Value: 8090
API Name: resourcemanager_webserver_https_port
Required: false

ResourceManager Web Application HTTP Port

Description: The HTTP port of the ResourceManager web application.
Related Name: yarn.resourcemanager.webapp.address
Default Value: 8088
API Name: resourcemanager_webserver_port
Required: false

ResourceManager Address

Description: The address of the applications manager interface in the ResourceManager.
Related Name: yarn.resourcemanager.address
Default Value: 8032
API Name: yarn_resourcemanager_address
Required: false

Administration Address

Description: The address of the admin interface in the ResourceManager.
Related Name: yarn.resourcemanager.admin.address
Default Value: 8033
API Name: yarn_resourcemanager_admin_address
Required: false

Resource Tracker Address

Description: The address of the resource tracker interface in the ResourceManager.
Related Name: yarn.resourcemanager.resource-tracker.address
Default Value: 8031
API Name: yarn_resourcemanager_resource_tracker_address
Required: false

Scheduler Address

Description: The address of the scheduler interface in the ResourceManager.
Related Name: yarn.resourcemanager.scheduler.address
Default Value: 8030
API Name: yarn_resourcemanager_scheduler_address
Required: false

Bind ResourceManager to Wildcard Address

Description: If enabled, the ResourceManager binds to the wildcard address ("0.0.0.0") on all of its ports.
Related Name
Default Value: false
API Name: yarn_rm_bind_wildcard
Required: false

Resource Management

Java Heap Size of ResourceManager in Bytes

Description: Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx.
Related Name
Default Value: 1 GiB
API Name: resource_manager_java_heapsize
Required: false

Fair Scheduler Node Locality Threshold

Description: For applications that request containers on particular nodes, the number of scheduling opportunities since the last container assignment to wait before accepting a placement on another node. Expressed as a float between 0 and 1, which, as a fraction of the cluster size, is the number of scheduling opportunities to pass up. If not set, this means don't pass up any scheduling opportunities. Requires Fair Scheduler continuous scheduling to be disabled. If continuous scheduling is enabled, yarn.scheduler.fair.locality-delay-node-ms should be used instead.
Related Name: yarn.scheduler.fair.locality.threshold.node
Default Value
API Name: resourcemanager_fair_scheduler_locality_threshold_node
Required: false

Fair Scheduler Rack Locality Threshold

Description: For applications that request containers on particular racks, the number of scheduling opportunities since the last container assignment to wait before accepting a placement on another rack. Expressed as a float between 0 and 1, which, as a fraction of the cluster size, is the number of scheduling opportunities to pass up. If not set, this means don't pass up any scheduling opportunities. Requires Fair Scheduler continuous scheduling to be disabled. If continuous scheduling is enabled, yarn.scheduler.fair.locality-delay-rack-ms should be used instead.
Related Name: yarn.scheduler.fair.locality.threshold.rack
Default Value
API Name: resourcemanager_fair_scheduler_locality_threshold_rack
Required: false

Cgroup CPU Shares

Description: 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.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup I/O Weight

Description: 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.
Related Name: blkio.weight
Default Value: 500
API Name: rm_io_weight
Required: true

Cgroup Memory Hard Limit

Description: 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 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit
Required: true

Cgroup Memory Soft Limit

Description: 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 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit
Required: true

Enable Fair Scheduler Continuous Scheduling

Description: Enable continuous scheduling in the Fair Scheduler. When enabled, scheduling decisions are decoupled from NodeManager heartbeats, leading to faster resource allocations.
Related Name: yarn.scheduler.fair.continuous-scheduling-enabled
Default Value: false
API Name: yarn_scheduler_fair_continuous_scheduling_enabled
Required: false

Fair Scheduler Node Locality Delay

Description: For applications that request containers on particular nodes, the minimum time in milliseconds the Fair Scheduler waits before accepting a placement on another node. Requires Fair Scheduler continuous scheduling to be enabled. If continuous scheduling is disabled, yarn.scheduler.fair.locality.threshold.node should be used instead.
Related Name: yarn.scheduler.fair.locality-delay-node-ms
Default Value: 2 second(s)
API Name: yarn_scheduler_fair_locality_delay_node_ms
Required: false

Fair Scheduler Rack Locality Delay

Description: For applications that request containers on particular racks, the minimum time in milliseconds the Fair Scheduler waits before accepting a placement on another rack. Requires Fair Scheduler continuous scheduling to be enabled. If continuous scheduling is disabled, yarn.scheduler.fair.locality.threshold.rack should be used instead.
Related Name: yarn.scheduler.fair.locality-delay-rack-ms
Default Value: 4 second(s)
API Name: yarn_scheduler_fair_locality_delay_rack_ms
Required: false

Container Memory Increment

Description: If using the Fair Scheduler, memory requests will be rounded up to the nearest multiple of this number. This parameter has no effect prior to CDH 5.
Related Name: yarn.scheduler.increment-allocation-mb
Default Value: 512 MiB
API Name: yarn_scheduler_increment_allocation_mb
Required: true

Container Virtual CPU Cores Increment

Description: If using the Fair Scheduler, virtual core requests will be rounded up to the nearest multiple of this number. This parameter has no effect prior to CDH 5.
Related Name: yarn.scheduler.increment-allocation-vcores
Default Value: 1
API Name: yarn_scheduler_increment_allocation_vcores
Required: true

Container Memory Maximum

Description: The largest amount of physical memory, in MiB, that can be requested for a container.
Related Name: yarn.scheduler.maximum-allocation-mb
Default Value: 64 GiB
API Name: yarn_scheduler_maximum_allocation_mb
Required: true

Container Virtual CPU Cores Maximum

Description: The largest number of virtual CPU cores that can be requested for a container. This parameter has no effect prior to CDH 4.4.
Related Name: yarn.scheduler.maximum-allocation-vcores
Default Value: 32
API Name: yarn_scheduler_maximum_allocation_vcores
Required: true

Container Memory Minimum

Description: The smallest amount of physical memory, in MiB, that can be requested for a container. If using the Capacity or FIFO scheduler (or any scheduler, prior to CDH 5), memory requests will be rounded up to the nearest multiple of this number.
Related Name: yarn.scheduler.minimum-allocation-mb
Default Value: 1 GiB
API Name: yarn_scheduler_minimum_allocation_mb
Required: true

Container Virtual CPU Cores Minimum

Description: The smallest number of virtual CPU cores that can be requested for a container. If using the Capacity or FIFO scheduler (or any scheduler, prior to CDH 5), virtual core requests will be rounded up to the nearest multiple of this number. This parameter has no effect prior to CDH 4.4.
Related Name: yarn.scheduler.minimum-allocation-vcores
Default Value: 1
API Name: yarn_scheduler_minimum_allocation_vcores
Required: true

Stacks Collection

Stacks Collection Data Retention

Description: The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name: stacks_collection_data_retention
Default Value: 100 MiB
API Name: stacks_collection_data_retention
Required: false

Stacks Collection Directory

Description: The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name: stacks_collection_directory
Default Value
API Name: stacks_collection_directory
Required: false

Stacks Collection Enabled

Description: Whether or not periodic stacks collection is enabled.
Related Name: stacks_collection_enabled
Default Value: false
API Name: stacks_collection_enabled
Required: true

Stacks Collection Frequency

Description: The frequency with which stacks are collected.
Related Name: stacks_collection_frequency
Default Value: 5.0 second(s)
API Name: stacks_collection_frequency
Required: false

Stacks Collection Method

Description: 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.
Related Name: stacks_collection_method
Default Value: jstack
API Name: stacks_collection_method
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hadoop_metrics2_safety_valve
Required: true

Suppress Parameter Validation: ResourceManager Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ResourceManager Logging Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Parameter Validation: Rules to Extract Events from Log Files

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Rules to Extract Events from Log Files parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log_event_whitelist
Required: true

Suppress Parameter Validation: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Parameter Validation: Java Configuration Options for ResourceManager

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Configuration Options for ResourceManager parameter.
Related Name
Default Value: false
API Name: role_config_suppression_resource_manager_java_opts
Required: true

Suppress Parameter Validation: ResourceManager Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ResourceManager Log Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_resource_manager_log_dir
Required: true

Suppress Parameter Validation: Capacity Scheduler Configuration Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Capacity Scheduler Configuration Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_resourcemanager_capacity_scheduler_configuration
Required: true

Suppress Parameter Validation: ResourceManager Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ResourceManager Advanced Configuration Snippet (Safety Valve) for yarn-site.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_resourcemanager_config_safety_valve
Required: true

Suppress Parameter Validation: Fair Scheduler XML Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Fair Scheduler XML Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_resourcemanager_fair_scheduler_configuration
Required: true

Suppress Parameter Validation: ResourceManager Advanced Configuration Snippet (Safety Valve) for mapred-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ResourceManager Advanced Configuration Snippet (Safety Valve) for mapred-site.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_resourcemanager_mapred_safety_valve
Required: true

Suppress Parameter Validation: ResourceManager Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ResourceManager Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_resourcemanager_role_env_safety_valve
Required: true

Suppress Parameter Validation: ResourceManager Web Application HTTPS Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ResourceManager Web Application HTTPS Port (TLS/SSL) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_resourcemanager_webserver_https_port
Required: true

Suppress Parameter Validation: ResourceManager Web Application HTTP Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ResourceManager Web Application HTTP Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_resourcemanager_webserver_port
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: ResourceManager Advanced Configuration Snippet (Safety Valve) for nodes_allow.txt

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ResourceManager Advanced Configuration Snippet (Safety Valve) for nodes_allow.txt parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_hosts_allow_safety_valve
Required: true

Suppress Parameter Validation: ResourceManager Advanced Configuration Snippet (Safety Valve) for nodes_exclude.txt

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ResourceManager Advanced Configuration Snippet (Safety Valve) for nodes_exclude.txt parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_hosts_exclude_safety_valve
Required: true

Suppress Parameter Validation: Role Triggers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Parameter Validation: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Parameter Validation: ResourceManager Address

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ResourceManager Address parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_resourcemanager_address
Required: true

Suppress Parameter Validation: Administration Address

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Administration Address parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_resourcemanager_admin_address
Required: true

Suppress Parameter Validation: ApplicationMaster Maximum Attempts

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ApplicationMaster Maximum Attempts parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_resourcemanager_am_max_retries
Required: true

Suppress Parameter Validation: Resource Tracker Address

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Resource Tracker Address parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_resourcemanager_resource_tracker_address
Required: true

Suppress Parameter Validation: Scheduler Address

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Scheduler Address parameter.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_resourcemanager_scheduler_address
Required: true

Suppress Health Test: Audit Pipeline Test

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_resource_manager_audit_health
Required: true

Suppress Health Test: File Descriptors

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_resource_manager_file_descriptor
Required: true

Suppress Health Test: GC Duration

Description: Whether to suppress the results of the GC 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.
Related Name
Default Value: false
API Name: role_health_suppression_resource_manager_gc_duration
Required: true

Suppress Health Test: Heap Dump Directory Free Space

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_resource_manager_heap_dump_directory_free_space
Required: true

Suppress Health Test: Host Health

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_resource_manager_host_health
Required: true

Suppress Health Test: Log Directory Free Space

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_resource_manager_log_directory_free_space
Required: true

Suppress Health Test: Process Status

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_resource_manager_scm_health
Required: true

Suppress Health Test: Swap Memory Usage

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_resource_manager_swap_memory_usage
Required: true

Suppress Health Test: Swap Memory Usage Rate Beta

Description: Whether to suppress the results of the Swap Memory Usage Rate Beta 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.
Related Name
Default Value: false
API Name: role_health_suppression_resource_manager_swap_memory_usage_rate
Required: true

Suppress Health Test: Unexpected Exits

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_resource_manager_unexpected_exits
Required: true

Suppress Health Test: Web Server Status

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_resource_manager_web_metric_collection
Required: true

Service-Wide

Advanced

System User's Home Directory

Description: The home directory of the system user on the local filesystem. This setting must reflect the system's configured value - only changing it here will not change the actual home directory.
Related Name
Default Value: /var/lib/hadoop-yarn
API Name: hdfs_user_home_dir
Required: true

HDFS Replication Advanced Configuration Snippet (Safety Valve) for mapred-site.xml

Description: For advanced use only, a string to be inserted into mapred-site.xml. Applies to all HDFS Replication jobs.
Related Name
Default Value
API Name: mapreduce_service_replication_config_safety_valve
Required: false

System Group

Description: The group that this service's processes should run as. (Except the Job History Server, which has its own group.)
Related Name
Default Value: hadoop
API Name: process_groupname
Required: true

System User

Description: The user that this service's processes should run as. (Except the Job History Server, which has its own user)
Related Name
Default Value: yarn
API Name: process_username
Required: true

YARN Service Advanced Configuration Snippet (Safety Valve) for ranger-yarn-audit.xml

Description: For advanced use only, a string to be inserted into ranger-yarn-audit.xml. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: ranger_audit_safety_valve
Required: false

YARN Service Advanced Configuration Snippet (Safety Valve) for ranger-yarn-policymgr-ssl.xml

Description: For advanced use only, a string to be inserted into ranger-yarn-policymgr-ssl.xml. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: ranger_policymgr_ssl_safety_valve
Required: false

YARN Service Advanced Configuration Snippet (Safety Valve) for ranger-yarn-security.xml

Description: For advanced use only, a string to be inserted into ranger-yarn-security.xml. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: ranger_security_safety_valve
Required: false

YARN Application Classpath

Description: Entries to add to the classpaths of YARN applications.
Related Name: yarn.application.classpath
Default Value: $HADOOP_CLIENT_CONF_DIR $HADOOP_COMMON_HOME/* $HADOOP_COMMON_HOME/lib/* $HADOOP_HDFS_HOME/* $HADOOP_HDFS_HOME/lib/* $HADOOP_YARN_HOME/* $HADOOP_YARN_HOME/lib/*
API Name: yarn_application_classpath
Required: false

YARN Service Advanced Configuration Snippet (Safety Valve) for core-site.xml

Description: For advanced use only, a string to be inserted into core-site.xml. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: yarn_core_site_safety_valve
Required: false

Fair Scheduler Configuration Rules (Deployed)

Description: A list specifying the rules to run to determine which Fair Scheduler configuration to use.
Related Name
Default Value: []
API Name: yarn_fs_schedule_rules
Required: false

Fair Scheduler Configuration Rules (Staged)

Description: A list specifying the rules to run to determine which Fair Scheduler configuration to use. Typically edited using the Rules configuration UI.
Related Name
Default Value
API Name: yarn_fs_schedule_rules_draft
Required: false

Fair Scheduler Allocations (Deployed)

Description: JSON representation of all the configurations that the Fair Scheduler can take on across all schedules.
Related Name
Default Value: queuePlacementRules: [ create: true, name: specified , name: nestedUserQueue, rules: [ name: default, queue: users ] ], queues: [ name: root, queues: [ name: default, queues: [], schedulablePropertiesList: [ scheduleName: default ], schedulingPolicy: drf , name: users, queues: [], schedulablePropertiesList: [ scheduleName: default ], schedulingPolicy: drf, type: parent ], schedulablePropertiesList: [ scheduleName: default ], schedulingPolicy: drf ], users: []
API Name: yarn_fs_scheduled_allocations
Required: false

Fair Scheduler Allocations (Staged)

Description: JSON representation of all the configurations that the Fair Scheduler can take on across all schedules. Typically edited using the Pools configuration UI.
Related Name
Default Value
API Name: yarn_fs_scheduled_allocations_draft
Required: false

YARN Service Advanced Configuration Snippet (Safety Valve) for hadoop-policy.xml

Description: For advanced use only, a string to be inserted into hadoop-policy.xml. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: yarn_hadoop_policy_config_safety_valve
Required: false

YARN Service Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: For advanced use only, a string to be inserted into yarn-site.xml. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: yarn_service_config_safety_valve
Required: false

YARN Service Environment Advanced Configuration Snippet (Safety Valve)

Description: 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.
Related Name
Default Value
API Name: yarn_service_env_safety_valve
Required: false

YARN Service MapReduce Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into mapred-site.xml. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: yarn_service_mapred_safety_valve
Required: false

HDFS Replication Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: For advanced use only, a string to be inserted into yarn-site.xml. Applies to all HDFS Replication jobs.
Related Name
Default Value
API Name: yarn_service_replication_config_safety_valve
Required: false

YARN Service Advanced Configuration Snippet (Safety Valve) for ssl-client.xml

Description: For advanced use only, a string to be inserted into ssl-client.xml. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: yarn_ssl_client_safety_valve
Required: false

YARN Service Advanced Configuration Snippet (Safety Valve) for ssl-server.xml

Description: For advanced use only, a string to be inserted into ssl-server.xml. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: yarn_ssl_server_safety_valve
Required: false

Log Aggregation

Enable Log Aggregation

Description: Specifies if log aggregation is enabled.
Related Name: yarn.log-aggregation-enable
Default Value: true
API Name: yarn_log_aggregation_enable
Required: false

Supported Log Aggregation File Formats

Description: Specifies which log file formats are supported. The first file format in the list is used to write the aggregated logs. TFile format is always added to support backward compatibility.
Related Name: yarn.log-aggregation.file-formats
Default Value: IFile TFile
API Name: yarn_log_aggregation_file_formats
Required: false

Remote App Log Directory for IFile Format

Description: Specifies the path of the directory where application logs are stored after an application is completed if IFile format is given as the file format for writing. This configuration overwrites the one given in NodeManager level (yarn.nodemanager.remote-app-log-dir).
Related Name: yarn.log-aggregation.IFile.remote-app-log-dir
Default Value
API Name: yarn_log_aggregation_IFile_remote_app_log_dir
Required: false

Remote App Log Directory Suffix for IFile Format

Description: The remote log directory is created at {remote-app-log-dir}/${user}/{thisParam} if IFile format is selected for writing. This configuration overwrites the one given in NodeManager level (yarn.nodemanager.remote-app-log-dir-suffix).
Related Name: yarn.log-aggregation.IFile.remote-app-log-dir-suffix
Default Value
API Name: yarn_log_aggregation_IFile_remote_app_log_dir_suffix
Required: false

Log Aggregation Retention Period

Description: Specifies how long aggregation logs are kept before they are deleted.
Related Name: yarn.log-aggregation.retain-seconds
Default Value: 7 day(s)
API Name: yarn_log_aggregation_retain_seconds
Required: false

Log Aggregation Status Timeout

Description: Specifies the maximum amount of time that the NodeManager has for reporting a container's log aggregation status. If no log aggregation status is sent by the NodeManager within the allotted time, the ResourceManager reports a TIME_OUT log aggregation status for that container.
Related Name: yarn.log-aggregation-status.time-out.ms
Default Value: 10 minute(s)
API Name: yarn_log_aggregation_status_time_out_ms
Required: false

Remote App Log Directory for TFile Format

Description: Specifies the path of the directory where application logs are stored after an application is completed if TFile format is selected for writing. This configuration overwrites the one given in NodeManager level (yarn.nodemanager.remote-app-log-dir).
Related Name: yarn.log-aggregation.TFile.remote-app-log-dir
Default Value
API Name: yarn_log_aggregation_TFile_remote_app_log_dir
Required: false

Remote App Log Directory Suffix for TFile Format

Description: The remote log directory is created at {remote-app-log-dir}/${user}/{thisParam} if TFile format is selected for writing. This configuration overwrites the one given in NodeManager level (yarn.nodemanager.remote-app-log-dir-suffix).
Related Name: yarn.log-aggregation.TFile.remote-app-log-dir-suffix
Default Value
API Name: yarn_log_aggregation_TFile_remote_app_log_dir_suffix
Required: false

Log Aggregation Compression Type

Description: Specifies the TFile compression type used to compress aggregated logs.
Related Name: yarn.nodemanager.log-aggregation.compression-type
Default Value: none
API Name: yarn_nodemanager_log_aggregation_compression_type
Required: false

Monitoring

Admin Users Applications List Visibility Settings

Description: Controls which applications an admin user can see in the applications list view
Related Name
Default Value: ALL
API Name: admin_application_list_settings
Required: true

Enable Log Event Capture

Description: When set, each role identifies important log events and forwards them to Cloudera Manager.
Related Name
Default Value: true
API Name: catch_events
Required: false

Cloudera Manager Container Usage Metrics Directory

Description: DFS directory where the container usage metrics from Cloudera Manager sink are stored by YARN NodeManagers. Cloudera Service Monitor will read the container usage metrics and aggregate them for generating usage reports. Note: If you change this, you will need to re-run the Create YARN Container Usage Metrics Dir command.
Related Name
Default Value: /tmp/cmYarnContainerMetrics
API Name: cm_yarn_container_usage_input_dir
Required: true

Maximum Hours to Aggregate Usage Metrics

Description: Maximum number of hours in the past for which container usage aggregation is performed by Cloudera Service Monitor.
Related Name
Default Value: 6
API Name: cm_yarn_container_usage_job_go_back_window_hours
Required: true

Reduce Tasks for Container Usage MapReduce Job

Description: Number of reduce tasks to use for the MapReduce job to aggregate container usage metrics.
Related Name
Default Value: 1
API Name: cm_yarn_container_usage_job_num_reduce_tasks
Required: true

Container Usage MapReduce Job Pool

Description: YARN pool which is used to submit the job to aggregate container usage metrics.
Related Name
Default Value
API Name: cm_yarn_container_usage_job_pool
Required: false

Container Usage MapReduce Job User

Description: User that Cloudera Service Monitor uses to run the MapReduce job to aggregate container usage metrics. Note: If you change this user, you need to change the owner of the existing Container Usage Metrics and Output Directories.
Related Name
Default Value
API Name: cm_yarn_container_usage_job_user
Required: false

Container Usage Output Directory

Description: DFS directory where the aggregated container usage metrics are stored by Cloudera Service Monitor. This directory is created by Cloudera Service Monitor before running the usage aggregation MapReduce job for the first time.
Related Name
Default Value: /tmp/cmYarnContainerMetricsAggregate
API Name: cm_yarn_container_usage_output_dir
Required: true

Enable Container Usage Metrics Collection

Description: Enables storing YARN container usage metrics in HDFS and periodically running a MapReduce job from Cloudera Service Monitor to aggregate them into per-application metrics. This is required for YARN usage reporting to work.
Related Name
Default Value: false
API Name: cm_yarn_enable_container_usage_aggregation
Required: true

Enable Service Level Health Alerts

Description: 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
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

Description: When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value: false
API Name: enable_config_alerts
Required: false

Log Event Retry Frequency

Description: The frequency in which the log4j event publication appender will retry sending undelivered log events to the Event server, in seconds
Related Name
Default Value: 30
API Name: log_event_retry_frequency
Required: false

Service Triggers

Description

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 following 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"}]

Related Name

Default Value

[]

API Name

service_triggers

Required

true

Service Monitor Client Config Overrides

Description: For advanced use only, a list of configuration properties that will be used by the Service Monitor instead of the current client configuration for the service.
Related Name
Default Value: <property> <name>mapreduce.output.fileoutputformat.compress</name> <value>false</value> </property> <property> <name>mapreduce.output.fileoutputformat.compress.codec</name> <value>org.apache.hadoop.io.compress.DefaultCodec</value> </property> <property> <name>io.compression.codecs</name> <value>org.apache.hadoop.io.compress.DefaultCodec, org.apache.hadoop.io.compress.GzipCodec, org.apache.hadoop.io.compress.BZip2Codec, org.apache.hadoop.io.compress.DeflateCodec, org.apache.hadoop.io.compress.SnappyCodec, org.apache.hadoop.io.compress.Lz4Codec</value> </property>
API Name: smon_client_config_overrides
Required: false

Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones.
Related Name
Default Value
API Name: smon_derived_configs_safety_valve
Required: false

Non-Admin Users Applications List Visibility Settings

Description: Controls which applications non-admin users can see in the applications list view
Related Name
Default Value: ALL
API Name: user_application_list_settings
Required: true

Active ResourceManager Detection Window

Description: The tolerance window used in YARN service tests that depend on detection of the active ResourceManager.
Related Name
Default Value: 3 minute(s)
API Name: yarn_active_resourcemanager_detection_window
Required: false

YARN Application Aggregates

Description: Controls the aggregate metrics generated for YARN applications. The structure is a JSON list of the attributes to aggregate and the entities to aggregate to. For example, if the attributeName is 'maps_completed' and the aggregationTargets is ['USER'] then the Service Monitor will create the metric 'yarn_application_maps_completed_rate' and, every ten minutes, will record the total maps completed for each user across all their YARN applications. By default it will also record the number of applications submitted ('apps_submitted_rate') for both users and pool. For a full list of the supported attributes see the YARN search page. Note that the valid aggregation targets are USER, YARN_POOL, and YARN (the service), and that these aggregate metrics can be viewed on both the reports and charts search pages.
Related Name
Default Value: [ attributeName: maps_total, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: reduces_total, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: cpu_milliseconds, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: mb_millis_maps, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: mb_millis_reduces, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: vcores_millis_maps, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: vcores_millis_reduces, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: file_bytes_read, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: file_bytes_written, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: hdfs_bytes_read, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: hdfs_bytes_written, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: cm_cpu_milliseconds, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: application_duration, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: s3a_bytes_read, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: s3a_bytes_written, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: adl_bytes_read, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] , attributeName: adl_bytes_written, aggregationTargets: [USER, YARN_POOL_USER, YARN_POOL, YARN, CLUSTER] ]
API Name: yarn_application_aggregates
Required: false

Container Metrics Sampling Interval

Description: Interval at which YARN container usage metrics are sampled. Increasing this configuration can reduce the accuracy of container usage metrics, whereas setting it too low will increase the resources used to compute container usage.
Related Name: yarn.nodemanager.container-monitor.interval-ms
Default Value: 3 second(s)
API Name: yarn_container_seconds_per_sample
Required: true

JobHistory Server Role Health Test

Description: When computing the overall YARN health, consider JobHistory Server's health
Related Name
Default Value: true
API Name: yarn_jobhistoryserver_health_enabled
Required: false

Healthy NodeManager Monitoring Thresholds

Description: The health test thresholds of the overall NodeManager health. The check returns "Concerning" health if the percentage of "Healthy" NodeManagers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" NodeManagers falls below the critical threshold.
Related Name
Default Value: Warning: 95.0 %, Critical: 90.0 %
API Name: yarn_nodemanagers_healthy_thresholds
Required: false

ResourceManager Activation Startup Tolerance

Description: The amount of time after ResourceManager(s) start that the lack of an active ResourceManager will be tolerated. This is an advanced option that does not often need to be changed.
Related Name
Default Value: 3 minute(s)
API Name: yarn_resourcemanager_activation_startup_tolerance
Required: false

Active ResourceManager Role Health Check

Description: When computing the overall YARN service health, whether to consider the active ResourceManager's health.
Related Name
Default Value: true
API Name: yarn_resourcemanagers_health_enabled
Required: false

Standby ResourceManager Health Check

Description: When computing the overall YARN service health, whether to consider the health of the standby ResourceManager.
Related Name
Default Value: true
API Name: yarn_standby_resourcemanager_health_enabled
Required: false

Other

HDFS Service

Description: Name of the HDFS service that this YARN service instance depends on
Related Name
Default Value
API Name: hdfs_service
Required: true

Serve logs over HTTP

Description: Whether to serve logs over HTTP from YARN web servers. This includes listing the logs directory at the /logs endpoint, which may be a security concern.
Related Name: hadoop.http.logs.enabled
Default Value: true
API Name: http_logs_enabled
Required: false

SSL Encryption for MapReduce Shuffle

Description: Specifies if encrypted shuffle is enabled.
Related Name: mapreduce.shuffle.ssl.enabled
Default Value: false
API Name: mapreduce_shuffle_ssl_enabled
Required: false

Queue Manager Service

Description: Name of the Queue Manager service that this YARN service instance depends on
Related Name
Default Value
API Name: queuemanager_service
Required: false

Ranger Plugin Trusted Proxy IP Address

Description: Accepts a list of IP addresses of proxy servers for trusting.
Related Name: ranger.plugin.yarn.trusted.proxy.ipaddress
Default Value
API Name: ranger_plugin_trusted_proxy_ipaddress
Required: false

Ranger Plugin Use X-Forwarded for IP Address

Description: The parameter is used for identifying the originating IP address of a user connecting to a component through proxy for audit logs.
Related Name: ranger.plugin.yarn.use.x-forwarded-for.ipaddress
Default Value: false
API Name: ranger_plugin_use_x_forwarded_for_ipaddress
Required: false

Ranger Service

Description: Name of the Ranger service that this Yarn service instance depends on
Related Name
Default Value
API Name: ranger_service
Required: false

Enable ResourceManager ACLs

Description: Whether users and groups specified in Admin ACL should be checked for authorization to perform admin operations.
Related Name: yarn.acl.enable
Default Value: true
API Name: yarn_acl_enable
Required: false

Admin ACL

Description: ACL that determines which users and groups can submit and kill applications in any pool, and can issue commands on ResourceManager roles.
Related Name: yarn.admin.acl
Default Value
API Name: yarn_admin_acl
Required: false

Node Labels

Description: Enable YARN Node Labels.
Related Name: yarn.node-labels.enabled
Default Value: true
API Name: yarn_node_labels_enabled
Required: false

Capacity Scheduler Auto Queue Deletion

Description: Enables auto created queue deletion for ResourceManager Capacity Scheduler.
Related Name: yarn_resourcemanager_capacity_scheduler_aqc_auto_deletion
Default Value: true
API Name: yarn_resourcemanager_capacity_scheduler_aqc_auto_deletion
Required: false

Capacity Scheduler Preemption

Description: Enables Preemption for ResourceManager Capacity Scheduler.
Related Name: yarn_resourcemanager_capacity_scheduler_preemption
Default Value: true
API Name: yarn_resourcemanager_capacity_scheduler_preemption
Required: false

Node Manager Graceful Decommission Timeout

Description: This is the maximum time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. (-1 indicates infinite timeout, 0 indicates non-graceful)
Related Name: yarn.resourcemanager.nodemanager-graceful-decommission-timeout-secs
Default Value: 0 second(s)
API Name: yarn_resourcemanager_nodemanager_graceful_decommission_timeout_secs
Required: false

RM-HA Cluster ID

Description: Cluster ID used when ResourceManager is Highly Available.
Related Name: yarn.resourcemanager.cluster-id
Default Value: yarnRM
API Name: yarn_rm_ha_cluster_id
Required: false

ZooKeeper Service

Description: Name of the ZooKeeper service that this YARN service instance depends on
Related Name
Default Value
API Name: zookeeper_service
Required: false

Proxy

Llama Proxy User Groups

Description: Comma-delimited list of groups that you want to allow the Llama (AM for Impala) 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_'.
Related Name: hadoop.proxyuser.llama.groups
Default Value: *
API Name: llama_proxy_user_groups_list
Required: false

Llama Proxy User Hosts

Description: Comma-delimited list of hosts where you want to allow the Llama (AM for Impala) 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'.
Related Name: hadoop.proxyuser.llama.hosts
Default Value: *
API Name: llama_proxy_user_hosts_list
Required: false

Resource Management

Limit Nonsecure Container Executor Users

Description: This determines the user Linux container executor should run as on a non-secure cluster. If this value is set to true, then all containers will be launched as the user specified in yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user. If this value is set to false, then containers will run as the user who submitted the application.
Related Name
Default Value: true
API Name: yarn_nodemanager_linux_container_executor_nonsecure_mode_limit_users
Required: false

UNIX User for Nonsecure Mode with Linux Container Executor

Description: UNIX user that containers run as when Linux-container-executor is used in nonsecure mode.
Related Name: yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user
Default Value: nobody
API Name: yarn_nodemanager_linux_container_executor_nonsecure_mode_local_user
Required: false

Allow Undeclared Pools

Description: When set to true, pools specified in applications but not explicitly configured, are created at runtime with default settings. When set to false, applications specifying pools not explicitly configured run in a pool named default. This setting applies when an application explicitly specifies a pool and when the application runs in a pool named with the username associated with the application.
Related Name: yarn.scheduler.fair.allow-undeclared-pools
Default Value: true
API Name: yarn_scheduler_fair_allow_undeclared_pools
Required: false

Use CGroups for Resource Management

Description: Whether YARN creates a cgroup per container, thereby isolating the CPU usage of containers. When set, yarn.nodemanager.linux-container-executor.resources-handler.class is configured to org.apache.hadoop.yarn.server.nodemanager.util.CgroupsLCEResourcesHandler. The host (in Cloudera Manager) must have cgroups enabled. The number of shares allocated to all YARN containers is configured by adjusting the CPU shares value of the Node Manager in the Resource Management configuration group.
Related Name: yarn.nodemanager.linux-container-executor.resources-handler.class
Default Value: false
API Name: yarn_service_cgroups
Required: false

Always Use Linux Container Executor

Description: Whether YARN uses the Linux Container Executor both in secure (Kerberos) and insecure (not Kerberos) environments. Cgroups enforcement only works when the Linux Container Executor is used.
Related Name: yarn.nodemanager.container-executor.class
Default Value: false
API Name: yarn_service_lce_always
Required: false

Resource Types

Description: Resource definition can be extended to include arbitrary countable resources. A countable resource is a resource that is consumed while a container is running, but is released afterwards. CPU, memory and GPU are countable resources.
Related Name
Default Value
API Name: resource_types
Required: false

Security

Enable Kerberos Authentication for HTTP Web-Consoles

Description: Enables Kerberos authentication for Hadoop HTTP web consoles for all roles of this service using the SPNEGO protocol. Note: This is effective only if Kerberos is enabled for the HDFS service.
Related Name
Default Value: false
API Name: hadoop_secure_web_ui
Required: false

Kerberos Principal

Description: Kerberos principal short name used by all roles of this service.
Related Name
Default Value: yarn
API Name: kerberos_princ_name
Required: true

Hive LLAP Kerberos Conf Staging Path

Description: Staging directory for Hive LLAP Kerberos Configuration. This should generally not be changed.
Related Name: hive_llap_kerberos_staging_path
Default Value: /var/lib/hadoop-yarn
API Name: llap_kerberos_staging_path
Required: false

Ranger DFS Audit Path

Description: The DFS path on which Ranger audits are written. The special placeholder '${ranger_base_audit_url}' should be used as the prefix, in order to use the centralized location defined in the Ranger service.
Related Name: xasecure.audit.destination.hdfs.dir
Default Value: $ranger_base_audit_url/yarn
API Name: ranger_audit_hdfs_dir
Required: false

Ranger Audit DFS Spool Dir

Description: Spool directory for Ranger audits being written to DFS.
Related Name: xasecure.audit.destination.hdfs.batch.filespool.dir
Default Value: /var/log/yarn/audit/hdfs/spool
API Name: ranger_audit_hdfs_spool_dir
Required: false

Ranger Audit Solr Spool Dir

Description: Spool directory for Ranger audits being written to Solr.
Related Name: xasecure.audit.destination.solr.batch.filespool.dir
Default Value: /var/log/yarn/audit/solr/spool
API Name: ranger_audit_solr_spool_dir
Required: false

Ranger Policy Cache Directory

Description: The directory where Ranger security policies are cached locally.
Related Name: ranger.plugin.yarn.policy.cache.dir
Default Value: /var/lib/ranger/yarn/policy-cache
API Name: ranger_policy_cache_dir
Required: false

TLS/SSL Client Truststore File Location

Description: Path to the truststore file used when roles of this service act as TLS/SSL clients. Overrides the cluster-wide default truststore location set in HDFS. This truststore must be in JKS format. The truststore contains certificates of trusted servers, or of Certificate Authorities trusted to identify servers. The contents of the truststore can be modified without restarting any roles. By default, changes to its contents are picked up within ten seconds. If not set, the default Java truststore is used to verify certificates.
Related Name: ssl.client.truststore.location
Default Value
API Name: ssl_client_truststore_location
Required: false

TLS/SSL Client Truststore File Password

Description: Password for the TLS/SSL client truststore. Overrides the cluster-wide default truststore password set in HDFS.
Related Name: ssl.client.truststore.password
Default Value
API Name: ssl_client_truststore_password
Required: false

Hadoop TLS/SSL Server Keystore Key Password

Description: Password that protects the private key contained in the server keystore used for encrypted shuffle and encrypted web UIs. Applies to all configurations of daemon roles of this service.
Related Name: ssl.server.keystore.keypassword
Default Value
API Name: ssl_server_keystore_keypassword
Required: false

Hadoop TLS/SSL Server Keystore File Location

Description: Path to the keystore file containing the server certificate and private key used for encrypted shuffle and encrypted web UIs. Applies to configurations of all daemon roles of this service.
Related Name: ssl.server.keystore.location
Default Value
API Name: ssl_server_keystore_location
Required: false

Hadoop TLS/SSL Server Keystore File Password

Description: Password for the server keystore file used for encrypted shuffle and encrypted web UIs. Applies to configurations of all daemon roles of this service.
Related Name: ssl.server.keystore.password
Default Value
API Name: ssl_server_keystore_password
Required: false

SSL/TLS Cipher Suite

Description: The SSL/TLS cipher suites to use. "Modern 2018" is a modern set of cipher suites as of 2018, according to the Mozilla server-side TLS recommendations. These cipher suites use strong cryptography and are preferred unless interaction with older clients is required. These modern cipher suites are compatible with Firefox 27, Chrome 22, Internet Explorer 11, Opera 14, Safari 7, Android 4.4, and Java 8. "Intermediate 2018" is an intermediate set of cipher suites as of 2018, according to the Mozilla server-side TLS recommendations. Select the Intermediate 2018 cipher suites if you require compatibility with a wider range of clients, legacy browsers, or older Linux tools.
Related Name: ssl.server.exclude.cipher.list
Default Value: modern2018
API Name: tls_ciphers
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Configuration Validator: Deploy Directory

Description: Whether to suppress configuration warnings produced by the Deploy Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_client_config_root_dir
Required: true

Suppress Configuration Validator: Allowed System Users

Description: Whether to suppress configuration warnings produced by the Allowed System Users configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_container_executor_allowed_system_users
Required: true

Suppress Configuration Validator: Banned System Users

Description: Whether to suppress configuration warnings produced by the Banned System Users configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_container_executor_banned_users
Required: true

Suppress Configuration Validator: Container Executor Group

Description: Whether to suppress configuration warnings produced by the Container Executor Group configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_container_executor_group
Required: true

Suppress Configuration Validator: NodeManager GPU Devices Allowed

Description: Whether to suppress configuration warnings produced by the NodeManager GPU Devices Allowed configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_gpu_plugin_allowed_devices
Required: true

Suppress Configuration Validator: NodeManager GPU Detection Executable

Description: Whether to suppress configuration warnings produced by the NodeManager GPU Detection Executable configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_gpu_plugin_detector_path
Required: true

Suppress Configuration Validator: Running Job History Location

Description: Whether to suppress configuration warnings produced by the Running Job History Location configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hadoop_job_history_dir
Required: true

Suppress Configuration Validator: Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hadoop_metrics2_safety_valve
Required: true

Suppress Configuration Validator: System Group

Description: Whether to suppress configuration warnings produced by the System Group configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_history_process_groupname
Required: true

Suppress Configuration Validator: System User

Description: Whether to suppress configuration warnings produced by the System User configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_history_process_username
Required: true

Suppress Configuration Validator: I/O Sort Factor

Description: Whether to suppress configuration warnings produced by the I/O Sort Factor configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_io_sort_factor
Required: true

Suppress Configuration Validator: JobHistory Server Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: Whether to suppress configuration warnings produced by the JobHistory Server Advanced Configuration Snippet (Safety Valve) for yarn-site.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_jobhistory_config_safety_valve
Required: true

Suppress Configuration Validator: JobHistory Server Advanced Configuration Snippet (Safety Valve) for mapred-site.xml

Description: Whether to suppress configuration warnings produced by the JobHistory Server Advanced Configuration Snippet (Safety Valve) for mapred-site.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_jobhistory_mapred_safety_valve
Required: true

Suppress Configuration Validator: JobHistory Server Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the JobHistory Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_jobhistory_role_env_safety_valve
Required: true

Suppress Configuration Validator: Role-Specific Kerberos Principal

Description: Whether to suppress configuration warnings produced by the Role-Specific Kerberos Principal configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_kerberos_role_princ_name
Required: true

Suppress Configuration Validator: CGroups Hierarchy

Description: Whether to suppress configuration warnings produced by the CGroups Hierarchy configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_linux_container_executor_cgroups_hierarchy
Required: true

Suppress Configuration Validator: ResourceManager Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the ResourceManager Logging Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Configuration Validator: Rules to Extract Events from Log Files

Description: Whether to suppress configuration warnings produced by the Rules to Extract Events from Log Files configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_log_event_whitelist
Required: true

Suppress Configuration Validator: Healthchecker Script Arguments

Description: Whether to suppress configuration warnings produced by the Healthchecker Script Arguments configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapred_healthchecker_script_args
Required: true

Suppress Configuration Validator: Healthchecker Script Path

Description: Whether to suppress configuration warnings produced by the Healthchecker Script Path configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapred_healthchecker_script_path
Required: true

Suppress Configuration Validator: Compression Codec of MapReduce Map Output

Description: Whether to suppress configuration warnings produced by the Compression Codec of MapReduce Map Output configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapred_map_output_compression_codec
Required: true

Suppress Configuration Validator: Compression Codec of MapReduce Job Output

Description: Whether to suppress configuration warnings produced by the Compression Codec of MapReduce Job Output configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapred_output_compression_codec
Required: true

Suppress Configuration Validator: MR Application Environment

Description: Whether to suppress configuration warnings produced by the MR Application Environment configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_admin_user_env
Required: true

Suppress Configuration Validator: Maximum Number of Attempts for MapReduce Jobs

Description: Whether to suppress configuration warnings produced by the Maximum Number of Attempts for MapReduce Jobs configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_am_max_attempts
Required: true

Suppress Configuration Validator: MR Application Classpath

Description: Whether to suppress configuration warnings produced by the MR Application Classpath configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_application_classpath
Required: true

Suppress Configuration Validator: MR Application Framework Path

Description: Whether to suppress configuration warnings produced by the MR Application Framework Path configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_application_framework_path
Required: true

Suppress Configuration Validator: MapReduce Client Advanced Configuration Snippet (Safety Valve) for mapred-site.xml

Description: Whether to suppress configuration warnings produced by the MapReduce Client Advanced Configuration Snippet (Safety Valve) for mapred-site.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_client_config_safety_valve
Required: true

Suppress Configuration Validator: Gateway Client Environment Advanced Configuration Snippet (Safety Valve) for hadoop-env.sh

Description: Whether to suppress configuration warnings produced by the Gateway Client Environment Advanced Configuration Snippet (Safety Valve) for hadoop-env.sh configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_client_env_safety_valve
Required: true

Suppress Configuration Validator: Client Java Configuration Options

Description: Whether to suppress configuration warnings produced by the Client Java Configuration Options configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_client_java_opts
Required: true

Suppress Configuration Validator: ACL For Modifying A Job

Description: Whether to suppress configuration warnings produced by the ACL For Modifying A Job configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_job_acl_modify_job
Required: true

Suppress Configuration Validator: ACL For Viewing A Job

Description: Whether to suppress configuration warnings produced by the ACL For Viewing A Job configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_job_acl_view_job
Required: true

Suppress Configuration Validator: Redacted MapReduce Job Properties

Description: Whether to suppress configuration warnings produced by the Redacted MapReduce Job Properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_job_redacted_properties
Required: true

Suppress Configuration Validator: MapReduce JobHistory Server Port

Description: Whether to suppress configuration warnings produced by the MapReduce JobHistory Server Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_jobhistory_address
Required: true

Suppress Configuration Validator: MapReduce JobHistory Server Admin Interface Port

Description: Whether to suppress configuration warnings produced by the MapReduce JobHistory Server Admin Interface Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_jobhistory_admin_address
Required: true

Suppress Configuration Validator: MapReduce JobHistory Web Application HTTP Port

Description: Whether to suppress configuration warnings produced by the MapReduce JobHistory Web Application HTTP Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_jobhistory_webapp_address
Required: true

Suppress Configuration Validator: MapReduce JobHistory Web Application HTTPS Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the MapReduce JobHistory Web Application HTTPS Port (TLS/SSL) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_jobhistory_webapp_https_address
Required: true

Suppress Configuration Validator: Map Task Java Opts Base

Description: Whether to suppress configuration warnings produced by the Map Task Java Opts Base configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_map_java_opts
Required: true

Suppress Configuration Validator: Map Task Maximum Heap Size Validator

Description: Whether to suppress configuration warnings produced by the Map Task Maximum Heap Size Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_map_java_opts_max_heap_mapreduce_map_memory_mb_validator
Required: true

Suppress Configuration Validator: Reduce Task Java Opts Base

Description: Whether to suppress configuration warnings produced by the Reduce Task Java Opts Base configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_reduce_java_opts
Required: true

Suppress Configuration Validator: Reduce Task Maximum Heap Size Validator

Description: Whether to suppress configuration warnings produced by the Reduce Task Maximum Heap Size Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_reduce_java_opts_max_heap_mapreduce_reduce_memory_mb_validator
Required: true

Suppress Configuration Validator: Job Submit Replication Validator

Description: Whether to suppress configuration warnings produced by the Job Submit Replication Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mapreduce_replication_validator
Required: true

Suppress Configuration Validator: Java Configuration Options for JobHistory Server

Description: Whether to suppress configuration warnings produced by the Java Configuration Options for JobHistory Server configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mr2_jobhistory_java_opts
Required: true

Suppress Configuration Validator: JobHistory Server Log Directory

Description: Whether to suppress configuration warnings produced by the JobHistory Server Log Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_mr2_jobhistory_log_dir
Required: true

Suppress Configuration Validator: Java Configuration Options for NodeManager

Description: Whether to suppress configuration warnings produced by the Java Configuration Options for NodeManager configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_node_manager_java_opts
Required: true

Suppress Configuration Validator: NodeManager Log Directory

Description: Whether to suppress configuration warnings produced by the NodeManager Log Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_node_manager_log_dir
Required: true

Suppress Configuration Validator: NodeManager Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: Whether to suppress configuration warnings produced by the NodeManager Advanced Configuration Snippet (Safety Valve) for yarn-site.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_nodemanager_config_safety_valve
Required: true

Suppress Configuration Validator: NodeManager Advanced Configuration Snippet (Safety Valve) for mapred-site.xml

Description: Whether to suppress configuration warnings produced by the NodeManager Advanced Configuration Snippet (Safety Valve) for mapred-site.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_nodemanager_mapred_safety_valve
Required: true

Suppress Configuration Validator: NodeManager Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the NodeManager Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_nodemanager_role_env_safety_valve
Required: true

Suppress Configuration Validator: NodeManager Web Application HTTPS Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the NodeManager Web Application HTTPS Port (TLS/SSL) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_nodemanager_webserver_https_port
Required: true

Suppress Configuration Validator: NodeManager Web Application HTTP Port

Description: Whether to suppress configuration warnings produced by the NodeManager Web Application HTTP Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_nodemanager_webserver_port
Required: true

Suppress Configuration Validator: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Configuration Validator: Java Configuration Options for ResourceManager

Description: Whether to suppress configuration warnings produced by the Java Configuration Options for ResourceManager configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_resource_manager_java_opts
Required: true

Suppress Configuration Validator: ResourceManager Log Directory

Description: Whether to suppress configuration warnings produced by the ResourceManager Log Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_resource_manager_log_dir
Required: true

Suppress Configuration Validator: Capacity Scheduler Configuration Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Capacity Scheduler Configuration Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_resourcemanager_capacity_scheduler_configuration
Required: true

Suppress Configuration Validator: ResourceManager Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: Whether to suppress configuration warnings produced by the ResourceManager Advanced Configuration Snippet (Safety Valve) for yarn-site.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_resourcemanager_config_safety_valve
Required: true

Suppress Configuration Validator: Fair Scheduler XML Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Fair Scheduler XML Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_resourcemanager_fair_scheduler_configuration
Required: true

Suppress Configuration Validator: ResourceManager Advanced Configuration Snippet (Safety Valve) for mapred-site.xml

Description: Whether to suppress configuration warnings produced by the ResourceManager Advanced Configuration Snippet (Safety Valve) for mapred-site.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_resourcemanager_mapred_safety_valve
Required: true

Suppress Configuration Validator: ResourceManager Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the ResourceManager Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_resourcemanager_role_env_safety_valve
Required: true

Suppress Configuration Validator: ResourceManager Web Application HTTPS Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the ResourceManager Web Application HTTPS Port (TLS/SSL) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_resourcemanager_webserver_https_port
Required: true

Suppress Configuration Validator: ResourceManager Web Application HTTP Port

Description: Whether to suppress configuration warnings produced by the ResourceManager Web Application HTTP Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_resourcemanager_webserver_port
Required: true

Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Configuration Validator: ResourceManager Advanced Configuration Snippet (Safety Valve) for nodes_allow.txt

Description: Whether to suppress configuration warnings produced by the ResourceManager Advanced Configuration Snippet (Safety Valve) for nodes_allow.txt configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_rm_hosts_allow_safety_valve
Required: true

Suppress Configuration Validator: ResourceManager Advanced Configuration Snippet (Safety Valve) for nodes_exclude.txt

Description: Whether to suppress configuration warnings produced by the ResourceManager Advanced Configuration Snippet (Safety Valve) for nodes_exclude.txt configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_rm_hosts_exclude_safety_valve
Required: true

Suppress Configuration Validator: Role Triggers

Description: Whether to suppress configuration warnings produced by the Role Triggers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Configuration Validator: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Configuration Validator: ApplicationMaster Environment

Description: Whether to suppress configuration warnings produced by the ApplicationMaster Environment configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_app_mapreduce_am_admin_user_env
Required: true

Suppress Configuration Validator: ApplicationMaster Java Opts Base

Description: Whether to suppress configuration warnings produced by the ApplicationMaster Java Opts Base configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_app_mapreduce_am_command_opts
Required: true

Suppress Configuration Validator: ApplicationMaster Java Maximum Heap Size Validator

Description: Whether to suppress configuration warnings produced by the ApplicationMaster Java Maximum Heap Size Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_app_mapreduce_am_max_heap_yarn_app_mapreduce_am_resource_mb_validator
Required: true

Suppress Configuration Validator: MapReduce ApplicationMaster Staging Root Directory

Description: Whether to suppress configuration warnings produced by the MapReduce ApplicationMaster Staging Root Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_app_mapreduce_am_staging_dir
Required: true

Suppress Configuration Validator: YARN Client Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: Whether to suppress configuration warnings produced by the YARN Client Advanced Configuration Snippet (Safety Valve) for yarn-site.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_client_config_safety_valve
Required: true

Suppress Configuration Validator: Allowed Devices for Docker Containers

Description: Whether to suppress configuration warnings produced by the Allowed Devices for Docker Containers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_docker_allowed_devices
Required: true

Suppress Configuration Validator: Allowed Read-Only Mounts for Docker Containers

Description: Whether to suppress configuration warnings produced by the Allowed Read-Only Mounts for Docker Containers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_docker_allowed_ro_mounts
Required: true

Suppress Configuration Validator: Allowed Read-Write Mounts for Docker Containers

Description: Whether to suppress configuration warnings produced by the Allowed Read-Write Mounts for Docker Containers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_docker_allowed_rw_mounts
Required: true

Suppress Configuration Validator: Allowed Volume Drivers for Docker Containers

Description: Whether to suppress configuration warnings produced by the Allowed Volume Drivers for Docker Containers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_docker_allowed_volume_drivers
Required: true

Suppress Configuration Validator: Docker Binary Path

Description: Whether to suppress configuration warnings produced by the Docker Binary Path configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_docker_binary
Required: true

Suppress Configuration Validator: Validates configuration of YARN NodeManagers when Docker on YARN feature is enabled.

Description: Whether to suppress configuration warnings produced by the Validates configuration of YARN NodeManagers when Docker on YARN feature is enabled. configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_docker_on_yarn_validator
Required: true

Suppress Configuration Validator: Trusted Registries for Docker Containers

Description: Whether to suppress configuration warnings produced by the Trusted Registries for Docker Containers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_docker_trusted_registries
Required: true

Suppress Configuration Validator: YARN FPGA Resources Validator

Description: Whether to suppress configuration warnings produced by the YARN FPGA Resources Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_fpga_validator
Required: true

Suppress Configuration Validator: YARN GPU Resources Validator

Description: Whether to suppress configuration warnings produced by the YARN GPU Resources Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_gpu_validator
Required: true

Suppress Configuration Validator: NodeManager IPC Address

Description: Whether to suppress configuration warnings produced by the NodeManager IPC Address configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_address
Required: true

Suppress Configuration Validator: Containers Environment Variable

Description: Whether to suppress configuration warnings produced by the Containers Environment Variable configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_admin_env
Required: true

Suppress Configuration Validator: Containers Environment Variables Whitelist

Description: Whether to suppress configuration warnings produced by the Containers Environment Variables Whitelist configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_env_whitelist
Required: true

Suppress Configuration Validator: FPGA initializer script

Description: Whether to suppress configuration warnings produced by the FPGA initializer script configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_fpga_plugin_initializer_script
Required: true

Suppress Configuration Validator: NodeManager Local Directories

Description: Whether to suppress configuration warnings produced by the NodeManager Local Directories configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_local_dirs
Required: true

Suppress Configuration Validator: Localizer Port

Description: Whether to suppress configuration warnings produced by the Localizer Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_localizer_address
Required: true

Suppress Configuration Validator: Minimum Hard Limit for Log Aggregation Roll Monitoring Interval

Description: Whether to suppress configuration warnings produced by the Minimum Hard Limit for Log Aggregation Roll Monitoring Interval configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_log_aggregation_roll_monitoring_interval_seconds_min
Required: true

Suppress Configuration Validator: Log Aggregation Roll Monitoring Interval Minimum Validator

Description: Whether to suppress configuration warnings produced by the Log Aggregation Roll Monitoring Interval Minimum Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_log_aggregation_roll_monitoring_interval_seconds_minimum_validator
Required: true

Suppress Configuration Validator: NodeManager Container Log Directories

Description: Whether to suppress configuration warnings produced by the NodeManager Container Log Directories configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_log_dirs
Required: true

Suppress Configuration Validator: NodeManager Recovery Directory

Description: Whether to suppress configuration warnings produced by the NodeManager Recovery Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_recovery_dir
Required: true

Suppress Configuration Validator: Remote App Log Directory

Description: Whether to suppress configuration warnings produced by the Remote App Log Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_remote_app_log_dir
Required: true

Suppress Configuration Validator: Remote App Log Directory Suffix

Description: Whether to suppress configuration warnings produced by the Remote App Log Directory Suffix configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_remote_app_log_dir_suffix
Required: true

Suppress Configuration Validator: Allowed FPGA devices

Description: Whether to suppress configuration warnings produced by the Allowed FPGA devices configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_resource_plugins_fpga_allowed_fpga_devices
Required: true

Suppress Configuration Validator: List of available FPGA devices

Description: Whether to suppress configuration warnings produced by the List of available FPGA devices configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_resource_plugins_fpga_available_devices
Required: true

Suppress Configuration Validator: Path to FPGA (aocl) tool

Description: Whether to suppress configuration warnings produced by the Path to FPGA (aocl) tool configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_resource_plugins_fpga_path_to_discovery_executables
Required: true

Suppress Configuration Validator: Allowed Linux Runtimes

Description: Whether to suppress configuration warnings produced by the Allowed Linux Runtimes configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_allowed_runtimes
Required: true

Suppress Configuration Validator: Allowed Docker Container Networks

Description: Whether to suppress configuration warnings produced by the Allowed Docker Container Networks configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_docker_allowed_container_networks
Required: true

Suppress Configuration Validator: Docker Capabilities

Description: Whether to suppress configuration warnings produced by the Docker Capabilities configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_docker_capabilities
Required: true

Suppress Configuration Validator: Default Docker Container Network

Description: Whether to suppress configuration warnings produced by the Default Docker Container Network configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_docker_default_container_network
Required: true

Suppress Configuration Validator: Default Read-Only Mounts for Docker Containers

Description: Whether to suppress configuration warnings produced by the Default Read-Only Mounts for Docker Containers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_docker_default_ro_mounts
Required: true

Suppress Configuration Validator: Default Read-Write Mounts for Docker Containers

Description: Whether to suppress configuration warnings produced by the Default Read-Write Mounts for Docker Containers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_docker_default_rw_mounts
Required: true

Suppress Configuration Validator: Default Tempfs Mounts for Docker Containers

Description: Whether to suppress configuration warnings produced by the Default Tempfs Mounts for Docker Containers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_docker_default_tmpfs_mounts
Required: true

Suppress Configuration Validator: ACL for Privileged Docker Containers

Description: Whether to suppress configuration warnings produced by the ACL for Privileged Docker Containers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_nodemanager_runtime_linux_docker_privileged_containers_acl
Required: true

Suppress Configuration Validator: ResourceManager Address

Description: Whether to suppress configuration warnings produced by the ResourceManager Address configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_resourcemanager_address
Required: true

Suppress Configuration Validator: Administration Address

Description: Whether to suppress configuration warnings produced by the Administration Address configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_resourcemanager_admin_address
Required: true

Suppress Configuration Validator: ApplicationMaster Maximum Attempts

Description: Whether to suppress configuration warnings produced by the ApplicationMaster Maximum Attempts configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_resourcemanager_am_max_retries
Required: true

Suppress Configuration Validator: Resource Tracker Address

Description: Whether to suppress configuration warnings produced by the Resource Tracker Address configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_resourcemanager_resource_tracker_address
Required: true

Suppress Configuration Validator: Scheduler Address

Description: Whether to suppress configuration warnings produced by the Scheduler Address configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_resourcemanager_scheduler_address
Required: true

Suppress Configuration Validator: YARN Resource Types Validator

Description: Whether to suppress configuration warnings produced by the YARN Resource Types Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_yarn_resources_validator
Required: true

Suppress Parameter Validation: Cloudera Manager Container Usage Metrics Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Cloudera Manager Container Usage Metrics Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_cm_yarn_container_usage_input_dir
Required: true

Suppress Parameter Validation: Container Usage MapReduce Job Pool

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Container Usage MapReduce Job Pool parameter.
Related Name
Default Value: false
API Name: service_config_suppression_cm_yarn_container_usage_job_pool
Required: true

Suppress Parameter Validation: Container Usage MapReduce Job User

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Container Usage MapReduce Job User parameter.
Related Name
Default Value: false
API Name: service_config_suppression_cm_yarn_container_usage_job_user
Required: true

Suppress Parameter Validation: Container Usage Output Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Container Usage Output Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_cm_yarn_container_usage_output_dir
Required: true

Suppress Configuration Validator: Gateway Count Validator

Description: Whether to suppress configuration warnings produced by the Gateway Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_gateway_count_validator
Required: true

Suppress Configuration Validator: Secure Web UI Validator

Description: Whether to suppress configuration warnings produced by the Secure Web UI Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hadoop_secure_web_ui
Required: true

Suppress Configuration Validator: Hadoop TLS/SSL Validator

Description: Whether to suppress configuration warnings produced by the Hadoop TLS/SSL Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hadoop_ssl_validator
Required: true

Suppress Parameter Validation: System User's Home Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the System User's Home Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hdfs_user_home_dir
Required: true

Suppress Configuration Validator: JobHistory Server Count Validator

Description: Whether to suppress configuration warnings produced by the JobHistory Server Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_jobhistory_count_validator
Required: true

Suppress Parameter Validation: Kerberos Principal

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Principal parameter.
Related Name
Default Value: false
API Name: service_config_suppression_kerberos_princ_name
Required: true

Suppress Parameter Validation: Llama Proxy User Groups

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Llama Proxy User Groups parameter.
Related Name
Default Value: false
API Name: service_config_suppression_llama_proxy_user_groups_list
Required: true

Suppress Parameter Validation: Llama Proxy User Hosts

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Llama Proxy User Hosts parameter.
Related Name
Default Value: false
API Name: service_config_suppression_llama_proxy_user_hosts_list
Required: true

Suppress Parameter Validation: Hive LLAP Kerberos Conf Staging Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive LLAP Kerberos Conf Staging Path parameter.
Related Name
Default Value: false
API Name: service_config_suppression_llap_kerberos_staging_path
Required: true

Suppress Parameter Validation: HDFS Replication Advanced Configuration Snippet (Safety Valve) for mapred-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HDFS Replication Advanced Configuration Snippet (Safety Valve) for mapred-site.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_mapreduce_service_replication_config_safety_valve
Required: true

Suppress Configuration Validator: NodeManager Count Validator

Description: Whether to suppress configuration warnings produced by the NodeManager Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_nodemanager_count_validator
Required: true

Suppress Parameter Validation: System Group

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter.
Related Name
Default Value: false
API Name: service_config_suppression_process_groupname
Required: true

Suppress Parameter Validation: System User

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter.
Related Name
Default Value: false
API Name: service_config_suppression_process_username
Required: true

Suppress Parameter Validation: Ranger DFS Audit Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger DFS Audit Path parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_audit_hdfs_dir
Required: true

Suppress Parameter Validation: Ranger Audit DFS Spool Dir

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Audit DFS Spool Dir parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_audit_hdfs_spool_dir
Required: true

Suppress Parameter Validation: YARN Service Advanced Configuration Snippet (Safety Valve) for ranger-yarn-audit.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Service Advanced Configuration Snippet (Safety Valve) for ranger-yarn-audit.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_audit_safety_valve
Required: true

Suppress Parameter Validation: Ranger Audit Solr Spool Dir

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Audit Solr Spool Dir parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_audit_solr_spool_dir
Required: true

Suppress Parameter Validation: Ranger Plugin Trusted Proxy IP Address

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Plugin Trusted Proxy IP Address parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_plugin_trusted_proxy_ipaddress
Required: true

Suppress Parameter Validation: Ranger Policy Cache Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Policy Cache Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_policy_cache_dir
Required: true

Suppress Parameter Validation: YARN Service Advanced Configuration Snippet (Safety Valve) for ranger-yarn-policymgr-ssl.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Service Advanced Configuration Snippet (Safety Valve) for ranger-yarn-policymgr-ssl.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_policymgr_ssl_safety_valve
Required: true

Suppress Parameter Validation: YARN Service Advanced Configuration Snippet (Safety Valve) for ranger-yarn-security.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Service Advanced Configuration Snippet (Safety Valve) for ranger-yarn-security.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_security_safety_valve
Required: true

Suppress Configuration Validator: ResourceManager Count Validator

Description: Whether to suppress configuration warnings produced by the ResourceManager Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_resourcemanager_count_validator
Required: true

Suppress Parameter Validation: Service Triggers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter.
Related Name
Default Value: false
API Name: service_config_suppression_service_triggers
Required: true

Suppress Parameter Validation: Service Monitor Client Config Overrides

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Client Config Overrides parameter.
Related Name
Default Value: false
API Name: service_config_suppression_smon_client_config_overrides
Required: true

Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: service_config_suppression_smon_derived_configs_safety_valve
Required: true

Suppress Parameter Validation: TLS/SSL Client Truststore File Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the TLS/SSL Client Truststore File Location parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ssl_client_truststore_location
Required: true

Suppress Parameter Validation: TLS/SSL Client Truststore File Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the TLS/SSL Client Truststore File Password parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ssl_client_truststore_password
Required: true

Suppress Parameter Validation: Hadoop TLS/SSL Server Keystore Key Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hadoop TLS/SSL Server Keystore Key Password parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ssl_server_keystore_keypassword
Required: true

Suppress Parameter Validation: Hadoop TLS/SSL Server Keystore File Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hadoop TLS/SSL Server Keystore File Location parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ssl_server_keystore_location
Required: true

Suppress Parameter Validation: Hadoop TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hadoop TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ssl_server_keystore_password
Required: true

Suppress Parameter Validation: Admin ACL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin ACL parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_admin_acl
Required: true

Suppress Parameter Validation: YARN Application Aggregates

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Application Aggregates parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_application_aggregates
Required: true

Suppress Parameter Validation: YARN Application Classpath

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Application Classpath parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_application_classpath
Required: true

Suppress Parameter Validation: YARN Service Advanced Configuration Snippet (Safety Valve) for core-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Service Advanced Configuration Snippet (Safety Valve) for core-site.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_core_site_safety_valve
Required: true

Suppress Parameter Validation: YARN Service Advanced Configuration Snippet (Safety Valve) for hadoop-policy.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Service Advanced Configuration Snippet (Safety Valve) for hadoop-policy.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_hadoop_policy_config_safety_valve
Required: true

Suppress Parameter Validation: Supported Log Aggregation File Formats

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Supported Log Aggregation File Formats parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_log_aggregation_file_formats
Required: true

Suppress Parameter Validation: Remote App Log Directory for IFile Format

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Remote App Log Directory for IFile Format parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_log_aggregation_ifile_remote_app_log_dir
Required: true

Suppress Parameter Validation: Remote App Log Directory Suffix for IFile Format

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Remote App Log Directory Suffix for IFile Format parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_log_aggregation_ifile_remote_app_log_dir_suffix
Required: true

Suppress Parameter Validation: Remote App Log Directory for TFile Format

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Remote App Log Directory for TFile Format parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_log_aggregation_tfile_remote_app_log_dir
Required: true

Suppress Parameter Validation: Remote App Log Directory Suffix for TFile Format

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Remote App Log Directory Suffix for TFile Format parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_log_aggregation_tfile_remote_app_log_dir_suffix
Required: true

Suppress Parameter Validation: UNIX User for Nonsecure Mode with Linux Container Executor

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the UNIX User for Nonsecure Mode with Linux Container Executor parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_nodemanager_linux_container_executor_nonsecure_mode_local_user
Required: true

Suppress Configuration Validator: Yarn Queue Manager Validator

Description: Whether to suppress configuration warnings produced by the Yarn Queue Manager Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_queue_manager_validator
Required: true

Suppress Configuration Validator: YARN Resource Types Validator

Description: Whether to suppress configuration warnings produced by the YARN Resource Types Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_resources_validator
Required: true

Suppress Parameter Validation: RM-HA Cluster ID

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the RM-HA Cluster ID parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_rm_ha_cluster_id
Required: true

Suppress Parameter Validation: YARN Service Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Service Advanced Configuration Snippet (Safety Valve) for yarn-site.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_service_config_safety_valve
Required: true

Suppress Parameter Validation: YARN Service Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Service Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_service_env_safety_valve
Required: true

Suppress Parameter Validation: YARN Service MapReduce Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Service MapReduce Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_service_mapred_safety_valve
Required: true

Suppress Parameter Validation: HDFS Replication Advanced Configuration Snippet (Safety Valve) for yarn-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HDFS Replication Advanced Configuration Snippet (Safety Valve) for yarn-site.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_service_replication_config_safety_valve
Required: true

Suppress Parameter Validation: YARN Services Dependencies Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Services Dependencies Path parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_services_framework_path
Required: true

Suppress Parameter Validation: YARN Service Advanced Configuration Snippet (Safety Valve) for ssl-client.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Service Advanced Configuration Snippet (Safety Valve) for ssl-client.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_ssl_client_safety_valve
Required: true

Suppress Parameter Validation: YARN Service Advanced Configuration Snippet (Safety Valve) for ssl-server.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Service Advanced Configuration Snippet (Safety Valve) for ssl-server.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_yarn_ssl_server_safety_valve
Required: true

Suppress Health Test: JobHistory Server Health

Description: Whether to suppress the results of the JobHistory 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.
Related Name
Default Value: false
API Name: service_health_suppression_yarn_jobhistory_health
Required: true

Suppress Health Test: NodeManager Health

Description: Whether to suppress the results of the NodeManager 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.
Related Name
Default Value: false
API Name: service_health_suppression_yarn_node_managers_healthy
Required: true

Suppress Health Test: ResourceManager Health

Description: Whether to suppress the results of the ResourceManager 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.
Related Name
Default Value: false
API Name: service_health_suppression_yarn_resourcemanagers_health
Required: true

Suppress Health Test: YARN Container Usage Aggregation

Description: Whether to suppress the results of the YARN Container Usage Aggregation 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.
Related Name
Default Value: false
API Name: service_health_suppression_yarn_usage_aggregation_health
Required: true

YARN Services Management

Enable YARN Services

Description: Configure YARN to support yarn managed services, enabling this will allow users to create long running YARN services like LLAP.
Related Name
Default Value: true
API Name: yarn_services_enabled
Required: false

YARN Services Dependencies Path

Description: This is the path where the YARN services dependencies tarball should be uploaded.
Related Name: yarn.service.framework.path
Default Value: /user/yarn/services/service-framework/$cdhVersion/service-dep.tar.gz
API Name: yarn_services_framework_path
Required: false