Stub DFS Properties in Cloudera Runtime 7.1.8

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

Core Configuration 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
core_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
core_client_java_opts
Required
false

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

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 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
90
API Name
client_config_priority
Required
true

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
256 MiB
API Name
core_client_java_heapsize
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: Core Configuration 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 Core Configuration Client Environment Advanced Configuration Snippet (Safety Valve) for hadoop-env.sh parameter.
Related Name
Default Value
false
API Name
role_config_suppression_core_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_core_client_java_opts
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

Service-Wide

Advanced

System Group

Description
The group that this service's processes should run as (except the HttpFS server, which has its own group)
Related Name
Default Value
hdfs
API Name
process_groupname
Required
true

System User

Description
The user that this service's processes should run as.
Related Name
Default Value
hdfs
API Name
process_username
Required
true

Stub DFS 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
STUB_DFS_service_env_safety_valve
Required
false

Monitoring

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

Core Settings Connector

Description
Dependency on the Core Settings service for the cluster.
Related Name
Default Value
API Name
core_connector
Required
true

Security

Kerberos Principal

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

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: Core Configuration Client Environment Advanced Configuration Snippet (Safety Valve) for hadoop-env.sh

Description
Whether to suppress configuration warnings produced by the Core Configuration Client Environment Advanced Configuration Snippet (Safety Valve) for hadoop-env.sh configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_core_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_core_client_java_opts
Required
true

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

Description
Whether to suppress configuration warnings produced by the Gateway 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: 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: 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: 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: Storage Operations Log Directory

Description
Whether to suppress configuration warnings produced by the Storage Operations Log Directory configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_storageoperations_log_dir
Required
true

Suppress Configuration Validator: Storage Operations Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the Storage Operations Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_storageoperations_role_env_safety_valve
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 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 Configuration Validator: Stub DFS only DFS Validator

Description
Whether to suppress configuration warnings produced by the Stub DFS only DFS Validator configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_only_dfs_in_cluster_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 Configuration Validator: Storage Operations Count Validator

Description
Whether to suppress configuration warnings produced by the Storage Operations Count Validator configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_storageoperations_count_validator
Required
true

Suppress Parameter Validation: Stub DFS Service Environment Advanced Configuration Snippet (Safety Valve)

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

Storage Operations

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

Core Configuration 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
core_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
core_client_java_opts
Required
false

Storage Operations 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

Storage Operations 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
STORAGEOPERATIONS_role_env_safety_valve
Required
false

Logs

Storage Operations Logging Threshold

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

Storage Operations Maximum Log File Backups

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

Storage Operations Max Log Size

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

Storage Operations Log Directory

Description
Directory where Storage Operations will place its log files.
Related Name
hadoop.log.dir
Default Value
/var/log/
API Name
storageoperations_log_dir
Required
false

Monitoring

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

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

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
90
API Name
client_config_priority
Required
true

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

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
256 MiB
API Name
core_client_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

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: 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: Core Configuration 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 Core Configuration Client Environment Advanced Configuration Snippet (Safety Valve) for hadoop-env.sh parameter.
Related Name
Default Value
false
API Name
role_config_suppression_core_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_core_client_java_opts
Required
true

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

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Operations 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: 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: 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: Storage Operations Log Directory

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

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

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