Cruise Control Properties in Cloudera Runtime 7.2.18

Role groups:

Cruise Control Server

Advanced

Cruise Control Server Advanced Configuration Snippet (Safety Valve) for auth.credentials

Description: For advanced use only. A string to be inserted into auth.credentials for this role only.
Related Name
Default Value
API Name: auth.credentials_role_safety_valve
Required: false

Cruise Control Server Advanced Configuration Snippet (Safety Valve) for capacity.json

Description: For advanced use only. A string to be inserted into capacity.json for this role only.
Related Name
Default Value
API Name: capacity.json_role_safety_valve
Required: false

Cruise Control 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: CRUISE_CONTROL_SERVER_role_env_safety_valve
Required: false

Cruise Control Server Advanced Configuration Snippet (Safety Valve) for cruisecontrol.properties

Description: For advanced use only. A string to be inserted into cruisecontrol.properties for this role only.
Related Name
Default Value
API Name: cruisecontrol.properties_role_safety_valve
Required: false

Cruise Control Server Logging Advanced Configuration Snippet (Safety Valve)

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

Enable auto refresh for metric configurations

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

Heap Dump Directory

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

Dump Heap When Out of Memory

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

Kill When Out of Memory

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

Automatically Restart Process

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

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

Cruise Control Server Advanced Configuration Snippet (Safety Valve) for ssl.properties

Description: For advanced use only. A string to be inserted into ssl.properties for this role only.
Related Name
Default Value
API Name: ssl.properties_role_safety_valve
Required: false

Logs

Cruise Control Server Log Directory

Description: The log directory for log files of the role Cruise Control Server.
Related Name: log_dir
Default Value: /var/log/cruisecontrol
API Name: log_dir
Required: false

Cruise Control Server Logging Threshold

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

Cruise Control Server Maximum Log File Backups

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

Cruise Control Server Max Log Size

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

Monitoring

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: cruise_control_server_fd_thresholds
Required: false

Cruise Control Server Host Health Test

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

Cruise Control Server Process Health Test

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

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

Enable JMX Exporter (beta)

Description: JMX Exporter support is a beta feature. If enabled, CM configures the role to run JMX Exporter in agent mode with the provided port and YAML configuration. This exporter then can be used with the OpenTelemetry Collector feature. See the JMX Exporter documentation.
Related Name
Default Value: false
API Name: jmx_exporter_enabled
Required: true

JMX Exporter Port

Description: JMX Exporter needs a port to implement a Prometheus exporter.
Related Name
Default Value
API Name: jmx_exporter_port
Required: false

JMX Exporter configuration YAML

Description: This configuration is passed to JMX Exporter as it is. See the JMX Exporter documentation.
Related Name
Default Value
API Name: jmx_exporter_yaml
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

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

OpenTelemetry Collector Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: exporters: prometheusremotewrite/$ROLE_NAME: endpoint: $ROLE_PARAM(otelcol_remote_write_url) auth: authenticator: basicauth/common tls: insecure_skip_verify: true retry_on_failure: enabled: true initial_interval: 10s max_interval: 40s max_elapsed_time: 300s
API Name: otelcol_exporters
Required: false

OpenTelemetry Collector Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: extensions: basicauth/common: client_auth: username: $ROLE_PARAM(otelcol_remote_write_user) password: '$ROLE_PARAM(otelcol_remote_write_password)'
API Name: otelcol_extensions
Required: false

OpenTelemetry Collector Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_processors
Required: false

OpenTelemetry Collector Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value
API Name: otelcol_receivers
Required: false

OpenTelemetry Collector Remote Write Password

Description: Remote write password for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_password) expression. Specify $INFRA(cdp_request_signer_password) when forwarding to Cloudera Observability central monitoring. (This is the default.)
Related Name
Default Value: ******
API Name: otelcol_remote_write_password
Required: false

OpenTelemetry Collector Remote Write URL

Description: Remote write URL for the OpenTelemetry Collector. This param is for convenience and intended to be used at the exporters section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_url) expression. Specify $INFRA(cdp_request_signer_url) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_url)
API Name: otelcol_remote_write_url
Required: false

OpenTelemetry Collector Remote Write Username

Description: Remote write username for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_user) expression. Specify $INFRA(cdp_request_signer_username) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_username)
API Name: otelcol_remote_write_user
Required: false

