Hue Properties in Cloudera Runtime 7.2.14

Role groups:

Hue Server

Advanced

Top Banner Custom HTML

Description: An optional, custom one-line HTML code to display as a banner on top of all Hue Server web pages. Useful in displaying cluster identity of the Hue Server.
Related Name: banner_top_html
Default Value
API Name: banner_html
Required: false

Hue Server Advanced Configuration Snippet (Safety Valve) for impalad_flags

Description: For advanced use only, key-value pairs (one on each line) to be added (verbatim) to impalad_flags for this role only. Key names should begin with a hyphen(-). For example: -log_filename=foo.log
Related Name
Default Value
API Name: hue_impalad_flags_safety_valve
Required: false

Metrics Sample File Location

Description: The full path to a file with a sample of metrics exposed by the role. The sample is updated at the frequency configured by Metrics Sample File Logging Frequency. By default, the sample file is logged to a directory under the role log directory, e.g., /var/log/hue/metrics-hue_server/metrics.log.
Related Name: location
Default Value
API Name: hue_metrics_sample_file_location
Required: false

Metrics Sample File Logging Frequency

Description: The frequency at which the metrics are logged to the sample file.
Related Name: collection_interval
Default Value: 30 second(s)
API Name: hue_metrics_sample_logging_frequency
Required: false

Hue Server Advanced Configuration Snippet (Safety Valve) for hive-site.xml

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

Hue Server Advanced Configuration Snippet (Safety Valve) for hue_safety_valve_server.ini

Description: For advanced use only. A string to be inserted into hue_safety_valve_server.ini for this role only.
Related Name
Default Value
API Name: hue_server_hue_safety_valve
Required: false

Hue 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: HUE_SERVER_role_env_safety_valve
Required: false

Hue Server Advanced Configuration Snippet (Safety Valve) for sqoop.properties

Description: For advanced use only, key-value pairs (one on each line) to be added (verbatim) to sqoop.properties for this role only. Used in the Sqoop App for connecting to the Sqoop Service.
Related Name
Default Value
API Name: hue_sqoop2_properties_safety_valve
Required: false

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

Hue Server Log Directory

Description: Directory where Hue Server will place its log files.
Related Name
Default Value: /var/log/hue
API Name: hue_server_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: hue_server_fd_thresholds
Required: false

Hue Server Host Health Test

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

Hue Server Process Health Test

Description: Enables the health test that the Hue Server's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: hue_server_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: hue_server_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: hue_server_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

Navigator Audit Failure Thresholds

Description: The health test thresholds for failures encountered when monitoring audits within a recent period specified by the mgmt_navigator_failure_window configuration for the role. The value that can be specified for this threshold is the number of bytes of audits data that is left to be sent to audit server.
Related Name: mgmt.navigator.failure.thresholds
Default Value: Warning: Never, Critical: Any
API Name: mgmt_navigator_failure_thresholds
Required: false

Monitoring Period For Audit Failures

Description: The period to review when checking if audits are blocked and not getting processed.
Related Name: mgmt.navigator.failure.window
Default Value: 20 minute(s)
API Name: mgmt_navigator_failure_window
Required: false

Navigator Audit Pipeline Health Check

Description: Enable test of audit events processing pipeline. This will test if audit events are not getting processed by Audit Server for a role that generates audit.
Related Name: mgmt.navigator.status.check.enabled
Default Value: true
API Name: mgmt_navigator_status_check_enabled
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

HiveServer2 and Impala Thrift Connection Timeout

Description: Timeout in seconds for Thrift calls to HiveServer2 and Impala.
Related Name: server_conn_timeout
Default Value: 2 minute(s)
API Name: hs2_conn_timeout
Required: false

Jobsub Examples and Templates Directory

Description: Location on HDFS where the jobsub examples and templates are stored.
Related Name: remote_data_dir
Default Value: /user/hue/jobsub
API Name: hue_server_remote_data_dir
Required: true

Secret Key

Description: Random string used for secure hashing in the session store.
Related Name: secret_key
Default Value
API Name: secret_key
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

Hue HTTP Port

Description: Port to use to connect to the Hue server.
Related Name: http_port
Default Value: 8888
API Name: hue_http_port
Required: false

Bind Hue Server to Wildcard Address

Description: If enabled, the Hue server binds to the wildcard address ("0.0.0.0") for its ports.
Related Name
Default Value: false
API Name: hue_server_bind_wildcard
Required: false

Resource Management

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

Enable Log and Query Redaction (Hue Only)

Description: Enable/Disable the Log and Query Redaction Policy for Hue. If enabled, and "Enable Log and Query Redaction" in HDFS is also enabled, Hue logs will be redacted using the defined Log and Query Redaction Policy. If disabled, log redaction will not take place even if "Enable Log and Query Redaction" is enabled in HDFS. Uncheck this property if Hue is unresponsive when custom redaction rules are in place.
Related Name: redaction_policy_enabled
Default Value: true
API Name: hue_server_redaction_policy_enabled
Required: false

Hue TLS/SSL Server CA Certificate (PEM Format)

