ZooKeeper Properties in Cloudera Runtime 7.1

Role groups:

Server

Advanced

ZooKeeper 'Four Letter Word' Command Whitelist

Description
ZooKeeper responds to specific Four-Letter-Word diagnostic telnet commands on its client port. Here you can configure which commands should be accepted by the server. Use asterisk ('*') to enable all of them.
Related Name
4lw.commands.whitelist
Default Value
conf cons crst dirs dump envi gtmk ruok stmk srst srvr stat wchs mntr isro
API Name
4lw_commands_whitelist
Required
false

Server Logging Advanced Configuration Snippet (Safety Valve)

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

Heap Dump Directory

Description
Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role.
Related Name
oom_heap_dump_dir
Default Value
/tmp
API Name
oom_heap_dump_dir
Required
false

Dump Heap When Out of Memory

Description
When set, generates heap dump file when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value
true
API Name
oom_heap_dump_enabled
Required
true

Kill When Out of Memory

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

Automatically Restart Process

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

Enable Metric Collection

Description
Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process.
Related Name
Default Value
true
API Name
process_should_monitor
Required
true

Process Start Retry Attempts

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

Process Start Wait Timeout

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

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
SERVER_role_env_safety_valve
Required
false

Java Configuration Options for Zookeeper Server

Description
These arguments will be passed as part of the Java command line. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here. Note: When CM version is 6.3.0 or greater, {{JAVA_GC_ARGS}} will be replaced by JVM Garbage Collection arguments based on the runtime Java JVM version.
Related Name
Default Value
API Name
zk_server_java_opts
Required
false

Server Advanced Configuration Snippet (Safety Valve) for zoo.cfg

Description
For advanced use only. A string to be inserted into zoo.cfg for this role only.
Related Name
Default Value
API Name
zookeeper_config_safety_valve
Required
false

Logs

Server Logging Threshold

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

Server Maximum Log File Backups

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

Server Max Log Size

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

ZooKeeper Log Directory

Description
Directory where ZooKeeper will place its log files.
Related Name
Default Value
/var/log/zookeeper
API Name
zk_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

Log Directory Free Space Monitoring Absolute Thresholds

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

Log Directory Free Space Monitoring Percentage Thresholds

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

Rules to Extract Events from Log Files