OpenTelemetry Collector Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_service
Required: false

Enable OpenTelemetry Collector (beta)

Description: OpenTelemetry Collector support is a new beta feature (will change without notice) which can run OpenTelemetry Collector as an agent together with the CM Agent to forward metrics to a Prometheus like storage.
Related Name
Default Value: false
API Name: otelcol_should_collect
Required: true

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

Anomaly Detection Goals

Description: The list of goals that the anomaly detector should detect if they are violated. It must be a subset of Self-Healing Goals and thus also of Default Goals.
Related Name: anomaly.detection.goals
Default Value: com.linkedin.kafka.cruisecontrol.analyzer.goals.RackAwareGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.ReplicaCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.DiskCapacityGoal
API Name: anomaly.detection.goals
Required: true

Anomaly Notifier Class

Description: The notifier class to trigger an alert when an anomaly is violated.
Related Name: anomaly.notifier.class
Default Value: com.linkedin.kafka.cruisecontrol.detector.notifier.NoopNotifier
API Name: anomaly.notifier.class
Required: false

ADMIN Level Users

Description: The list of ADMIN level users.
Related Name: auth_admins
Default Value
API Name: auth_admins
Required: false

Authentication Method

Description: Authentication method that Cruise Control uses to authenticate clients.
Related Name: auth_method
Default Value: none
API Name: auth_method
Required: false

USER Level Users

Description: The list of USER level users.
Related Name: auth_users
Default Value
API Name: auth_users
Required: false

VIEWER Level Users

Description: The list of VIEWER level users.
Related Name: auth_viewers
Default Value
API Name: auth_viewers
Required: false

Broker Metrics Topic

Description: The config for the Kafka sample store to save the model training samples.
Related Name: broker.metric.sample.store.topic
Default Value: __KafkaCruiseControlModelTrainingSamples
API Name: broker.metric.sample.store.topic
Required: true

Broker Metrics Window Size

Description: The broker metrics window size in milliseconds.
Related Name: broker.metrics.window.ms
Default Value: 5 minute(s)
API Name: broker.metrics.window.ms
Required: true

Default CPU Capacity

Description: Default CPU capacity in capacity.json config.
Related Name: capacity.default.cpu
Default Value: 100 %
API Name: capacity.default.cpu
Required: true

Default Incoming Network Capacity

Description: Default incoming network capacity in capacity.json config.
Related Name: capacity.default.network-in
Default Value: 100000 KiB
API Name: capacity.default.network-in
Required: true

Default Outgoing Network Capacity

Description: Default outgoing network capacity in capacity.json config.
Related Name: capacity.default.network-out
Default Value: 100000 KiB
API Name: capacity.default.network-out
Required: true

CPU Balance Threshold

Description: The maximum allowed extent of unbalance for CPU utilization, enforced by the goal optimization. For example, 1.10 means the highest CPU usage of a broker should not be above 1.10x of average CPU utilization of all the brokers.
Related Name: cpu.balance.threshold
Default Value: 1.1
API Name: cpu.balance.threshold
Required: false

CPU Capacity Threshold

Description: The maximum percentage of the total broker.cpu.capacity that is allowed to be used on a broker, enforced by the goal optimization. The analyzer will enforce a hard goal that the CPU utilization of a broker cannot be higher than (broker.cpu.capacity * cpu.capacity.threshold).
Related Name: cpu.capacity.threshold
Default Value: 0.7
API Name: cpu.capacity.threshold
Required: false

Default Goals

Description: The list of goals to pre-compute proposals or to compute completeness requirements if Self-Healing Goals is not specified.
Related Name: default.goals
Default Value: com.linkedin.kafka.cruisecontrol.analyzer.goals.RackAwareGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.ReplicaCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.DiskCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkInboundCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkOutboundCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.CpuCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.ReplicaDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.PotentialNwOutGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.DiskUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkInboundUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkOutboundUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.CpuUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.TopicReplicaDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.LeaderReplicaDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.LeaderBytesInDistributionGoal
API Name: default.goals
Required: true

Disk Balance Threshold

Description: The maximum allowed extent of unbalance for disk utilization, enforced by the goal optimization. For example, 1.10 means the highest disk usage of a broker should not be above 1.10x of average disk utilization of all the brokers.
Related Name: disk.balance.threshold
Default Value: 1.1
API Name: disk.balance.threshold
Required: false