Description: The path to the TLS/SSL file containing the certificate of the certificate authority (CA) and any intermediate certificates used to sign the server certificate. Used when Hue is acting as a TLS/SSL server. The certificate file must be in PEM format, and is usually created by concatenating all of the appropriate root and intermediate certificates.
Related Name: ssl_cacerts
Default Value
API Name: ssl_cacerts
Required: false

Hue TLS/SSL Server Certificate File (PEM Format)

Description: The path to the TLS/SSL file containing the server certificate key used for TLS/SSL. Used when Hue is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: ssl_certificate
Default Value
API Name: ssl_certificate
Required: false

Enable TLS/SSL for Hue

Description: Encrypt communication between clients and Hue using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name
Default Value: false
API Name: ssl_enable
Required: false

Hue TLS/SSL Server Private Key File (PEM Format)

Description: The path to the TLS/SSL file containing the private key used for TLS/SSL. Used when Hue is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: ssl_private_key
Default Value
API Name: ssl_private_key
Required: false

Hue TLS/SSL Private Key Password

Description: The password for the private key in the Hue TLS/SSL Server Certificate and Private Key file. If left blank, the private key is not protected by a password.
Related Name: ssl_password
Default Value
API Name: ssl_private_key_password
Required: false

Suppressions

Suppress Parameter Validation: Top Banner Custom HTML

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Top Banner Custom HTML parameter.
Related Name
Default Value: false
API Name: role_config_suppression_banner_html
Required: true

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: Hue HTTP Port

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

Suppress Parameter Validation: Hue Server Advanced Configuration Snippet (Safety Valve) for impalad_flags

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

Suppress Parameter Validation: Metrics Sample File Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metrics Sample File Location parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hue_metrics_sample_file_location
Required: true

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

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

Suppress Parameter Validation: Hue Server Advanced Configuration Snippet (Safety Valve) for hue_safety_valve_server.ini

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

Suppress Parameter Validation: Hue Server Log Directory

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

Suppress Parameter Validation: Jobsub Examples and Templates Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Jobsub Examples and Templates Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hue_server_remote_data_dir
Required: true

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

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

Suppress Configuration Validator: Hue Server Safety Valve Format Validator

Description: Whether to suppress configuration warnings produced by the Hue Server Safety Valve Format Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hue_server_safety_valve_format_validator
Required: true

Suppress Parameter Validation: Hue Server Advanced Configuration Snippet (Safety Valve) for sqoop.properties

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

Suppress Configuration Validator: Hue TLS/SSL Validator

Description: Whether to suppress configuration warnings produced by the Hue TLS/SSL Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hue_ssl_validator
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: Secret Key

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

Suppress Parameter Validation: Hue TLS/SSL Server CA Certificate (PEM Format)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue TLS/SSL Server CA Certificate (PEM Format) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_cacerts
Required: true

Suppress Parameter Validation: Hue TLS/SSL Server Certificate File (PEM Format)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue TLS/SSL Server Certificate File (PEM Format) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_certificate
Required: true

Suppress Parameter Validation: Hue TLS/SSL Server Private Key File (PEM Format)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue TLS/SSL Server Private Key File (PEM Format) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_private_key
Required: true

Suppress Parameter Validation: Hue TLS/SSL Private Key Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue TLS/SSL Private Key Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_private_key_password
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_hue_server_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_hue_server_file_descriptor
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_hue_server_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_hue_server_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_hue_server_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_hue_server_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_hue_server_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_hue_server_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_hue_server_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_hue_server_web_metric_collection
Required: true

Kerberos Ticket Renewer

Advanced

Kerberos Ticket Renewer 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: KT_RENEWER_role_env_safety_valve
Required: false

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

Kerberos Ticket Renewer Log Directory

Description: Directory where Kerberos Ticket Renewer will place its log files.
Related Name
Default Value: /var/log/hue
API Name: kt_renewer_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: kt_renewer_fd_thresholds
Required: false

Kerberos Ticket Renewer Host Health Test

Description: When computing the overall Kerberos Ticket Renewer health, consider the host's health.
Related Name
Default Value: true
API Name: kt_renewer_host_health_enabled
Required: false

Kerberos Ticket Renewer Process Health Test

Description: Enables the health test that the Kerberos Ticket Renewer's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: kt_renewer_scm_health_enabled
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

Navigator Audit Failure Thresholds

Description: The health test thresholds for failures encountered when monitoring audits within a recent period specified by the mgmt_navigator_failure_window configuration for the role. The value that can be specified for this threshold is the number of bytes of audits data that is left to be sent to audit server.
Related Name: mgmt.navigator.failure.thresholds
Default Value: Warning: Never, Critical: Any
API Name: mgmt_navigator_failure_thresholds
Required: false

Monitoring Period For Audit Failures

Description: The period to review when checking if audits are blocked and not getting processed.
Related Name: mgmt.navigator.failure.window
Default Value: 20 minute(s)
API Name: mgmt_navigator_failure_window
Required: false

Navigator Audit Pipeline Health Check

