The directory where the client configs will be deployed
Related Name
Default Value
/etc/knox
API Name
client_config_root_dir
Required
true
Monitoring🔗
Enable Configuration Change Alerts🔗
Description
When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value
false
API Name
enable_config_alerts
Required
false
Other🔗
Alternatives Priority🔗
Description
The priority level that the client configuration will have in the Alternatives system on the hosts. Higher priority levels will cause Alternatives to prefer this configuration over any others.
Related Name
Default Value
50
API Name
client_config_priority
Required
true
Suppressions🔗
Suppress Configuration Validator: CDH Version Validator🔗
Description
Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_cdh_version_validator
Required
true
Suppress Parameter Validation: Deploy Directory🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Deploy Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_client_config_root_dir
Required
true
Knox Gateway🔗
Advanced🔗
Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/auto-discovery-advanced-configuration-cdp-proxy-api.properties🔗
Description
For advanced use only. A string to be inserted into conf/auto-discovery-advanced-configuration-cdp-proxy-api.properties for this role only.
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.
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
Logs🔗
Knox Gateway Log Directory🔗
Description
The log directory for log files of the role Knox Gateway.
Related Name
log_dir
Default Value
/var/log/knox/gateway
API Name
log_dir
Required
false
Knox Gateway Logging Threshold🔗
Description
The minimum log level for Knox Gateway logs
Related Name
Default Value
INFO
API Name
log_threshold
Required
false
Knox Gateway Maximum Log File Backups🔗
Description
The maximum number of rolled log files to keep for Knox Gateway logs. Typically used by log4j or logback.
Related Name
Default Value
10
API Name
max_log_backup_index
Required
false
Knox Gateway Max Log Size🔗
Description
The maximum size, in megabytes, per log file for Knox Gateway logs. Typically used by log4j or logback.
Related Name
Default Value
200 MiB
API Name
max_log_size
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
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
knox_gateway_fd_thresholds
Required
false
Knox Gateway Host Health Test🔗
Description
When computing the overall Knox Gateway health, consider the host's health.
Related Name
Default Value
true
API Name
knox_gateway_host_health_enabled
Required
false
Knox Gateway Process Health Test🔗
Description
Enables the health test that the Knox Gateway's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
knox_gateway_scm_health_enabled
Required
false
Log Directory Free Space Monitoring Absolute Thresholds🔗
Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value
Warning: 10 GiB, Critical: 5 GiB
API Name
log_directory_free_space_absolute_thresholds
Required
false
Log Directory Free Space Monitoring Percentage Thresholds🔗
Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
log_directory_free_space_percentage_thresholds
Required
false
Metric Filter🔗
Description
Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
Include only Health Test Metric Set: Selected.
Include/Exclude Custom Metrics: Set to Include.
Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{
"includeHealthTestMetricSet": true,
"filterType": "whitelist",
"metrics": ["jvm_heap_used_mb"]
}
Related Name
Default Value
API Name
monitoring_metric_filter
Required
false
Swap Memory Usage Rate Thresholds🔗
Description
The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
process_swap_memory_rate_thresholds
Required
false
Swap Memory Usage Rate Window🔗
Description
The period to review when computing unexpected swap memory usage change of the process.
Related Name
common.process.swap_memory_rate_window
Default Value
5 minute(s)
API Name
process_swap_memory_rate_window
Required
false
Process Swap Memory Thresholds🔗
Description
The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value
Warning: 200 B, Critical: Never
API Name
process_swap_memory_thresholds
Required
false
Role Triggers🔗
Description
The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
triggerName(mandatory) - The name of the trigger. This value must be unique for the specific role.
triggerExpression(mandatory) - A tsquery expression representing the trigger.
streamThreshold(optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger",
"triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad",
"streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
Related Name
Default Value
[]
API Name
role_triggers
Required
true
Unexpected Exits Thresholds🔗
Description
The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value
Warning: Never, Critical: Any
API Name
unexpected_exits_thresholds
Required
false
Unexpected Exits Monitoring Period🔗
Description
The period to review when computing unexpected exits.
Related Name
Default Value
5 minute(s)
API Name
unexpected_exits_window
Required
false
Other🔗
Knox Gateway Diagnostics Collection Timeout🔗
Description
The timeout in milliseconds to wait for diagnostics collection to complete.
Related Name
Default Value
5 minute(s)
API Name
csd_role_diagnostics_timeout
Required
false
Auto Discovery - Address🔗
Description
The URL which Knox's service auto-discovery feature uses to connect to
Related Name
gateway.auto.discovery.address
Default Value
API Name
gateway_auto_discovery_address
Required
false
Auto Discovery - Advanced Configuration Monitoring Interval🔗
Description
Defines the frequency of Knox's service auto-discovery advanced configuration files (auto-discovery-advanced-configuration-[cdp-proxy|cdp-proxy-api].properties) monitoring.
Contains configuration files that apply to the gateway globally (i.e. not cluster specific ).
Related Name
gateway_conf_dir
Default Value
/var/lib/knox/gateway/conf
API Name
gateway_conf_dir
Required
false
Knox Gateway Data Directory🔗
Description
Contains security and topology specific artifacts as well as important applications for admin-ui
Related Name
gateway_data_dir
Default Value
/var/lib/knox/gateway/data
API Name
gateway_data_dir
Required
false
Gateway - Default App Topology Name🔗
Description
When a topology file is deployed with a file name that matches the configured default topology name, a specialized mapping for URLs is installed for that particular topology. This allows the URLs that are expected by the existing Hadoop CLIs for WebHDFS to be used in interacting with the specific Hadoop cluster that is represented by the default topology file.
Related Name
default.app.topology.name
Default Value
API Name
gateway_default_topology_name
Required
false
Knox Simplified Topology Management - cdp-proxy🔗
Description
Knox descriptor block for 'cdp-proxy' topology. 'providerConfigRef' indicates the name of shared-provider the given descriptor would like to use. The rest of the entries hold service information. The structure of an service information entry is: $SERVICE_NAME[:$PARAMETER_NAME=$PARAMETER_VALUE]. The 'url' and 'version' parameter names are preserved keywords to set the given service's URL and version. For instance: HIVE:url=http://localhost:123, HIVE:version:3.0.0, HIVE:test.pramameter.name=test.parameter.value
Knox descriptor block for 'cdp-proxy-api topology. 'providerConfigRef' indicates the name of shared-provider the given descriptor would like to use. The rest of the entries hold service information. The structure of an service information entry is: $SERVICE_NAME[:$PARAMETER_NAME=$PARAMETER_VALUE]. The 'url' and 'version' parameter names are preserved keywords to set the given service's URL and version. For instance: NIFI, HIVE:url=http://localhost:123, HIVE:version:3.0.0, HIVE:test.pramameter.name=test.parameter.value
The whitelist to be applied for dispatches associated with the service roles specified by gateway.dispatch.whitelist.services. By default this is replaced with DEFAULT or HTTPS_ONLY based on if TLS is enabled.
Related Name
gateway.dispatch.whitelist
Default Value
WHITELIST_CONFIG_REPLACEME
API Name
gateway_dispatch_whitelist
Required
false
Knox Gateway Dispatch Whitelist Services🔗
Description
The comma-delimited list of service roles for which the 'gateway.dispatch.whitelist' should be applied
The directory within 'gateway_data_dir' that contains gateway topology files and deployments.
Related Name
gateway.gateway.conf.dir
Default Value
deployments
API Name
gateway_gateway_conf_dir
Required
false
Knox Gateway Initial/Max Heapsize🔗
Description
Initial/Maximum size for the Java Process heap. Passed to Java -Xmx/-Xms. Measured in megabytes.
Related Name
gateway_heap_size
Default Value
1 GiB
API Name
gateway_heap_size
Required
true
Additional Gateway Java Options🔗
Description
These arguments are passed as part of the Java command line. Commonly, garbage collection flags or extra debugging flags are passed here. -Xmx/-Xms should not be specified here: to set the heapsize use the 'Knox Gateway Initial/Max Heapsize' parameter
Related Name
gateway_java_opts
Default Value
API Name
gateway_java_opts
Required
false
Admin Groups🔗
Description
Admin groups for Knox
Related Name
gateway.knox.admin.groups
Default Value
admin
API Name
gateway_knox_admin_groups
Required
false
Knox Gateway Log Level🔗
Description
The logging level of Knox Gateway
Related Name
gateway_log_level
Default Value
ERROR
API Name
gateway_log_level
Required
false
Knox Master Secret🔗
Description
The master secret is used to access secured artifacts by the gateway instance. Keystore, trust stores and credential stores are all protected with the master secret. NOTE: changing the master secret will require you to change passwords protecting the keystores for the gateway, identity keystores and all credential stores
Related Name
gateway_master_secret
Default Value
API Name
gateway_master_secret
Required
true
Gateway Path🔗
Description
The default context path for the gateway.
Related Name
gateway.path
Default Value
gateway
API Name
gateway_path
Required
true
Ranger Knox Plugin Conf Path🔗
Description
Staging directory for Ranger Knox Plugin Configuration. This should generally not be changed.
Boolean flag indicating whether to enable debug messages for krb5 authentication
Related Name
sun.security.krb5.debug
Default Value
false
API Name
sun_security_krb5_debug
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🔗
Gateway HTTP Port🔗
Description
The HTTP port for the Gateway.
Related Name
gateway.port
Default Value
8443
API Name
gateway_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🔗
Knox Gateway 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 Knox Gateway 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
gateway.httpclient.truststore.path
Default Value
API Name
ssl_client_truststore_location
Required
false
Knox Gateway TLS/SSL Trust Store Password🔗
Description
The password for the Knox Gateway 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
Default Value
API Name
ssl_client_truststore_password
Required
false
Enable TLS/SSL for Knox Gateway🔗
Description
Encrypt communication between clients and Knox Gateway using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name
knox.enableTLS
Default Value
false
API Name
ssl_enabled
Required
false
Knox Gateway 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 Knox Gateway is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name
gateway.tls.keystore.path
Default Value
API Name
ssl_server_keystore_location
Required
false
Knox Gateway TLS/SSL Server Keystore File Password🔗
Description
The password for the Knox Gateway keystore file.
Related Name
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 Configuration Validator: CDH Version Validator🔗
Description
Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/auto-discovery-advanced-configuration-cdp-proxy-api.properties parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/auto-discovery-advanced-configuration-cdp-proxy.properties parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/cdp-descriptors.xml parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/gateway-site.xml parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-audit.xml parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-policymgr-ssl.xml parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-security.xml parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Simplified Topology Management - cdp-proxy parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Simplified Topology Management - cdp-proxy-api parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Knox Plugin Audit Hdfs Spool Directory Path parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Knox Plugin Policy Cache Directory Path parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Knox Plugin Audit Solr Spool Directory Path parameter.
Suppress Parameter Validation: Security - TLS Certificate Alias (Optional)🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Security - TLS Certificate Alias (Optional) parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Environment Advanced Configuration Snippet (Safety Valve) parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Logging Advanced Configuration Snippet (Safety Valve) parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_oom_heap_dump_dir
Required
true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_rm_custom_resources
Required
true
Suppress Parameter Validation: Role Triggers🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value
false
API Name
role_config_suppression_role_triggers
Required
true
Suppress Parameter Validation: Knox Gateway TLS/SSL Trust Store File🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway TLS/SSL Trust Store File parameter.
Suppress Parameter Validation: Knox Gateway TLS/SSL Server Keystore File Location🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway TLS/SSL Server Keystore File Location parameter.
Suppress Parameter Validation: Knox Gateway TLS/SSL Server Keystore File Password🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway TLS/SSL Server Keystore File Password parameter.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
Logs🔗
Knox IDBroker Log Directory🔗
Description
The log directory for log files of the role Knox IDBroker.
Related Name
log_dir
Default Value
/var/log/knox/idbroker
API Name
log_dir
Required
false
Knox IDBroker Logging Threshold🔗
Description
The minimum log level for Knox IDBroker logs
Related Name
Default Value
INFO
API Name
log_threshold
Required
false
Knox IDBroker Maximum Log File Backups🔗
Description
The maximum number of rolled log files to keep for Knox IDBroker logs. Typically used by log4j or logback.
Related Name
Default Value
10
API Name
max_log_backup_index
Required
false
Knox IDBroker Max Log Size🔗
Description
The maximum size, in megabytes, per log file for Knox IDBroker logs. Typically used by log4j or logback.
Related Name
Default Value
200 MiB
API Name
max_log_size
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
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
idbroker_fd_thresholds
Required
false
Knox IDBroker Host Health Test🔗
Description
When computing the overall Knox IDBroker health, consider the host's health.
Related Name
Default Value
true
API Name
idbroker_host_health_enabled
Required
false
Knox IDBroker Process Health Test🔗
Description
Enables the health test that the Knox IDBroker's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
idbroker_scm_health_enabled
Required
false
Log Directory Free Space Monitoring Absolute Thresholds🔗
Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value
Warning: 10 GiB, Critical: 5 GiB
API Name
log_directory_free_space_absolute_thresholds
Required
false
Log Directory Free Space Monitoring Percentage Thresholds🔗
Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
log_directory_free_space_percentage_thresholds
Required
false
Metric Filter🔗
Description
Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
Include only Health Test Metric Set: Selected.
Include/Exclude Custom Metrics: Set to Include.
Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{
"includeHealthTestMetricSet": true,
"filterType": "whitelist",
"metrics": ["jvm_heap_used_mb"]
}
Related Name
Default Value
API Name
monitoring_metric_filter
Required
false
Swap Memory Usage Rate Thresholds🔗
Description
The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
process_swap_memory_rate_thresholds
Required
false
Swap Memory Usage Rate Window🔗
Description
The period to review when computing unexpected swap memory usage change of the process.
Related Name
common.process.swap_memory_rate_window
Default Value
5 minute(s)
API Name
process_swap_memory_rate_window
Required
false
Process Swap Memory Thresholds🔗
Description
The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value
Warning: 200 B, Critical: Never
API Name
process_swap_memory_thresholds
Required
false
Role Triggers🔗
Description
The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
triggerName(mandatory) - The name of the trigger. This value must be unique for the specific role.
triggerExpression(mandatory) - A tsquery expression representing the trigger.
streamThreshold(optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger",
"triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad",
"streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
Related Name
Default Value
[]
API Name
role_triggers
Required
true
Unexpected Exits Thresholds🔗
Description
The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value
Warning: Never, Critical: Any
API Name
unexpected_exits_thresholds
Required
false
Unexpected Exits Monitoring Period🔗
Description
The period to review when computing unexpected exits.
Related Name
Default Value
5 minute(s)
API Name
unexpected_exits_window
Required
false
Other🔗
Knox IDBroker Diagnostics Collection Timeout🔗
Description
The timeout in milliseconds to wait for diagnostics collection to complete.
Related Name
Default Value
5 minute(s)
API Name
csd_role_diagnostics_timeout
Required
false
Knox IDBroker AWS Credentials Key🔗
Description
The AWS credentials key
Related Name
idbroker_aws_credentials_key
Default Value
API Name
idbroker_aws_credentials_key
Required
false
Knox IDBroker AWS Credentials Secret🔗
Description
The AWS credentials secret
Related Name
idbroker_aws_credentials_secret
Default Value
API Name
idbroker_aws_credentials_secret
Required
false
Knox IDBroker AWS Group Mapping🔗
Description
The list of AWS group-role mappings in 'group=role[;group=role]...[;group=role]' format. A 'group=role' declaration indicates that all authenticated users that are member of the specified group should be able to assume the specified role. For instance: admin=arn:aws:iam:XYZ:role/s3full;audit=arn:aws:iam:XYZ:role/s3Read
Related Name
idbroker.aws.group.role.mapping
Default Value
API Name
idbroker_aws_group_mapping
Required
false
Knox IDBroker AWS User Mapping🔗
Description
The list of AWS user-role mappings in 'user=role[;user=role]...[;user=role]' format. A 'user=role' declaration indicates that this is a mapping of the authenticated user’s primary principal to the specified role. For instance: admin=arn:aws:iam:XYZ:role/s3full;guest=arn:aws:iam:XYZ:role/s3Read
Related Name
idbroker.aws.user.role.mapping
Default Value
API Name
idbroker_aws_user_mapping
Required
false
Knox IDBroker AZURE ADLS2 Tenant Name🔗
Description
The name of the AZURE AD tenant. A tenant is a representation of an organization. It's a dedicated instance of Azure AD that an organization or application developer receives when the organization or application developer creates a relationship with Microsoft
Related Name
idbroker_azure_adls2_tenant_name
Default Value
API Name
idbroker_azure_adls2_tenant_name
Required
false
Knox IDBroker AZURE 'blob-contributor' ClientID🔗
Description
The client ID credential for 'blob-contributor' role
Related Name
idbroker_azure_blob_contributor_clientid
Default Value
API Name
idbroker_azure_blob_contributor_clientid
Required
false
Knox IDBroker AZURE 'blob-contributor' Secret🔗
Description
The secret credential for 'blob-contributor' role
Related Name
idbroker_azure_blob_contributor_secret
Default Value
API Name
idbroker_azure_blob_contributor_secret
Required
false
Knox IDBroker AZURE 'blob-reader' ClientID🔗
Description
The client ID credential for 'blob-reader' role
Related Name
idbroker_azure_blob_reader_clientid
Default Value
API Name
idbroker_azure_blob_reader_clientid
Required
false
Knox IDBroker AZURE 'blob-reader' Secret🔗
Description
The secret credential for 'blob-reader' role
Related Name
idbroker_azure_blob_reader_secret
Default Value
API Name
idbroker_azure_blob_reader_secret
Required
false
Knox IDBroker AZURE Group Mapping🔗
Description
The list of AZURE group-role mappings in 'group=role[;group=role]...[;group=role]' format. A 'group=role' declaration indicates that all authenticated users that are member of the specified group should be able to assume the specified role. For instance: admin=blob-contributor
Related Name
idbroker.adls2.group.role.mapping
Default Value
API Name
idbroker_azure_group_mapping
Required
false
Knox IDBroker AZURE User Mapping🔗
Description
The list of AZURE user-role mappings in 'user=role[;user=role]...[;user=role]' format. A 'user=role' declaration indicates that this is a mapping of the authenticated user’s primary principal to the specified role. For instance: admin=blob-contributor
Related Name
idbroker.adls2.user.role.mapping
Default Value
API Name
idbroker_azure_user_mapping
Required
false
Knox IDBroker AZURE VM Assumer Identity🔗
Description
A user assigned managed identity that has Virtual Machine Contributor and Managed Identity Operator roles scoped at the resource group where IDBroker Virtual Machine is running.
Related Name
idbroker_azure_vm_assumer_identity
Default Value
API Name
idbroker_azure_vm_assumer_identity
Required
false
Knox IDBroker Configuration Directory🔗
Description
Contains configuration files that apply to the gateway globally (i.e. not cluster specific ).
Related Name
idbroker_conf_dir
Default Value
/var/lib/knox/idbroker/conf
API Name
idbroker_conf_dir
Required
false
Knox IDBroker Data Directory🔗
Description
Contains security and topology specific artifacts as well as important applications for admin-ui
Related Name
idbroker_data_dir
Default Value
/var/lib/knox/idbroker/data
API Name
idbroker_data_dir
Required
false
Gateway Config Directory🔗
Description
The directory within 'idbroker_data_dir' that contains gateway topology files and deployments.
Related Name
gateway.gateway.conf.dir
Default Value
deployments
API Name
idbroker_gateway_gateway_conf_dir
Required
false
Admin Groups🔗
Description
Admin groups for Knox
Related Name
gateway.knox.admin.groups
Default Value
admin
API Name
idbroker_gateway_knox_admin_groups
Required
false
Gateway Path🔗
Description
The default context path for the gateway.
Related Name
gateway.path
Default Value
gateway
API Name
idbroker_gateway_path
Required
true
Cookie Scoping Enabled🔗
Description
Enable/Disable cookie scoping feature.
Related Name
gateway.scope.cookies.feature.enabled
Default Value
false
API Name
idbroker_gateway_scope_cookies_feature_enabled
Required
false
Security - Signing Key Alias🔗
Description
The alias for the signing keypair within the keystore specified via idbroker_gateway_signing_keystore_name
Related Name
gateway.signing.key.alias
Default Value
API Name
idbroker_gateway_signing_key_alias
Required
false
Security - Signing Keystore Name🔗
Description
The filename of keystore file that contains the signing keypair
Related Name
gateway.signing.keystore.name
Default Value
API Name
idbroker_gateway_signing_keystore_name
Required
false
Security - Signing Keystore Type🔗
Description
The type of the keystore file where the signing keypair is stored. See idbroker_gateway_signing_keystore_name
Related Name
gateway.signing.keystore.type
Default Value
API Name
idbroker_gateway_signing_keystore_type
Required
false
Knox IDBroker GCP Credential Key🔗
Description
The GCP Credential Key
Related Name
idbroker_gcp_credential_key
Default Value
API Name
idbroker_gcp_credential_key
Required
false
Knox IDBroker GCP Credential Secret🔗
Description
The GCP Credential Secret
Related Name
idbroker_gcp_credential_secret
Default Value
API Name
idbroker_gcp_credential_secret
Required
false
Knox IDBroker GCP Group Mapping🔗
Description
The list of GCP group-role mappings in 'group=role[;group=role]...[;group=role]' format. A 'group=role' declaration indicates that all authenticated users that are member of the specified group should be able to assume the specified role. For instance: admin=storage-admin@XYZ.iam.gserviceaccount.com;audit=storage-read-only@XYZ.iam.gserviceaccount.com
Related Name
idbroker.gcp.group.role.mapping
Default Value
API Name
idbroker_gcp_group_mapping
Required
false
Knox IDBroker GCP User Mapping🔗
Description
The list of GCP user-role mappings in 'user=role[;user=role]...[;user=role]' format. A 'user=role' declaration indicates that this is a mapping of the authenticated user’s primary principal to the specified role. For instance: admin=storage-admin@XYZ.iam.gserviceaccount.com;guest=storage-read-only@XYZ.iam.gserviceaccount.com
Related Name
idbroker.gcp.user.role.mapping
Default Value
API Name
idbroker_gcp_user_mapping
Required
false
Admin Group Mapping - Class Name🔗
Description
The class name used for Hadoop admin group mapping
Initial/Maximum size for the Java Process heap. Passed to Java -Xmx/-Xms. Measured in megabytes.
Related Name
idbroker_heap_size
Default Value
1 GiB
API Name
idbroker_heap_size
Required
true
Additional IDBroker Java Options🔗
Description
These arguments are passed as part of the Java command line. Commonly, garbage collection flags or extra debugging flags are passed here. -Xmx/-Xms should not be specified here: to set the heapsize use the 'Knox Gateway Initial/Max Heapsize' parameter
Related Name
idbroker_java_opts
Default Value
API Name
idbroker_java_opts
Required
false
krb5.conf Location🔗
Description
Absolute path to krb5.conf file
Related Name
java.security.krb5.conf
Default Value
/etc/krb5.conf
API Name
idbroker_java_security_krb5_conf
Required
false
Kerberos Proxyuser Block🔗
Description
Proxyuser configuration used in Knox's 'dt' topology in case Kerberos is enabled. Must conform a valid JSON key-value format!
This indicates the lifespan of the token. Once it expires a new token must be acquired from KnoxToken service. This is in milliseconds.
Related Name
idbroker_knox_token_ttl_ms
Default Value
7 day(s)
API Name
idbroker_knox_token_ttl_ms
Required
false
Knox IDBroker Log Directory🔗
Description
The folder where Knox IDBroker puts it's logs
Related Name
idbroker_log_dir
Default Value
/var/log/knox/idbroker
API Name
idbroker_log_dir
Required
false
IDBroker Log Level🔗
Description
The logging level of IDBroker
Related Name
idbroker_log_level
Default Value
ERROR
API Name
idbroker_log_level
Required
false
IDBroker Master Secret🔗
Description
The master secret is used to access secured artifacts by the gateway instance. Keystore, trust stores and credential stores are all protected with the master secret. NOTE: changing the master secret will require you to change passwords protecting the keystores for the gateway, identity keystores and all credential stores
Related Name
idbroker_master_secret
Default Value
API Name
idbroker_master_secret
Required
true
Gateway Config Refresh Interval🔗
Description
Defines the frequency of gateway configuration refresh.
Related Name
gateway.config.refresh.interval
Default Value
10 second(s)
API Name
idbroker_relaodable_refresh_interval_ms
Required
false
KRB5 Debug🔗
Description
Boolean flag indicating whether to enable debug messages for krb5 authentication
Related Name
sun.security.krb5.debug
Default Value
false
API Name
idbroker_sun_security_krb5_debug
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🔗
Gateway HTTP Port🔗
Description
The HTTP port for the Gateway.
Related Name
gateway.port
Default Value
8444
API Name
idbroker_gateway_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🔗
Knox IDBroker 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 Knox IDBroker 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
gateway.httpclient.truststore.path
Default Value
API Name
ssl_client_truststore_location
Required
false
Knox IDBroker TLS/SSL Trust Store Password🔗
Description
The password for the Knox IDBroker 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
Default Value
API Name
ssl_client_truststore_password
Required
false
Enable TLS/SSL for Knox IDBroker🔗
Description
Encrypt communication between clients and Knox IDBroker using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name
knox.enableTLS
Default Value
false
API Name
ssl_enabled
Required
false
Knox IDBroker 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 Knox IDBroker is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name
gateway.tls.keystore.path
Default Value
API Name
ssl_server_keystore_location
Required
false
Knox IDBroker TLS/SSL Server Keystore File Password🔗
Description
The password for the Knox IDBroker keystore file.
Related Name
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 Configuration Validator: CDH Version Validator🔗
Description
Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker Advanced Configuration Snippet (Safety Valve) for conf/gateway-reloadable.xml parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker Advanced Configuration Snippet (Safety Valve) for conf/gateway-site.xml parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AZURE 'blob-contributor' ClientID parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AZURE 'blob-contributor' Secret parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker Environment Advanced Configuration Snippet (Safety Valve) parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker Logging Advanced Configuration Snippet (Safety Valve) parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_oom_heap_dump_dir
Required
true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_rm_custom_resources
Required
true
Suppress Parameter Validation: Role Triggers🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value
false
API Name
role_config_suppression_role_triggers
Required
true
Suppress Parameter Validation: Knox IDBroker TLS/SSL Trust Store File🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker TLS/SSL Trust Store File parameter.
Suppress Parameter Validation: Knox IDBroker TLS/SSL Server Keystore File Location🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker TLS/SSL Server Keystore File Location parameter.
Suppress Parameter Validation: Knox IDBroker TLS/SSL Server Keystore File Password🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker TLS/SSL Server Keystore File Password parameter.
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.
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.
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_knox_idbroker_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.
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_knox_idbroker_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.
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.
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.
Knox Service Advanced Configuration Snippet (Safety Valve) for conf/gateway-site.xml🔗
Description
For advanced use only, a string to be inserted into conf/gateway-site.xml. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name
conf/gateway-site.xml_service_safety_valve
Required
false
Knox 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
KNOX_service_env_safety_valve
Required
false
System Group🔗
Description
The group that this service's processes should run as.
Related Name
Default Value
knox
API Name
process_groupname
Required
true
System User🔗
Description
The user that this service's processes should run as.
Related Name
Default Value
knox
API Name
process_username
Required
true
Monitoring🔗
Enable Service Level Health Alerts🔗
Description
When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
Related Name
Default Value
true
API Name
enable_alerts
Required
false
Enable Configuration Change Alerts🔗
Description
When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value
false
API Name
enable_config_alerts
Required
false
Healthy Knox IDBroker Monitoring Thresholds🔗
Description
The health test thresholds of the overall Knox IDBroker health. The check returns "Concerning" health if the percentage of "Healthy" Knox IDBrokers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Knox IDBrokers falls below the critical threshold.
Related Name
Default Value
Warning: 99.0 %, Critical: 49.0 %
API Name
KNOX_IDBROKER_healthy_thresholds
Required
false
Healthy Knox Gateway Monitoring Thresholds🔗
Description
The health test thresholds of the overall Knox Gateway health. The check returns "Concerning" health if the percentage of "Healthy" Knox Gateways falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Knox Gateways falls below the critical threshold.
Related Name
Default Value
Warning: 99.0 %, Critical: 49.0 %
API Name
KNOX_KNOX_GATEWAY_healthy_thresholds
Required
false
Service Triggers🔗
Description
The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
triggerName(mandatory) - The name of the trigger. This value must be unique for the specific service.
triggerExpression(mandatory) - A tsquery expression representing the trigger.
streamThreshold(optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger fires if there are more than 10 DataNodes with more than 500 file descriptors opened:[{"triggerName": "sample-trigger",
"triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad",
"streamThreshold": 10, "enabled": "true"}]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
Other🔗
Automatic Restart on Stop🔗
Description
Automatically restart the service when a stop is issued.
Related Name
autorestart_on_stop
Default Value
false
API Name
autorestart_on_stop
Required
false
HDFS Service🔗
Description
Name of the HDFS service that this Knox service instance depends on
Related Name
Default Value
API Name
hdfs_service
Required
false
Enable Kerberos Authentication🔗
Description
Boolean flag indicating whether the Hadoop cluster protected by Gateway is secured with Kerberos
Related Name
gateway.hadoop.kerberos.secured
Default Value
false
API Name
kerberos.auth.enabled
Required
false
Ranger Knox Plugin Hdfs Audit Directory🔗
Description
The HDFS path on which Ranger audits are written.
Related Name
ranger_knox_plugin_hdfs_audit_directory
Default Value
$ranger_base_audit_url/knox
API Name
ranger_knox_plugin_hdfs_audit_directory
Required
false
RANGER Service🔗
Description
Name of the RANGER service that this Knox service instance depends on
Related Name
Default Value
API Name
ranger_service
Required
false
Security🔗
Kerberos Principal🔗
Description
Kerberos principal short name used by all roles of this service.
Related Name
Default Value
knox
API Name
kerberos_princ_name
Required
true
Suppressions🔗
Suppress Configuration Validator: CDH Version Validator🔗
Description
Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Whether to suppress configuration warnings produced by the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/auto-discovery-advanced-configuration-cdp-proxy-api.properties configuration validator.
Whether to suppress configuration warnings produced by the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/auto-discovery-advanced-configuration-cdp-proxy.properties configuration validator.
Whether to suppress configuration warnings produced by the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/cdp-descriptors.xml configuration validator.
Whether to suppress configuration warnings produced by the Knox IDBroker Advanced Configuration Snippet (Safety Valve) for conf/gateway-reloadable.xml configuration validator.
Whether to suppress configuration warnings produced by the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/gateway-site.xml configuration validator.
Whether to suppress configuration warnings produced by the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-audit.xml configuration validator.
Whether to suppress configuration warnings produced by the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-policymgr-ssl.xml configuration validator.
Whether to suppress configuration warnings produced by the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-security.xml configuration validator.
Whether to suppress configuration warnings produced by the Knox IDBroker Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Whether to suppress configuration warnings produced by the Knox Gateway Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Suppress Parameter Validation: Knox Service Advanced Configuration Snippet (Safety Valve) for conf/gateway-site.xml🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Service Advanced Configuration Snippet (Safety Valve) for conf/gateway-site.xml parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Service Environment Advanced Configuration Snippet (Safety Valve) parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter.
Whether to suppress the results of the Knox IDBroker 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_knox_idbroker_healthy
Required
true
Suppress Health Test: Knox Gateway Health🔗
Description
Whether to suppress the results of the Knox Gateway 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.