Disk Capacity Threshold

Description: The maximum percentage of the total broker.disk.capacity that is allowed to be used on a broker, enforced by the goal optimization. The analyzer will enforce a hard goal that the disk usage of a broker cannot be higher than (broker.disk.capacity * disk.capacity.threshold).
Related Name: disk.capacity.threshold
Default Value: 0.8
API Name: disk.capacity.threshold
Required: false

Supported Goals

Description: The list of supported goals.
Related Name: goals
Default Value: com.linkedin.kafka.cruisecontrol.analyzer.goals.RackAwareGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.ReplicaCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.DiskCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkInboundCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkOutboundCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.CpuCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.ReplicaDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.PotentialNwOutGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.DiskUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkInboundUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkOutboundUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.CpuUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.TopicReplicaDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.LeaderReplicaDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.LeaderBytesInDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.PreferredLeaderElectionGoal com.linkedin.kafka.cruisecontrol.analyzer.kafkaassigner.KafkaAssignerDiskUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.kafkaassigner.KafkaAssignerEvenRackAwareGoal
API Name: goals
Required: true

Graceful Shutdown Timeout

Description: The timeout in milliseconds to wait for graceful shutdown to complete.
Related Name
Default Value: 1 minute(s)
API Name: graceful_stop_timeout
Required: false

Hard Goals

Description: The list of goals that any optimization proposal must fulfill if Cruise Control runs in non-kafka-assigner mode and skip_hard_goal_check parameter is not set in the request.
Related Name: hard.goals
Default Value: com.linkedin.kafka.cruisecontrol.analyzer.goals.RackAwareGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.ReplicaCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.DiskCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkInboundCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkOutboundCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.CpuCapacityGoal
API Name: hard.goals
Required: false

Leader Replica Count Balance Threshold

Description: The maximum allowed extent of unbalance for leader replica distribution, enforced by the goal optimization. For example, 1.10 means the highest leader replica count of a broker should not be above 1.10x of average leader replica count of all alive brokers.
Related Name: leader.replica.count.balance.threshold
Default Value: 1.1
API Name: leader.replica.count.balance.threshold
Required: false

Metric Anomaly Finder Class

Description: A list of metric anomaly finder classes to identify metric anomalies.
Related Name: metric.anomaly.finder.class
Default Value: com.linkedin.kafka.cruisecontrol.detector.NoopMetricAnomalyFinder
API Name: metric.anomaly.finder.class
Required: false

Network Inbound Balance Threshold

Description: The maximum allowed extent of unbalance for network inbound usage, enforced by the goal optimization. For example, 1.10 means the highest network inbound usage of a broker should not be above 1.10x of average network inbound usage of all the brokers.
Related Name: network.inbound.balance.threshold
Default Value: 1.1
API Name: network.inbound.balance.threshold
Required: false

Network Inbound Capacity Threshold

Description: The maximum percentage of the total broker.network.inbound.capacity that is allowed to be used on a broker, enforced by the goal optimization. The analyzer will enforce a hard goal that the disk usage of a broker cannot be higher than (broker.network.inbound.capacity * network.inbound.capacity.threshold).
Related Name: network.inbound.capacity.threshold
Default Value: 0.8
API Name: network.inbound.capacity.threshold
Required: false

Network Outbound Balance Threshold

Description: The maximum allowed extent of unbalance for network outbound usage, enforced by the goal optimization. For example, 1.10 means the highest network outbound usage of a broker should not be above 1.10x of average network outbound usage of all the brokers.
Related Name: network.outbound.balance.threshold
Default Value: 1.1
API Name: network.outbound.balance.threshold
Required: false

Network Outbound Capacity Threshold

Description: The maximum percentage of the total broker.network.outbound.capacity that is allowed to be used on a broker, enforced by the goal optimization. The analyzer will enforce a hard goal that the disk usage of a broker cannot be higher than (broker.network.outbound.capacity * network.outbound.capacity.threshold).
Related Name: network.outbound.capacity.threshold
Default Value: 0.8
API Name: network.outbound.capacity.threshold
Required: false

Number of Broker Metric Windows

Description: The total number of windows to keep for broker metric samples.
Related Name: num.broker.metrics.windows
Default Value: 5
API Name: num.broker.metrics.windows
Required: true