Description: Enable test of audit events processing pipeline. This will test if audit events are not getting processed by Audit Server for a role that generates audit.
Related Name: mgmt.navigator.status.check.enabled
Default Value: true
API Name: mgmt_navigator_status_check_enabled
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

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

Hue Keytab Renewal Interval

Description: Interval in seconds with which Hue's Kerberos ticket will get renewed.
Related Name: reinit_frequency
Default Value: 1 hour(s)
API Name: keytab_reinit_frequency
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

Resource Management

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

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: Kerberos Ticket Renewer Log Directory

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

Suppress Parameter Validation: Kerberos Ticket Renewer Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Ticket Renewer Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_kt_renewer_role_env_safety_valve
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 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_kt_renewer_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_kt_renewer_file_descriptor
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_kt_renewer_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_kt_renewer_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_kt_renewer_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_kt_renewer_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_kt_renewer_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_kt_renewer_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_kt_renewer_unexpected_exits
Required: true

Load Balancer

Advanced

Load Balancer 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: HUE_LOAD_BALANCER_role_env_safety_valve
Required: false

Load Balancer Advanced Configuration Snippet (Safety Valve) for httpd.conf

Description: For advanced use only, a string to be inserted into httpd.conf for this role only. This can only add options to the configuration, and cannot override previously defined options.
Related Name
Default Value
API Name: hue_load_balancer_safety_valve
Required: false

Hue Load Balancer Cookie Refresh

Description: Force refresh the Apache BalancerMember cookie value to rebalance Hue backend connections.
Related Name: huelb_cookie_refresh
Default Value: false
API Name: huelb_cookie_refresh
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

SSLCipherSuite

Description: This directive uses a colon-separated cipher-spec string consisting of OpenSSL cipher specifications to configure the Cipher Suite the client is permitted to negotiate in the SSL handshake phase.
Related Name: SSLCipherSuite
Default Value: ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES256-SHA:ECDHE-ECDSA-DES-CBC3-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:DES-CBC3-SHA:!DSS
API Name: ssl_cipher_suite
Required: false

SSLProtocol

Description: This directive can be used to control which versions of the SSL/TLS protocol will be accepted in new connections by Hue Load Balancer.
Related Name: SSLProtocol
Default Value: all -SSLv2 -SSLv3
API Name: ssl_protocol
Required: false

Logs

Hue Load Balancer Log Directory

Description: Directory where Hue Load Balancer will place its log files.
Related Name
Default Value: /var/log/hue-httpd
API Name: hue_load_balancer_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: hue_load_balancer_fd_thresholds
Required: false

Load Balancer Host Health Test

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

Load Balancer Process Health Test

Description: Enables the health test that the Load Balancer's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: hue_load_balancer_scm_health_enabled
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

Navigator Audit Failure Thresholds

Description: The health test thresholds for failures encountered when monitoring audits within a recent period specified by the mgmt_navigator_failure_window configuration for the role. The value that can be specified for this threshold is the number of bytes of audits data that is left to be sent to audit server.
Related Name: mgmt.navigator.failure.thresholds
Default Value: Warning: Never, Critical: Any
API Name: mgmt_navigator_failure_thresholds
Required: false

Monitoring Period For Audit Failures

Description: The period to review when checking if audits are blocked and not getting processed.
Related Name: mgmt.navigator.failure.window
Default Value: 20 minute(s)
API Name: mgmt_navigator_failure_window
Required: false

Navigator Audit Pipeline Health Check

Description: Enable test of audit events processing pipeline. This will test if audit events are not getting processed by Audit Server for a role that generates audit.
Related Name: mgmt.navigator.status.check.enabled
Default Value: true
API Name: mgmt_navigator_status_check_enabled
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

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

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

Hue Load Balancer Port

Description: Port to use to connect to the Hue through the Load Balancer.
Related Name: Listen
Default Value: 8889
API Name: listen
Required: true

Resource Management

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

Hue Load Balancer TLS/SSL Server SSLPassPhraseDialog

Description: The path to the file containing the passphrase used to encrypt the private key of the Hue Load Balancer server. The passphrase file is optional.
Related Name: SSLPassPhraseDialog
Default Value
API Name: passphrasefile_location
Required: false

Hue Load Balancer TLS/SSL Server Certificate File (PEM Format)

Description: The path to the TLS/SSL file containing the server certificate key used for TLS/SSL. Used when Hue Load Balancer is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: SSLCertificateFile
Default Value
API Name: ssl_certificate
Required: false

Hue Load Balancer TLS/SSL Server Private Key File (PEM Format)

Description: The path to the TLS/SSL file containing the private key used for TLS/SSL. Used when Hue Load Balancer is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: SSLCertificateKeyFile
Default Value
API Name: ssl_certificate_key
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: Hue Load Balancer Log Directory

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

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

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

Suppress Parameter Validation: Load Balancer Advanced Configuration Snippet (Safety Valve) for httpd.conf

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

Suppress Parameter Validation: Hue Load Balancer Port

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