Description
This file contains the rules that govern how log messages are turned into events by the custom log4j appender that this role loads. It is in JSON format, and is composed of a list of rules. Every log message is evaluated against each of these rules in turn to decide whether or not to send an event for that message. If a log message matches multiple rules, the first matching rule is used.. Each rule has some or all of the following fields:
  • alert - whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".
  • rate (mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more than rate matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.
  • periodminutes - the number of minutes during which the publisher will only publish rate events or fewer. If not specified, the default is one minute
  • threshold - apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.
  • content - match only those messages for which contents match this regular expression.
  • exceptiontype - match only those messages that are part of an exception message. The exception type must match this regular expression.
Example:
  • {"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}This rule sends events to Cloudera Manager for every StringIndexOutOfBoundsException, up to a maximum of 10 every minute.
  • {"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.
Related Name
Default Value
version: 0, rules: [ alert: false, rate: 1, periodminutes: 1, threshold: FATAL , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Instead, use .* , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Use .* instead , alert: false, rate: 1, periodminutes: 2, exceptiontype: .* , alert: false, rate: 1, periodminutes: 1, threshold: WARN ]
API Name
log_event_whitelist
Required
false

Metric Filter

Description
Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
Related Name
Default Value
API Name
monitoring_metric_filter
Required
false

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

ZooKeeper Server Connection Count Thresholds

Description
The health check thresholds of the weighted average size of the ZooKeeper Server connection count over a recent period. See ZooKeeper Server Connection Count Monitoring Period.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
zookeeper_server_connection_count_thresholds
Required
false

ZooKeeper Server Connection Count Monitoring Period

Description
The period to review when computing the moving average of the connection count. Specified in minutes.
Related Name
Default Value
3 minute(s)
API Name
zookeeper_server_connection_count_window
Required
false

Data Directory Free Space Monitoring Absolute Thresholds

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

Data Directory Free Space Monitoring Percentage Thresholds

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

Transaction 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 Transaction Log Directory.
Related Name
Default Value
Warning: 10 GiB, Critical: 5 GiB
API Name
zookeeper_server_data_log_directory_free_space_absolute_thresholds
Required
false

Transaction 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 Transaction Log Directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Transaction Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
zookeeper_server_data_log_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
zookeeper_server_fd_thresholds
Required
false

Garbage Collection Duration Thresholds

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

Garbage Collection Duration Monitoring Period

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

Server Host Health Test

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

Maximum Latency Monitoring Thresholds

Description
The percentage thresholds of the ratio of the maximum request latency to the maximum client-negotiable session timeout since the server was started.
Related Name
Default Value
Warning: 75.0 %, Critical: 100.0 %
API Name
zookeeper_server_max_latency_thresholds
Required
false

ZooKeeper Server Outstanding Requests Thresholds

Description
The health check thresholds of the weighted average size of the ZooKeeper Server outstanding requests queue over a recent period. See ZooKeeper Server Outstanding Requests Monitoring Period.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
zookeeper_server_outstanding_requests_thresholds
Required
false

ZooKeeper Server Outstanding Requests Monitoring Period

Description
The period to review when computing the moving average of the outstanding requests queue size. Specified in minutes.
Related Name
Default Value
3 minute(s)
API Name
zookeeper_server_outstanding_requests_window
Required
false

Quorum Membership Detection Window

Description
The tolerance window that will be used in the detection of a ZooKeeper server's membership in a quorum. Specified in minutes.
Related Name
Default Value
3 minute(s)
API Name
zookeeper_server_quorum_membership_detection_window
Required
false

Enable the Quorum Membership Check

Description
Enables the quorum membership check for this ZooKeeper Server.
Related Name
Default Value
true
API Name
zookeeper_server_quorum_membership_enabled
Required
false

Server Process Health Test

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

Other

Client Port Address

Description
The address (IPv4, IPv6, or hostname) to monitor for client connections. This is the address that clients attempt to connect to. This setting is optional, because by default, ZooKeeper binds in such a way that any connection to the client port for any address/interface/NIC on the server will be accepted.
Related Name
clientPortAddress
Default Value
API Name
clientPortAddress
Required
false

Data Directory

Description
The disk location that ZooKeeper will use to store its database snapshots.
Related Name
dataDir
Default Value
/var/lib/zookeeper
API Name
dataDir
Required
false

Transaction Log Directory

Description
The disk location that ZooKeeper will use to store its transaction logs.
Related Name
dataLogDir
Default Value
/var/lib/zookeeper
API Name
dataLogDir
Required
false

Enable JMX Agent

Description
Enables the JMX agent on the ZooKeeper server. Turning this off on any of the ZooKeeper servers that are part of a service will prevent Cloudera Manager from being able to monitor that server and may affect the monitoring provided on the entire service.
Related Name
Default Value
true
API Name
enable_jmx_agent
Required
false

Enable Authenticated Communication with the JMX Agent

Description
Enables authentication when interacting with the JMX agent on the ZooKeeper server.
Related Name
Default Value
false
API Name
enable_jmx_authentication
Required
false

Enable ZooKeeper Admin Server

Description
The AdminServer is an embedded HTTP server that provides a REST interface for different diagnostics commands in ZooKeeper. The results of the commands are returned in JSON. The AdminServer is optional to enable, you should consider it as an alternative to the 'Four-Letter-Word' telnet interface.
Related Name
admin.enableServer
Default Value
false
API Name
enable_zookeeper_admin_server
Required
false

Name of User with Read-Only access to the JMX Agent

Description
Specifies the name of the user that has read-only privileges when using password file based authentication for JMX access. JMX authentication must be enabled for this setting to take effect.
Related Name
Default Value
monitorRole
API Name
jmx_passwd_file_readonly_user
Required
false

Password of User with Read-Only Access to the JMX agent

Description
Specifies the password of the user that has read-only privileges when using password file based authentication for JMX access. JMX authentication must be enabled for this setting to take effect.
Related Name
Default Value
******
API Name
jmx_passwd_file_readonly_user_password
Required
false

Name of User with Read-Write Access to the JMX Agent

Description
Specifies the name of the user that has read-write privileges when using password file based authentication for JMX access. JMX authentication must be enabled for this setting to take effect.
Related Name
Default Value
controlRole
API Name
jmx_passwd_file_readwrite_user
Required
false

Password of user with read-write access to the JMX agent

Description
Specifies the password of the user that has read-write privileges when using password file based authentication for JMX access. JMX authentication must be enabled for this setting to take effect.
Related Name
Default Value
******
API Name
jmx_passwd_file_readwrite_user_password
Required
false

Maximum Client Connections

Description
The maximum number of concurrent connections (at the socket level) that a single client, identified by the IP address, may make to a single member of the ZooKeeper ensemble. This setting is used to prevent certain classes of DoS attacks, including file descriptor exhaustion. To remove the limit on concurrent connections, set this value to 0.
Related Name
maxClientCnxns
Default Value
60
API Name
maxClientCnxns
Required
false

Maximum Session Timeout

Description
The maximum session timeout, in milliseconds, that the ZooKeeper Server will allow the client to negotiate
Related Name
maxSessionTimeout
Default Value
40000
API Name
maxSessionTimeout
Required
false

Minimum Session Timeout

Description
The minimum session timeout, in milliseconds, that the ZooKeeper Server will allow the client to negotiate
Related Name
minSessionTimeout
Default Value
4000
API Name
minSessionTimeout
Required
false

ZooKeeper Server ID

Description
Unique identifier for each ZooKeeper server, typically starts at 1
Related Name
myid
Default Value
API Name
serverId
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

Client Port

Description
The port to monitor for client connections. This is the port that clients attempt to connect to.
Related Name
clientPort
Default Value
2181
API Name
clientPort
Required
false

Election Port

Description
The port to monitor for leadership election
Related Name
Default Value
4181
API Name
electionPort
Required
false

Quorum Port

Description
The port to monitor for inter-server communication
Related Name
Default Value
3181
API Name
quorumPort
Required
false

JMX Remote Port

Description
The port used by the ZooKeeper Server's RMI registry. This is required to enable JMX access through RMI which is required for Cloudera Manager ZooKeeper monitoring. This is added as "-Dcom.sun.management.jmxremote.port" to the ZooKeeper Server's JVM command line.
Related Name
Default Value
9010
API Name
server_jmx_agent_port
Required
false

JMX RMI Server Port

Description
The port used by the ZooKeeper Server's RMI server to handle JMX RMI requests. This is added as "-Dcom.sun.management.jmxremote.rmi.port=port" to the ZooKeeper Server's JVM command line. This has an effect only in Oracle JDK 7u4 and higher. If the setting is left blank, the JMX Remote Port value is used. If set to 0 or -1, this setting is ignored. When this setting is not in effect, the JVM uses a random port for the RMI server.
Related Name
Default Value
API Name
server_jmx_rmi_port
Required
false

Admin Server Port

Description
Port number for the REST Admin Server embedded in ZooKeeper.
Related Name
admin.serverPort
Default Value
5181
API Name
zookeeper_admin_server_port
Required
false

Secure Client Port

Description
The port used in ZooKeeper to accept TLS/SSL connections from clients. You need to select 'Enable TLS/SSL for ZooKeeper' in order to have this port open. Any client that connects to this port must use TLS/SSL.
Related Name
secureClientPort
Default Value
2182
API Name
zookeeper_secure_client_port
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

Java Heap Size of ZooKeeper Server in Bytes

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

Security

Enable TLS client authentication for JMX port

Description
If enabled, a valid client certificate must be presented by the JMX client in order to connect to the JMX port. Ensure that the trusted CA certificates are present in either the ZooKeeper JMX TLS/SSL Server Trust Store File or the global trust store.
Related Name
Default Value
false
API Name
jmx_tls_client_auth_enabled
Required
false

Enable TLS/SSL for ZooKeeper JMX

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

ZooKeeper JMX TLS/SSL Server JKS Keystore File Location

Description
The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when ZooKeeper JMX is acting as a TLS/SSL server. The keystore must be in JKS format.
Related Name
Default Value
API Name
jmx_tls_keystore
Required
false

ZooKeeper JMX TLS/SSL Server JKS Keystore File Password

Description
The password for the ZooKeeper JMX JKS keystore file.
Related Name
Default Value
API Name
jmx_tls_keystore_password
Required
false

ZooKeeper JMX TLS/SSL Server Trust Store File

Description
The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that ZooKeeper JMX might connect to. This is used when ZooKeeper JMX is the server in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead.
Related Name
Default Value
API Name
jmx_tls_truststore
Required
false

ZooKeeper JMX TLS/SSL Server Trust Store Password

Description
The password for the ZooKeeper JMX TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information.
Related Name
Default Value
API Name
jmx_tls_truststore_password
Required
false

Stacks Collection

Stacks Collection Data Retention

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

Stacks Collection Directory

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

Stacks Collection Enabled

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

Stacks Collection Frequency

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

Stacks Collection Method

Description
The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped.
Related Name
stacks_collection_method
Default Value
jstack
API Name
stacks_collection_method
Required
false

Suppressions

Suppress Parameter Validation: ZooKeeper 'Four Letter Word' Command Whitelist

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper 'Four Letter Word' Command Whitelist parameter.
Related Name
Default Value
false
API Name
role_config_suppression_4lw_commands_whitelist
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: Client Port

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

Suppress Parameter Validation: Client Port Address

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

Suppress Parameter Validation: Data Directory

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

Suppress Parameter Validation: Transaction Log Directory

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

Suppress Parameter Validation: Election Port

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

Suppress Parameter Validation: Name of User with Read-Only access to the JMX Agent

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Name of User with Read-Only access to the JMX Agent parameter.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_passwd_file_readonly_user
Required
true

Suppress Parameter Validation: Password of User with Read-Only Access to the JMX agent

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Password of User with Read-Only Access to the JMX agent parameter.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_passwd_file_readonly_user_password
Required
true

Suppress Parameter Validation: Name of User with Read-Write Access to the JMX Agent

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Name of User with Read-Write Access to the JMX Agent parameter.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_passwd_file_readwrite_user
Required
true

Suppress Parameter Validation: Password of user with read-write access to the JMX agent

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Password of user with read-write access to the JMX agent parameter.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_passwd_file_readwrite_user_password
Required
true

Suppress Parameter Validation: ZooKeeper JMX TLS/SSL Server JKS Keystore File Location

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper JMX TLS/SSL Server JKS Keystore File Location parameter.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_tls_keystore
Required
true

Suppress Parameter Validation: ZooKeeper JMX TLS/SSL Server JKS Keystore File Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper JMX TLS/SSL Server JKS Keystore File Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_tls_keystore_password
Required
true

Suppress Parameter Validation: ZooKeeper JMX TLS/SSL Server Trust Store File

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper JMX TLS/SSL Server Trust Store File parameter.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_tls_truststore
Required
true

Suppress Parameter Validation: ZooKeeper JMX TLS/SSL Server Trust Store Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper JMX TLS/SSL Server Trust Store Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_tls_truststore_password
Required
true

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

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

Suppress Parameter Validation: Rules to Extract Events from Log Files

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

Suppress Parameter Validation: Heap Dump Directory

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

Suppress Parameter Validation: Quorum Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Quorum Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_quorumport
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: JMX Remote Port

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

Suppress Parameter Validation: JMX RMI Server Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX RMI Server Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_server_jmx_rmi_port
Required
true

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

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

Suppress Parameter Validation: Stacks Collection Directory

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

Suppress Parameter Validation: Java Configuration Options for Zookeeper Server

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

Suppress Parameter Validation: ZooKeeper Log Directory

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

Suppress Parameter Validation: Admin Server Port

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

Suppress Parameter Validation: Server Advanced Configuration Snippet (Safety Valve) for zoo.cfg

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

Suppress Parameter Validation: Secure Client Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Client Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_zookeeper_secure_client_port
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_zookeeper_server_audit_health
Required
true

Suppress Health Test: Connection Count

Description
Whether to suppress the results of the Connection Count 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_zookeeper_server_connection_count
Required
true

Suppress Health Test: Data Directory Free Space

Description
Whether to suppress the results of the Data 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_zookeeper_server_data_directory_free_space
Required
true

Suppress Health Test: Transaction Log Directory Free Space

Description
Whether to suppress the results of the Transaction 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_zookeeper_server_data_log_directory_free_space
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_zookeeper_server_file_descriptor
Required
true

Suppress Health Test: GC Duration

Description
Whether to suppress the results of the GC Duration heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_zookeeper_server_gc_duration
Required
true

Suppress Health Test: Heap Dump Directory Free Space

Description
Whether to suppress the results of the Heap Dump Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_zookeeper_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_zookeeper_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_zookeeper_server_log_directory_free_space
Required
true

Suppress Health Test: Maximum Request Latency

Description
Whether to suppress the results of the Maximum Request Latency 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_zookeeper_server_max_latency
Required
true

Suppress Health Test: Outstanding Requests

Description
Whether to suppress the results of the Outstanding Requests 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_zookeeper_server_outstanding_requests
Required
true

Suppress Health Test: Quorum Membership

Description
Whether to suppress the results of the Quorum Membership 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_zookeeper_server_quorum_membership
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_zookeeper_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_zookeeper_server_swap_memory_usage
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_zookeeper_server_unexpected_exits
Required
true

Service-Wide

Advanced

Auto Purge Time Interval

Description
The time interval in hours for which the purge task has to be triggered. Set to a positive integer (1 and above) to enable the auto purging. Defaults to 24.
Related Name
autopurge.purgeInterval
Default Value
1 day(s)
API Name
autopurgeInterval
Required
false

Auto Purge Snapshots Retain Count

Description
When enabled, ZooKeeper auto purge feature retains this many most recent snapshots and the corresponding transaction logs in the dataDir and dataLogDir respectively and deletes the rest. Defaults to 5. Minimum value is 3.
Related Name
autopurge.snapRetainCount
Default Value
5
API Name
autopurgeSnapRetainCount
Required
false

System Group

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

System User

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

Enable auto-creation of data directories

Description
Automatically create data directories at startup, if they do not exist. Enabling this configuration should be used with care as it will suppress any errors in setup of data directories.
Related Name
Default Value
false
API Name
zookeeper_datadir_autocreate
Required
false

ZooKeeper 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
zookeeper_env_safety_valve
Required
false

Monitoring

Enable Log Event Capture

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

Enable Service Level Health Alerts

Description
When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
Related Name
Default Value
true
API Name
enable_alerts
Required
false

Enable Configuration Change Alerts

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

Log Event Retry Frequency

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

Service Triggers

Description
The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific service.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger fires if there are more than 10 DataNodes with more than 500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad", "streamThreshold": 10, "enabled": "true"}]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
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

ZooKeeper Canary Connection Timeout

Description
Configures the timeout used by the canary for connection establishment with ZooKeeper servers
Related Name
Default Value
10 second(s)
API Name
zookeeper_canary_connection_timeout
Required
false

ZooKeeper Canary Health Check

Description
Enables the health check that a client can connect to ZooKeeper and perform basic operations
Related Name
Default Value
true
API Name
zookeeper_canary_health_enabled
Required
false

ZooKeeper Canary Operation Timeout

Description
Configures the timeout used by the canary for ZooKeeper operations
Related Name
Default Value
30 second(s)
API Name
zookeeper_canary_operation_timeout
Required
false

ZooKeeper Canary Root Znode Path

Description
Configures the path of the root znode under which all canary updates are performed
Related Name
Default Value
/cloudera_manager_zookeeper_canary
API Name
zookeeper_canary_root_path
Required
false

ZooKeeper Canary Session Timeout

Description
Configures the timeout used by the canary sessions with ZooKeeper servers
Related Name
Default Value
30 second(s)
API Name
zookeeper_canary_session_timeout
Required
false

Healthy Server Monitoring Thresholds

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

Other

Cleanup Retain Count

Description
The number of snapshot files and corresponding transaction logs to keep when running the Cleanup command.
Related Name
Default Value
5
API Name
cleanupRetainCount
Required
false

Initialization Limit

Description
Amount of time, in ticks, to allow followers to connect and sync to a leader. Increase this value as needed, if the amount of data managed by ZooKeeper is large.
Related Name
initLimit
Default Value
10
API Name
initLimit
Required
false

Jute Max Buffer

Description
The maximum size of the data that can be stored in a znode in bytes.
Related Name
jute.maxbuffer
Default Value
4 MiB
API Name
jute_maxbuffer
Required
false

Leader Serves

Description
Whether the leader accepts client connections.
Related Name
leaderServes
Default Value
yes
API Name
leaderServes
Required
false

Quorum Connection Manager Thread Pool Size

Description
Size of the thread pool quorum connection manager uses to manage connections between quorum servers. Only applies when ZooKeeper Server to Server SASL Authentication is enabled.
Related Name
quorum.cnxn.threads.size
Default Value
20
API Name
quorum_cnxn_threads_size
Required
false

Synchronization Limit

Description
Amount of time, in ticks, to allow followers to sync with ZooKeeper. If followers fall too far behind a leader, they are dropped.
Related Name
syncLimit
Default Value
5
API Name
syncLimit
Required
false

Tick Time

Description
The length of time, in milliseconds, of a single tick, which is the basic time unit used by ZooKeeper. A tick is used to regulate heartbeats and timeouts.
Related Name
tickTime
Default Value
2000
API Name
tickTime
Required
false

Security

Enable Kerberos Authentication

Description
Enable Kerberos authentication for ZooKeeper.
Related Name
enableSecurity
Default Value
false
API Name
enableSecurity
Required
false

Kerberos Principal

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

Enable Server to Server SASL Authentication

Description
Enables SASL authentication between ZooKeeper servers. Only applies when ZooKeeper Kerberos Authentication is enabled.
Related Name
quorum.auth.enableSasl
Default Value
false
API Name
quorum_auth_enable_sasl
Required
false

Enable TLS/SSL for ZooKeeper

Description
Encrypt ZooKeeper communication using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). This option will encrypt all internal communication between ZooKeeper servers (this feature is called QuorumSSL in ZooKeeper). Additionally, choosing this option will also encrypt the communication between ZooKeeper servers and all ZooKeeper client services that support TLS/SSL connections.
Related Name
zookeeper_tls_enabled
Default Value
false
API Name
zookeeper_tls_enabled
Required
false

ZooKeeper TLS/SSL Server JKS Keystore File Location

Description
The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when ZooKeeper is acting as a TLS/SSL server. The keystore must be in JKS format.
Related Name
zookeeper_tls_keystore
Default Value
API Name
zookeeper_tls_keystore
Required
false

ZooKeeper TLS/SSL Server JKS Keystore File Password

Description
The password for the ZooKeeper JKS keystore file.
Related Name
zookeeper_tls_keystore_password
Default Value
API Name
zookeeper_tls_keystore_password
Required
false

ZooKeeper TLS/SSL Server Trust Store File

Description
The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that ZooKeeper might connect to. This is used when ZooKeeper is the server in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead.
Related Name
zookeeper_tls_truststore
Default Value
API Name
zookeeper_tls_truststore
Required
false

ZooKeeper TLS/SSL Server Trust Store Password

Description
The password for the ZooKeeper TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information.
Related Name
zookeeper_tls_truststore_password
Default Value
API Name
zookeeper_tls_truststore_password
Required
false

Suppressions

Suppress Configuration Validator: ZooKeeper 'Four Letter Word' Command Whitelist

Description
Whether to suppress configuration warnings produced by the ZooKeeper 'Four Letter Word' Command Whitelist configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_4lw_commands_whitelist
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: Client Port

Description
Whether to suppress configuration warnings produced by the Client Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_clientport
Required
true

Suppress Configuration Validator: Client Port Address

Description
Whether to suppress configuration warnings produced by the Client Port Address configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_clientportaddress
Required
true

Suppress Configuration Validator: Data Directory

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

Suppress Configuration Validator: Transaction Log Directory

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

Suppress Configuration Validator: Election Port

Description
Whether to suppress configuration warnings produced by the Election Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_electionport
Required
true

Suppress Configuration Validator: Name of User with Read-Only access to the JMX Agent

Description
Whether to suppress configuration warnings produced by the Name of User with Read-Only access to the JMX Agent configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_passwd_file_readonly_user
Required
true

Suppress Configuration Validator: Password of User with Read-Only Access to the JMX agent

Description
Whether to suppress configuration warnings produced by the Password of User with Read-Only Access to the JMX agent configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_passwd_file_readonly_user_password
Required
true

Suppress Configuration Validator: Name of User with Read-Write Access to the JMX Agent

Description
Whether to suppress configuration warnings produced by the Name of User with Read-Write Access to the JMX Agent configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_passwd_file_readwrite_user
Required
true

Suppress Configuration Validator: Password of user with read-write access to the JMX agent

Description
Whether to suppress configuration warnings produced by the Password of user with read-write access to the JMX agent configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_passwd_file_readwrite_user_password
Required
true

Suppress Configuration Validator: ZooKeeper JMX TLS/SSL Server JKS Keystore File Location

Description
Whether to suppress configuration warnings produced by the ZooKeeper JMX TLS/SSL Server JKS Keystore File Location configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_tls_keystore
Required
true

Suppress Configuration Validator: ZooKeeper JMX TLS/SSL Server JKS Keystore File Password

Description
Whether to suppress configuration warnings produced by the ZooKeeper JMX TLS/SSL Server JKS Keystore File Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_tls_keystore_password
Required
true

Suppress Configuration Validator: ZooKeeper JMX TLS/SSL Server Trust Store File

Description
Whether to suppress configuration warnings produced by the ZooKeeper JMX TLS/SSL Server Trust Store File configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_tls_truststore
Required
true

Suppress Configuration Validator: ZooKeeper JMX TLS/SSL Server Trust Store Password

Description
Whether to suppress configuration warnings produced by the ZooKeeper JMX TLS/SSL Server Trust Store Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_jmx_tls_truststore_password
Required
true

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

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

Suppress Configuration Validator: Rules to Extract Events from Log Files

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

Suppress Configuration Validator: Heap Dump Directory

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

Suppress Configuration Validator: Quorum Port

Description
Whether to suppress configuration warnings produced by the Quorum Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_quorumport
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: JMX Remote Port

Description
Whether to suppress configuration warnings produced by the JMX Remote Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_server_jmx_agent_port
Required
true

Suppress Configuration Validator: JMX RMI Server Port

Description
Whether to suppress configuration warnings produced by the JMX RMI Server Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_server_jmx_rmi_port
Required
true

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

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

Suppress Configuration Validator: Stacks Collection Directory

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

Suppress Configuration Validator: Java Configuration Options for Zookeeper Server

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

Suppress Configuration Validator: ZooKeeper Log Directory

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

Suppress Configuration Validator: Admin Server Port

Description
Whether to suppress configuration warnings produced by the Admin Server Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_zookeeper_admin_server_port
Required
true

Suppress Configuration Validator: Server Advanced Configuration Snippet (Safety Valve) for zoo.cfg

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

Suppress Configuration Validator: Secure Client Port

Description
Whether to suppress configuration warnings produced by the Secure Client Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_zookeeper_secure_client_port
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: System Group

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

Suppress Parameter Validation: System User

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

Suppress Configuration Validator: Server Count Validator

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

Suppress Parameter Validation: Service Triggers

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

Suppress Parameter Validation: Service Monitor 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: ZooKeeper Canary Root Znode Path

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper Canary Root Znode Path parameter.
Related Name
Default Value
false
API Name
service_config_suppression_zookeeper_canary_root_path
Required
true

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

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

Suppress Configuration Validator: ZooKeeper Server Count Validator

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

Suppress Configuration Validator: ZooKeeper Server-to-Server Authentication Validation

Description
Whether to suppress configuration warnings produced by the ZooKeeper Server-to-Server Authentication Validation configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_zookeeper_server_to_server_authentication_validator
Required
true

Suppress Parameter Validation: ZooKeeper TLS/SSL Server JKS Keystore File Location

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper TLS/SSL Server JKS Keystore File Location parameter.
Related Name
Default Value
false
API Name
service_config_suppression_zookeeper_tls_keystore
Required
true

Suppress Parameter Validation: ZooKeeper TLS/SSL Server JKS Keystore File Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper TLS/SSL Server JKS Keystore File Password parameter.
Related Name
Default Value
false
API Name
service_config_suppression_zookeeper_tls_keystore_password
Required
true

Suppress Parameter Validation: ZooKeeper TLS/SSL Server Trust Store File

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper TLS/SSL Server Trust Store File parameter.
Related Name
Default Value
false
API Name
service_config_suppression_zookeeper_tls_truststore
Required
true

Suppress Parameter Validation: ZooKeeper TLS/SSL Server Trust Store Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper TLS/SSL Server Trust Store Password parameter.
Related Name
Default Value
false
API Name
service_config_suppression_zookeeper_tls_truststore_password
Required
true

Suppress Health Test: ZooKeeper Canary

Description
Whether to suppress the results of the ZooKeeper Canary 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_zookeeper_canary_health
Required
true

Suppress Health Test: Server Health

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