Number of Metric Fetchers

Description: The number of metric fetcher threads.
Related Name: num.metric.fetchers
Default Value: 1
API Name: num.metric.fetchers
Required: true

Number of Partition Metric Windows

Description: The total number of windows to keep for partition metric samples.
Related Name: num.partition.metrics.windows
Default Value: 5
API Name: num.partition.metrics.windows
Required: true

Partition Metrics Topic

Description: The config for the Kafka sample store to save the partition metric samples.
Related Name: partition.metric.sample.store.topic
Default Value: __KafkaCruiseControlPartitionMetricSamples
API Name: partition.metric.sample.store.topic
Required: true

Partition Metrics Window Size

Description: The partition metrics window size in milliseconds.
Related Name: partition.metrics.window.ms
Default Value: 5 minute(s)
API Name: partition.metrics.window.ms
Required: true

Replica Count Balance Threshold

Description: The maximum allowed extent of unbalance for replica distribution, enforced by the goal optimization. For example, 1.10 means the highest replica count of a broker should not be above 1.10x of average replica count of all brokers.
Related Name: replica.count.balance.threshold
Default Value: 1.1
API Name: replica.count.balance.threshold
Required: false

Self Healing Enabled

Description: Whether to enable self healing for all anomaly detectors, unless the particular anomaly detector is explicitly disabled.
Related Name: self.healing.enabled
Default Value: false
API Name: self.healing.enabled
Required: false

Self-Healing Goals

Description: The list of goals to be used for self-healing relevant anomalies. If empty, uses Default Goals for self-healing.
Related Name: self.healing.goals
Default Value
API Name: self.healing.goals
Required: false

Enable Trusted Proxy Fallback to Spnego

Description: If no doAs user is provided in Trusted Proxy authentication then it proceeds with using the service user for executing the request.
Related Name: trusted.proxy.spnego.fallback.enabled
Default Value: false
API Name: trusted.proxy.spnego.fallback.enabled
Required: false

Trusted Proxy Authentication Service

Description: The username part of the trusted proxy authentication service's principal.
Related Name: trusted_auth_service_user
Default Value: knox
API Name: trusted_auth_service_user
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

Cruise Control Webserver Port

Description: The endpoint of the REST interface.
Related Name: webserver.http.port
Default Value: 8899
API Name: webserver.http.port
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

Cruise Control Server TLS/SSL 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 Cruise Control Server might connect to. 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: ssl.truststore.location
Default Value
API Name: ssl_client_truststore_location
Required: false

Cruise Control Server TLS/SSL Trust Store Password

Description: The password for the Cruise Control Server TLS/SSL 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: ssl.truststore.password
Default Value
API Name: ssl_client_truststore_password
Required: false

Enable TLS/SSL for Cruise Control Server

Description: Encrypt communication between clients and Cruise Control Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name: webserver.ssl.enable
Default Value: false
API Name: ssl_enabled
Required: false

Cruise Control Server TLS/SSL Server Keystore Key Password

Description: The password that protects the private key contained in the keystore used when Cruise Control Server is acting as a TLS/SSL server.
Related Name: webserver.ssl.key.password
Default Value
API Name: ssl_server_keystore_keypassword
Required: false

Cruise Control Server TLS/SSL Server 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 Cruise Control Server is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name: webserver.ssl.keystore.location
Default Value
API Name: ssl_server_keystore_location
Required: false

Cruise Control Server TLS/SSL Server Keystore File Password

Description: The password for the Cruise Control Server keystore file.
Related Name: webserver.ssl.keystore.password
Default Value
API Name: ssl_server_keystore_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: Anomaly Detection Goals

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Anomaly Detection Goals parameter.
Related Name
Default Value: false
API Name: role_config_suppression_anomaly.detection.goals
Required: true

Suppress Parameter Validation: Anomaly Notifier Class

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Anomaly Notifier Class parameter.
Related Name
Default Value: false
API Name: role_config_suppression_anomaly.notifier.class
Required: true

Suppress Parameter Validation: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for auth.credentials

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server Advanced Configuration Snippet (Safety Valve) for auth.credentials parameter.
Related Name
Default Value: false
API Name: role_config_suppression_auth.credentials_role_safety_valve
Required: true

Suppress Parameter Validation: ADMIN Level Users

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