Suppress Parameter Validation: Hue Load Balancer TLS/SSL Server SSLPassPhraseDialog

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Load Balancer TLS/SSL Server SSLPassPhraseDialog parameter.
Related Name
Default Value: false
API Name: role_config_suppression_passphrasefile_location
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: Hue Load Balancer TLS/SSL Server Certificate File (PEM Format)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Load Balancer TLS/SSL Server Certificate File (PEM Format) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_certificate
Required: true

Suppress Parameter Validation: Hue Load Balancer TLS/SSL Server Private Key File (PEM Format)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Load Balancer TLS/SSL Server Private Key File (PEM Format) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_certificate_key
Required: true

Suppress Parameter Validation: SSLCipherSuite

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

Suppress Parameter Validation: SSLProtocol

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the SSLProtocol parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_protocol
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_hue_load_balancer_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_hue_load_balancer_file_descriptor
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_hue_load_balancer_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_hue_load_balancer_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_hue_load_balancer_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_hue_load_balancer_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_hue_load_balancer_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_hue_load_balancer_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_hue_load_balancer_unexpected_exits
Required: true

Service-Wide

Advanced

Enable Django Debug Mode

Description: In debug mode, Django displays a detailed traceback when an exception occurs. Debugging information may contain sensitive data. Django remembers every SQL query it executes in debug mode, which will rapidly consume memory.
Related Name: django_debug_mode
Default Value: false
API Name: django_debug_enable
Required: false

Enable Debugging of Internal Server Error Responses

Description: Enable debug output in HTTP Internal Server Error (status 500) responses. Debugging information may contain sensitive data. If Enable Django Debug Mode is set, this is automatically enabled.
Related Name: http_500_debug_mode
Default Value: false
API Name: http_500_debug_enable
Required: false

Hue 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: hue_service_env_safety_valve
Required: false

Hue Service Advanced Configuration Snippet (Safety Valve) for hue_safety_valve.ini

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

System Group

Description: The group that this service's processes should run as.
Related Name
Default Value: hue
API Name: process_groupname
Required: true

System User

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

Enable Usage Data Collection

Description: When you enable anonymous usage data collection Hue tracks anonymised pages and application versions in order to gather information about each application's usage levels. The data collected does not include any hostnames or IDs. Data collection option is available on CDH 4.4 and later deployments.
Related Name: collect_usage
Default Value: true
API Name: usage_data_collection_enable
Required: false

Cloudera Navigator Optimizer

Auto Upload Queries to Cloudera Navigator Optimizer

Description: Automatically upload queries after their execution in order to improve recommendations.
Related Name: auto_upload_queries
Default Value: true
API Name: auto_upload_queries
Required: false

Enable Cloudera Navigator Optimizer integration with Hue

Description: Enable Cloudera Navigator Optimizer integration with Hue.
Related Name: enable_navopt
Default Value: false
API Name: enable_navopt
Required: false

Cloudera Altus Access Key

Description: Credentials for accessing Cloudera cloud services.
Related Name
Default Value
API Name: navopt_altus_account
Required: false

Query History Upload Limit

Description: Allow admins to upload the last N executed queries in the quick start wizard. Use 0 to disable.
Related Name: query_history_upload_limit
Default Value: 10000
API Name: query_history_upload_limit
Required: false

Database

Hue Database Directory

Description: If the database is SQLite3, this is the filename of the database to use, and the directory of this file must be writable by the 'hue' user.
Related Name: dir
Default Value: /var/lib/hue/desktop.db
API Name: database_dir
Required: false

Database Dump File

Description: File where the database gets dumped to or loaded from.
Related Name
Default Value: /tmp/hue_database_dump.json
API Name: database_dump_file
Required: true

Hue Database Hostname

Description: Name of host where the Hue database is running. Not necessary for SQLite3.
Related Name: host
Default Value: localhost
API Name: database_host
Required: false

Hue Database Name

Description: Name of Hue database.
Related Name: name
Default Value: hue
API Name: database_name
Required: false

Hue Database Password

Description: Password for Hue database. Not necessary for SQLite3.
Related Name: password
Default Value
API Name: database_password
Required: false

Hue Database Port

Description: Port on host where the Hue database is running. Not necessary for SQLite3.
Related Name: port
Default Value: 3306
API Name: database_port
Required: false

Hue Database Type

Description: Type of database used for Hue
Related Name: engine
Default Value: sqlite3
API Name: database_type
Required: false

Hue Database Username

Description: The username to use to log into the Hue database. Not necessary for SQLite3.
Related Name: user
Default Value: hue
API Name: database_user
Required: false

Monitoring

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

Healthy Hue Server Monitoring Thresholds

Description: The health test thresholds of the overall Hue Server health. The check returns "Concerning" health if the percentage of "Healthy" Hue Servers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Hue Servers falls below the critical threshold.
Related Name
Default Value: Warning: 99.0 %, Critical: 51.0 %
API Name: hue_hue_servers_healthy_thresholds
Required: false

Healthy Kerberos Ticket Renewer Monitoring Thresholds

Description: The health test thresholds of the overall Kerberos Ticket Renewer health. The check returns "Concerning" health if the percentage of "Healthy" Kerberos Ticket Renewers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Kerberos Ticket Renewers falls below the critical threshold.
Related Name
Default Value: Warning: 99.0 %, Critical: 51.0 %
API Name: hue_kt_renewers_healthy_thresholds
Required: false

Healthy Load Balancer Monitoring Thresholds

Description: The health test thresholds of the overall Load Balancer health. The check returns "Concerning" health if the percentage of "Healthy" Load Balancers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Load Balancers falls below the critical threshold.
Related Name
Default Value: Warning: 99.0 %, Critical: 51.0 %
API Name: hue_load_balancer_healthy_thresholds
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 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

Other

Atlas Service

Description: Name of the Atlas service that this Hue service instance depends on
Related Name
Default Value
API Name: atlas_service
Required: false

Blacklist

Description: Comma-separated list of regular expressions, which match any prefix of 'host:port/path' of requested proxy target. This does not support matching GET parameters.
Related Name: blacklist
Default Value: ()
API Name: blacklist
Required: false

Hue Web Server Threads

Description: Number of threads used by the Hue web server.
Related Name: cherrypy_server_threads
Default Value: 50
API Name: cherrypy_server_threads
Required: false

Default Site Encoding

Description: Default encoding for site data.
Related Name: default_site_encoding
Default Value: utf
API Name: default_site_encoding
Required: false

Default User Group

Description: The name of a default group that users will be added to at creation time.
Related Name: default_user_group
Default Value
API Name: default_user_group
Required: false

HBase Service

Description: Name of the HBase service that this Hue service instance depends on
Related Name
Default Value
API Name: hbase_service
Required: false

HDFS Service

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

HDFS Temporary Directory

Description: HDFS directory used for storing temporary files.
Related Name: temp_dir
Default Value: /tmp
API Name: hdfs_tmp_dir
Required: false

HiveServer2 Service

Description: Name of the HiveServer2 service that this Hue service instance depends on
Related Name
Default Value
API Name: hive_service
Required: false

HMS Service

Description: Name of the HMS service that this Hue service instance depends on
Related Name
Default Value
API Name: hms_service
Required: true

Hue Kerberos Credentials Cache Directory

Description: Directory where Hue stores cached Kerberos credentials
Related Name: ccache_path
Default Value: /var/run/hue
API Name: hue_ccache_path
Required: false

HBase Thrift Server

Description: Thrift server to use for HBase app.
Related Name
Default Value
API Name: hue_hbase_thrift
Required: false

HDFS Web Interface Role

Description: HTTPFS role or Namenode (if webhdfs is enabled) that hue can use to communicate with HDFS.
Related Name: webhdfs_url
Default Value
API Name: hue_webhdfs
Required: false

Impala Service

Description: Name of the Impala service that this Hue service instance depends on
Related Name
Default Value
API Name: impala_service
Required: false

Knox Proxy Hosts

Description: List of hosts that Knox proxy requests can come from.
Related Name: knox_proxyhosts
Default Value
API Name: knox_proxyhosts
Required: false

Oozie Service

Description: Name of the Oozie service that this Hue service instance depends on
Related Name
Default Value
API Name: oozie_service
Required: false

Solr Service

Description: Name of the Solr service that this Hue service instance depends on
Related Name
Default Value
API Name: solr_service
Required: false

Time Zone

Description: Time zone name.
Related Name: time_zone
Default Value: America/Los_Angeles
API Name: time_zone
Required: false

User Augmentor

Description: Class that defines extra accessor methods for user objects.
Related Name: user_augmentor
Default Value: desktop.auth.backend.DefaultUserAugmentor
API Name: user_augmentor
Required: false

Whitelist

Description: Comma-separated list of regular expressions, which match 'host:port' of requested proxy target.
Related Name: whitelist
Default Value: (localhost|127\.0\.0\.1):(50030|50070|50060|50075)
API Name: whitelist
Required: false

ZooKeeper Service

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

Security

Authentication Backend

Description: Mode of authenticating login credentials. Select desktop.auth.backend.LdapBackend to use LDAP to authenticate login credentials. LDAP requires you to also set the LDAP URL, Active Directory Domain, and optionally LDAP certificate if you are using secure LDAP. Select desktop.auth.backend.PamBackend to use PAM to authenticate login credentials.
Related Name: backend
Default Value: desktop.auth.backend.AllowFirstUserDjangoBackend
API Name: auth_backend
Required: false

LDAP Search Base

Description: The distinguished name to use as a search base for finding users and groups. This should be similar to 'dc=hadoop,dc=mycompany,dc=com'.
Related Name: base_dn
Default Value
API Name: base_dn
Required: false

LDAP Bind User Distinguished Name

Description: Distinguished name of the user to bind to AD as for user authentication search/bind and group lookup for role authorization. For openLDAP based directories this should be a DN string, for Active Directory this can be just a username, combined with the "Active Directory Domain" value for login. For example username in the field and example.com in the active directory domain will result in the User Principal Name value of username@example.com being used to bind. If you put a UPM value here, do not over-configure the "active directory domain" field otherwise you will end up presenting username@example.com@example.com for binds. AD will accept a UPN value or the DN value as a valid Bind DN; An example of a Distinguished Name (DN): CN=cdh admin,OU=svcaccount,DC=example,DC=com An example of a UPN value: cdhadmin@example.com
Related Name: bind_dn
Default Value
API Name: bind_dn
Required: false