Suppress Parameter Validation: USER Level Users

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

Suppress Parameter Validation: VIEWER Level Users

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

Suppress Parameter Validation: Broker Metrics Topic

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Broker Metrics Topic parameter.
Related Name
Default Value: false
API Name: role_config_suppression_broker.metric.sample.store.topic
Required: true

Suppress Parameter Validation: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for capacity.json

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server Advanced Configuration Snippet (Safety Valve) for capacity.json parameter.
Related Name
Default Value: false
API Name: role_config_suppression_capacity.json_role_safety_valve
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: Cruise Control Server Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for cruisecontrol.properties

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

Suppress Parameter Validation: Default Goals

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

Suppress Parameter Validation: Supported Goals

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

Suppress Parameter Validation: Hard Goals

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

Suppress Parameter Validation: JMX Exporter Port

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

Suppress Parameter Validation: JMX Exporter configuration YAML

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

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

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

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

Suppress Parameter Validation: Metric Anomaly Finder Class

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metric Anomaly Finder Class parameter.
Related Name
Default Value: false
API Name: role_config_suppression_metric.anomaly.finder.class
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: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
Required: true

Suppress Parameter Validation: Partition Metrics Topic

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Partition Metrics Topic parameter.
Related Name
Default Value: false
API Name: role_config_suppression_partition.metric.sample.store.topic
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: Self-Healing Goals

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Self-Healing Goals parameter.
Related Name
Default Value: false
API Name: role_config_suppression_self.healing.goals
Required: true

Suppress Parameter Validation: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for ssl.properties

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

Suppress Parameter Validation: Cruise Control Server TLS/SSL Trust Store File

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

Suppress Parameter Validation: Cruise Control Server TLS/SSL Trust Store Password

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

Suppress Parameter Validation: Cruise Control Server TLS/SSL Server Keystore Key Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server TLS/SSL Server Keystore Key Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_keypassword
Required: true

Suppress Parameter Validation: Cruise Control Server TLS/SSL Server Keystore File Location

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

Suppress Parameter Validation: Cruise Control Server TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_password
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: Trusted Proxy Authentication Service

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Trusted Proxy Authentication Service parameter.
Related Name
Default Value: false
API Name: role_config_suppression_trusted_auth_service_user
Required: true

Suppress Parameter Validation: Cruise Control Webserver Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Webserver Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webserver.http.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_cruise_control_cruise_control_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_cruise_control_cruise_control_server_file_descriptor
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_cruise_control_cruise_control_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_cruise_control_cruise_control_server_log_directory_free_space
Required: true

Suppress Health Test: Otelcol Health

Description: Whether to suppress the results of the Otelcol 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_cruise_control_cruise_control_server_otelcol_health
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_cruise_control_cruise_control_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_cruise_control_cruise_control_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_cruise_control_cruise_control_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_cruise_control_cruise_control_server_unexpected_exits
Required: true

Service-Wide

Advanced

Cruise Control 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: CRUISE_CONTROL_service_env_safety_valve
Required: false

System Group

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

System User

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

Monitoring

Cruise Control Server Role Health Test

Description: When computing the overall CRUISE_CONTROL health, consider Cruise Control Server's health
Related Name
Default Value: true
API Name: CRUISE_CONTROL_CRUISE_CONTROL_SERVER_health_enabled
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

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

KAFKA Service

Description: Name of the KAFKA service that this Cruise Control service instance depends on
Related Name
Default Value
API Name: kafka_service
Required: true

ZooKeeper Service

Description: Name of the ZooKeeper service that this Cruise Control service instance depends on
Related Name
Default Value
API Name: zookeeper_service
Required: true

Security

Kerberos Principal

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

Suppressions

Suppress Configuration Validator: Anomaly Detection Goals

Description: Whether to suppress configuration warnings produced by the Anomaly Detection Goals configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_anomaly.detection.goals
Required: true

Suppress Configuration Validator: Anomaly Notifier Class

Description: Whether to suppress configuration warnings produced by the Anomaly Notifier Class configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_anomaly.notifier.class
Required: true

Suppress Configuration Validator: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for auth.credentials

Description: Whether to suppress configuration warnings produced by the Cruise Control Server Advanced Configuration Snippet (Safety Valve) for auth.credentials configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_auth.credentials_role_safety_valve
Required: true