LDAP Bind Password

Description: The password of the bind user.
Related Name: bind_password
Default Value
API Name: bind_password
Required: false

Create LDAP users on login

Description: Create users in Hue when they try to login with their LDAP credentials. For use when using LdapBackend for Hue authentication.
Related Name: create_users_on_login
Default Value: true
API Name: create_users_on_login
Required: false

LDAP Group Filter

Description: Base filter for searching for groups. For Active Directory, this is typically '(objectClass=group)'.
Related Name: group_filter
Default Value
API Name: group_filter
Required: false

LDAP Group Membership Attribute

Description: The attribute of the group object that identifies the members of the group. For Active Directory, this is typically 'member'.
Related Name: group_member_attr
Default Value
API Name: group_member_attr
Required: false

LDAP Group Name Attribute

Description: The group name attribute in the LDAP schema. For Active Directory, this is typically 'cn'.
Related Name: group_name_attr
Default Value
API Name: group_name_attr
Required: false

Auto Logout Timeout

Description: Auto logout/idle session timeout in seconds, -1 second is equivalent to no automatic logout.
Related Name: idle_session_timeout
Default Value: -1 second(s)
API Name: idle_session_timeout
Required: false

Kerberos Principal

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

LDAP Server CA Certificate

Description: The location on disk of the certificate, in .pem format, used to confirm the authenticity of the LDAP server certificate. This is the Certificate Authority (CA) certificate, and it was used to sign the LDAP server certificate. If not set, all certificates are trusted, which means that an attacker could potentially intercept otherwise encrypted usernames and passwords.
Related Name: ldap_cert
Default Value
API Name: ldap_cert
Required: false

LDAP URL

Description: The URL of the LDAP Server. The URL must be prefixed with ldap:// or ldaps:// . The URL can optionally specify a custom port if necessary, but by default the ldap:// will connect to port 389, and the ldaps:// will connect to port 636. Note that passwords will be in the clear if ldap:// is used, and by fall 2020 Active directory servers will no longer allow non LDAPS connections to bind to AD hosts with LDAP signing enabled. See microsoft knowledge document 935834 for more information.
Related Name: ldap_url
Default Value
API Name: ldap_url
Required: false

LDAP Username Pattern

Description: LDAP Username Pattern for use with non-Active Directory LDAP implementations. Must contain the special 'username' string for replacement during authentication.
Related Name: ldap_username_pattern
Default Value
API Name: ldap_username_pattern
Required: false

Active Directory Domain

Description: Use this field for Active Directory configurations only, when combined with a simple username value in the "LDAP Bind User Distinguished Name" field, it will result in a UPM of user@example.com used for search/bind operations for authenticated user lookups.
Related Name: nt_domain
Default Value
API Name: nt_domain
Required: false

PAM Backend Service Name

Description: The PAM service name to use when authenticating over desktop.auth.backend.PamBackend. This is typically the name of a file under /etc/pam.d/ on the Hue host.
Related Name: pam_service
Default Value: login
API Name: pam_auth_service
Required: false

Use Search Bind Authentication

Description: Search Bind Authentication connects to the LDAP server using credentials provided in the 'bind_dn' and 'bind_password' configurations. If these configurations are not set, then an anonymous search is performed.
Related Name: search_bind_authentication
Default Value: false
API Name: search_bind_authentication
Required: false

LDAP Group Name for Test LDAP Configuration

Description: An optional group name for validating LDAP group configurations. If a test group name is provided, Hue's LDAP library uses it as a search parameter when running the command, Test Hue LDAP Configuration (under Hue > Actions). For example, (&(objectClass=*)(sAMAccountName=test_ldap_group)). If test group name is not provided then Hue LDAP Configuration action will check only LDAP server connectivity.
Related Name: test_ldap_group
Default Value
API Name: test_ldap_group
Required: false

LDAP Username for Test LDAP Configuration

Description: An optional user name for validating LDAP user configurations. If a test user name is provided, Hue's LDAP library uses it as a search parameter when running the command, Test Hue LDAP Configuration (under Hue > Actions). For example, (&(objectClass=*)(sAMAccountName=test_ldap_user)). If "*" is provided, then all user attributes are returned. If test user name is not provided then Test Hue LDAP Configuration action will check only LDAP server connectivity.
Related Name: test_ldap_user
Default Value
API Name: test_ldap_user
Required: false

Enable LDAP TLS

Description: If true, attempts to establish a TLS (Transport Layer Security) connection with an LDAP server that was specified with ldap://. Not required when using an LDAP URL with prefix ldaps://, because that already specifies TLS. This option is also known as "Use StartTLS".
Related Name: use_start_tls
Default Value: true
API Name: use_start_tls
Required: false

LDAP User Filter

Description: The base filter for searching for users. For Active Directory, this is typically '(objectClass=user)'.
Related Name: user_filter
Default Value
API Name: user_filter
Required: false