Suppress Configuration Validator: ADMIN Level Users

Description: Whether to suppress configuration warnings produced by the ADMIN Level Users configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_auth_admins
Required: true

Suppress Configuration Validator: USER Level Users

Description: Whether to suppress configuration warnings produced by the USER Level Users configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_auth_users
Required: true

Suppress Configuration Validator: VIEWER Level Users

Description: Whether to suppress configuration warnings produced by the VIEWER Level Users configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_auth_viewers
Required: true

Suppress Configuration Validator: Broker Metrics Topic

Description: Whether to suppress configuration warnings produced by the Broker Metrics Topic configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_broker.metric.sample.store.topic
Required: true

Suppress Configuration Validator: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for capacity.json

Description: Whether to suppress configuration warnings produced by the Cruise Control Server Advanced Configuration Snippet (Safety Valve) for capacity.json configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_capacity.json_role_safety_valve
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: Cruise Control Server Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Configuration Validator: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for cruisecontrol.properties

Description: Whether to suppress configuration warnings produced by the Cruise Control Server Advanced Configuration Snippet (Safety Valve) for cruisecontrol.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cruisecontrol.properties_role_safety_valve
Required: true

Suppress Configuration Validator: Default Goals

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

Suppress Configuration Validator: Supported Goals

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

Suppress Configuration Validator: Hard Goals

Description: Whether to suppress configuration warnings produced by the Hard Goals configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hard.goals
Required: true

Suppress Configuration Validator: JMX Exporter Port

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

Suppress Configuration Validator: JMX Exporter configuration YAML

Description: Whether to suppress configuration warnings produced by the JMX Exporter configuration YAML configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_yaml
Required: true

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

Description: Whether to suppress configuration warnings produced by the Cruise Control 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: Cruise Control Server Log Directory

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

Suppress Configuration Validator: Metric Anomaly Finder Class

Description: Whether to suppress configuration warnings produced by the Metric Anomaly Finder Class configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_metric.anomaly.finder.class
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: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Exporters Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Extensions Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Processors Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Receivers Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write URL configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write Username configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Service Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
Required: true

Suppress Configuration Validator: Partition Metrics Topic

Description: Whether to suppress configuration warnings produced by the Partition Metrics Topic configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_partition.metric.sample.store.topic
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: Self-Healing Goals

Description: Whether to suppress configuration warnings produced by the Self-Healing Goals configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_self.healing.goals
Required: true

Suppress Configuration Validator: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for ssl.properties

Description: Whether to suppress configuration warnings produced by the Cruise Control Server Advanced Configuration Snippet (Safety Valve) for ssl.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl.properties_role_safety_valve
Required: true

Suppress Configuration Validator: Cruise Control Server TLS/SSL Trust Store File

Description: Whether to suppress configuration warnings produced by the Cruise Control Server TLS/SSL Trust Store File configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_location
Required: true

Suppress Configuration Validator: Cruise Control Server TLS/SSL Trust Store Password

Description: Whether to suppress configuration warnings produced by the Cruise Control Server TLS/SSL Trust Store Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_password
Required: true

Suppress Configuration Validator: Cruise Control Server TLS/SSL Server Keystore Key Password

Description: Whether to suppress configuration warnings produced by the Cruise Control Server TLS/SSL Server Keystore Key Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_keypassword
Required: true

Suppress Configuration Validator: Cruise Control Server TLS/SSL Server Keystore File Location

Description: Whether to suppress configuration warnings produced by the Cruise Control Server TLS/SSL Server Keystore File Location configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_location
Required: true

Suppress Configuration Validator: Cruise Control Server TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the Cruise Control Server TLS/SSL Server Keystore File Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_password
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: Trusted Proxy Authentication Service

Description: Whether to suppress configuration warnings produced by the Trusted Proxy Authentication Service configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_trusted_auth_service_user
Required: true

Suppress Configuration Validator: Cruise Control Webserver Port

Description: Whether to suppress configuration warnings produced by the Cruise Control Webserver Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_webserver.http.port
Required: true

Suppress Configuration Validator: Cruise Control Server Count Validator

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

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

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Service Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: service_config_suppression_cruise_control_service_env_safety_valve
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 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 Health Test: Cruise Control Server Health

Description: Whether to suppress the results of the Cruise Control 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_cruise_control_cruise_control_cruise_control_server_health
Required: true