LDAP Username Attribute

Description: The username attribute in the LDAP schema. For Active Directory, this is typically 'sAMAccountName'.
Related Name: user_name_attr
Default Value
API Name: user_name_attr
Required: false

Suppressions

Suppress Configuration Validator: Top Banner Custom HTML

Description: Whether to suppress configuration warnings produced by the Top Banner Custom HTML configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_banner_html
Required: true

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: Hue HTTP Port

Description: Whether to suppress configuration warnings produced by the Hue HTTP Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hue_http_port
Required: true

Suppress Configuration Validator: Hue Server Advanced Configuration Snippet (Safety Valve) for impalad_flags

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

Suppress Configuration Validator: Hue Load Balancer Log Directory

Description: Whether to suppress configuration warnings produced by the Hue Load Balancer Log Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hue_load_balancer_log_dir
Required: true

Suppress Configuration Validator: Load Balancer Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Configuration Validator: Load Balancer Advanced Configuration Snippet (Safety Valve) for httpd.conf

Description: Whether to suppress configuration warnings produced by the Load Balancer Advanced Configuration Snippet (Safety Valve) for httpd.conf configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hue_load_balancer_safety_valve
Required: true

Suppress Configuration Validator: Metrics Sample File Location

Description: Whether to suppress configuration warnings produced by the Metrics Sample File Location configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hue_metrics_sample_file_location
Required: true

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

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

Suppress Configuration Validator: Hue Server Advanced Configuration Snippet (Safety Valve) for hue_safety_valve_server.ini

Description: Whether to suppress configuration warnings produced by the Hue Server Advanced Configuration Snippet (Safety Valve) for hue_safety_valve_server.ini configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hue_server_hue_safety_valve
Required: true

Suppress Configuration Validator: Hue Server Log Directory

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

Suppress Configuration Validator: Jobsub Examples and Templates Directory

Description: Whether to suppress configuration warnings produced by the Jobsub Examples and Templates Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hue_server_remote_data_dir
Required: true

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

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

Suppress Configuration Validator: Hue Server Safety Valve Format Validator

Description: Whether to suppress configuration warnings produced by the Hue Server Safety Valve Format Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hue_server_safety_valve_format_validator
Required: true

Suppress Configuration Validator: Hue Server Advanced Configuration Snippet (Safety Valve) for sqoop.properties

Description: Whether to suppress configuration warnings produced by the Hue Server Advanced Configuration Snippet (Safety Valve) for sqoop.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hue_sqoop2_properties_safety_valve
Required: true

Suppress Configuration Validator: Hue TLS/SSL Validator

Description: Whether to suppress configuration warnings produced by the Hue TLS/SSL Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hue_ssl_validator
Required: true

Suppress Configuration Validator: Kerberos Ticket Renewer Log Directory

Description: Whether to suppress configuration warnings produced by the Kerberos Ticket Renewer Log Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_kt_renewer_log_dir
Required: true

Suppress Configuration Validator: Kerberos Ticket Renewer Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Configuration Validator: Hue Load Balancer Port

Description: Whether to suppress configuration warnings produced by the Hue Load Balancer Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_listen
Required: true

Suppress Configuration Validator: Hue Load Balancer TLS/SSL Server SSLPassPhraseDialog

Description: Whether to suppress configuration warnings produced by the Hue Load Balancer TLS/SSL Server SSLPassPhraseDialog configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_passphrasefile_location
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: 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: Secret Key

Description: Whether to suppress configuration warnings produced by the Secret Key configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_secret_key
Required: true

Suppress Configuration Validator: Hue TLS/SSL Server CA Certificate (PEM Format)

Description: Whether to suppress configuration warnings produced by the Hue TLS/SSL Server CA Certificate (PEM Format) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_cacerts
Required: true

Suppress Configuration Validator: Hue TLS/SSL Server Certificate File (PEM Format)

Description: Whether to suppress configuration warnings produced by the Hue TLS/SSL Server Certificate File (PEM Format) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_certificate
Required: true

Suppress Configuration Validator: Hue Load Balancer TLS/SSL Server Private Key File (PEM Format)

Description: Whether to suppress configuration warnings produced by the Hue Load Balancer TLS/SSL Server Private Key File (PEM Format) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_certificate_key
Required: true

Suppress Configuration Validator: SSLCipherSuite

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

Suppress Configuration Validator: Hue TLS/SSL Server Private Key File (PEM Format)

Description: Whether to suppress configuration warnings produced by the Hue TLS/SSL Server Private Key File (PEM Format) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_private_key
Required: true

Suppress Configuration Validator: Hue TLS/SSL Private Key Password

Description: Whether to suppress configuration warnings produced by the Hue TLS/SSL Private Key Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_private_key_password
Required: true

Suppress Configuration Validator: SSLProtocol

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

Suppress Parameter Validation: LDAP Search Base

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Search Base parameter.
Related Name
Default Value: false
API Name: service_config_suppression_base_dn
Required: true

Suppress Parameter Validation: LDAP Bind User Distinguished Name

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

Suppress Parameter Validation: LDAP Bind Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Bind Password parameter.
Related Name
Default Value: false
API Name: service_config_suppression_bind_password
Required: true

Suppress Parameter Validation: Blacklist

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

Suppress Parameter Validation: Hue Database Directory

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

Suppress Parameter Validation: Database Dump File

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

Suppress Parameter Validation: Hue Database Hostname

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Database Hostname parameter.
Related Name
Default Value: false
API Name: service_config_suppression_database_host
Required: true

Suppress Parameter Validation: Hue Database Name

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

Suppress Parameter Validation: Hue Database Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Database Password parameter.
Related Name
Default Value: false
API Name: service_config_suppression_database_password
Required: true

Suppress Parameter Validation: Hue Database Port

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

Suppress Parameter Validation: Hue Database Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Database Username parameter.
Related Name
Default Value: false
API Name: service_config_suppression_database_user
Required: true

Suppress Parameter Validation: Default Site Encoding

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

Suppress Parameter Validation: Default User Group

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

Suppress Parameter Validation: LDAP Group Filter

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

Suppress Parameter Validation: LDAP Group Membership Attribute

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

Suppress Parameter Validation: LDAP Group Name Attribute

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

Suppress Configuration Validator: HDFS HTTPFS Usage Validator

Description: Whether to suppress configuration warnings produced by the HDFS HTTPFS Usage Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hdfs_httpfs_present_validator
Required: true

Suppress Parameter Validation: HDFS Temporary Directory

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

Suppress Parameter Validation: Hue Kerberos Credentials Cache Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Kerberos Credentials Cache Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hue_ccache_path
Required: true

Suppress Configuration Validator: HBase Thrift Usage Validator

Description: Whether to suppress configuration warnings produced by the HBase Thrift Usage Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hue_hbase_thrift_server_validator
Required: true

Suppress Configuration Validator: Knox Proxy Hosts validator for Hue

Description: Whether to suppress configuration warnings produced by the Knox Proxy Hosts validator for Hue configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hue_knox_proxyhosts_validator
Required: true

Suppress Configuration Validator: Load Balancer Count Validator

Description: Whether to suppress configuration warnings produced by the Load Balancer Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hue_load_balancer_count_validator
Required: true

Suppress Configuration Validator: Phoenix Query Server

Description: Whether to suppress configuration warnings produced by the Phoenix Query Server configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hue_phoenix_query_server_validator
Required: true

Suppress Configuration Validator: Hue Server Count Validator

Description: Whether to suppress configuration warnings produced by the Hue Server Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hue_server_count_validator
Required: true

Suppress Configuration Validator: Hue Service Config Safety Valve Format Validator

Description: Whether to suppress configuration warnings produced by the Hue Service Config Safety Valve Format Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hue_service_config_safety_valve_format_validator
Required: true

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

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

Suppress Parameter Validation: Hue Service Advanced Configuration Snippet (Safety Valve) for hue_safety_valve.ini

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

Suppress Parameter Validation: HDFS Web Interface Role

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HDFS Web Interface Role parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hue_webhdfs
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: Knox Proxy Hosts

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Proxy Hosts parameter.
Related Name
Default Value: false
API Name: service_config_suppression_knox_proxyhosts
Required: true

Suppress Configuration Validator: Kerberos Ticket Renewer Count Validator

Description: Whether to suppress configuration warnings produced by the Kerberos Ticket Renewer Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_kt_renewer_count_validator
Required: true

Suppress Parameter Validation: LDAP Server CA Certificate

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Server CA Certificate parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ldap_cert
Required: true

Suppress Parameter Validation: LDAP URL

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

Suppress Parameter Validation: LDAP Username Pattern

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Username Pattern parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ldap_username_pattern
Required: true

Suppress Parameter Validation: Active Directory Domain

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

Suppress Parameter Validation: PAM Backend Service Name

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the PAM Backend Service Name parameter.
Related Name
Default Value: false
API Name: service_config_suppression_pam_auth_service
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: 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 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: LDAP Group Name for Test LDAP Configuration

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

Suppress Parameter Validation: LDAP Username for Test LDAP Configuration

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Username for Test LDAP Configuration parameter.
Related Name
Default Value: false
API Name: service_config_suppression_test_ldap_user
Required: true

Suppress Parameter Validation: Time Zone

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

Suppress Parameter Validation: User Augmentor

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

Suppress Parameter Validation: LDAP User Filter

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

Suppress Parameter Validation: LDAP Username Attribute

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Username Attribute parameter.
Related Name
Default Value: false
API Name: service_config_suppression_user_name_attr
Required: true

Suppress Parameter Validation: Whitelist

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

Suppress Health Test: Hue Server Health

Description: Whether to suppress the results of the Hue 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_hue_hue_servers_healthy
Required: true

Suppress Health Test: Kerberos Ticket Renewer Health

Description: Whether to suppress the results of the Kerberos Ticket Renewer 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_hue_kt_renewers_healthy
Required: true

Suppress Health Test: Load Balancer Health

Description: Whether to suppress the results of the Load Balancer 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_hue_load_balancer_healthy
Required: true