ReferencePDF version

Knox Properties in Cloudera Runtime 7.2.1

Role groups:

Categories:

Display Name Description Related Name Default Value API Name Required
Deploy Directory The directory where the client configs will be deployed /etc/knox client_config_root_dir true
Display Name Description Related Name Default Value API Name Required
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Display Name Description Related Name Default Value API Name Required
Alternatives Priority 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. 50 client_config_priority true
Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Deploy Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Deploy Directory parameter. false role_config_suppression_client_config_root_dir true

Categories:

Display Name Description Related Name Default Value API Name Required
Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/auto-discovery-advanced-configuration-cdp-proxy-api.properties For advanced use only. A string to be inserted into conf/auto-discovery-advanced-configuration-cdp-proxy-api.properties for this role only. conf/auto-discovery-advanced-configuration-cdp-proxy-api.properties_role_safety_valve false
Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/auto-discovery-advanced-configuration-cdp-proxy.properties For advanced use only. A string to be inserted into conf/auto-discovery-advanced-configuration-cdp-proxy.properties for this role only. conf/auto-discovery-advanced-configuration-cdp-proxy.properties_role_safety_valve false
Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/cdp-resources.xml For advanced use only. A string to be inserted into conf/cdp-resources.xml for this role only. conf/cdp-resources.xml_role_safety_valve false
Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/gateway-site.xml For advanced use only. A string to be inserted into conf/gateway-site.xml for this role only. conf/gateway-site.xml_role_safety_valve false
Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-audit.xml For advanced use only. A string to be inserted into conf/ranger-knox-audit.xml for this role only. conf/ranger-knox-audit.xml_role_safety_valve false
Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-policymgr-ssl.xml For advanced use only. A string to be inserted into conf/ranger-knox-policymgr-ssl.xml for this role only. conf/ranger-knox-policymgr-ssl.xml_role_safety_valve false
Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-security.xml For advanced use only. A string to be inserted into conf/ranger-knox-security.xml for this role only. conf/ranger-knox-security.xml_role_safety_valve false
Knox Gateway Environment Advanced Configuration Snippet (Safety Valve) 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. KNOX_GATEWAY_role_env_safety_valve false
Knox Gateway Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Heap Dump Directory 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, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. 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. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
Automatically Restart Process 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. false process_auto_restart true
Enable Metric Collection 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. true process_should_monitor true
Process Start Retry Attempts 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. 3 process_start_retries false
Process Start Wait Timeout 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. 20 process_start_secs false
Display Name Description Related Name Default Value API Name Required
Knox Gateway Log Directory The log directory for log files of the role Knox Gateway. log_dir /var/log/knox/gateway log_dir false
Knox Gateway Logging Threshold The minimum log level for Knox Gateway logs INFO log_threshold false
Knox Gateway Maximum Log File Backups The maximum number of rolled log files to keep for Knox Gateway logs. Typically used by log4j or logback. 10 max_log_backup_index false
Knox Gateway Max Log Size The maximum size, in megabytes, per log file for Knox Gateway logs. Typically used by log4j or logback. 200 MiB max_log_size false
Display Name Description Related Name Default Value API Name Required
Enable Health Alerts for this Role 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 true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % knox_gateway_fd_thresholds false
Knox Gateway Host Health Test When computing the overall Knox Gateway health, consider the host's health. true knox_gateway_host_health_enabled false
Knox Gateway Process Health Test Enables the health test that the Knox Gateway's process state is consistent with the role configuration true knox_gateway_scm_health_enabled false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds 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. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Metric Filter 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"] }		 monitoring_metric_filter false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
Role Triggers 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.		 [] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false
Display Name Description Related Name Default Value API Name Required
Knox Gateway Diagnostics Collection Timeout The timeout in milliseconds to wait for diagnostics collection to complete. 5 minute(s) csd_role_diagnostics_timeout false
Knox Simplified Topology Management - API Authentication Provider Authentication provider declaration used by pre-deinfed topologies such as admin, metadata or cdp-proxy-api. gateway_api_authentication_provider role=authentication authentication.name=ShiroProvider authentication.param.sessionTimeout=30 authentication.param.main.pamRealm=org.apache.knox.gateway.shirorealm.KnoxPamRealm authentication.param.main.pamRealm.service=login authentication.param.urls./**=authcBasic gateway_api_authentication_provider false
Auto Discovery - Advanced Configuration Monitoring Interval Defines the frequency of Knox's service auto-discovery advanced configuration files (auto-discovery-advanced-configuration-[cdp-proxy|cdp-proxy-api].properties) monitoring. gateway.cloudera.manager.advanced.service.discovery.config.monitor.interval 10 second(s) gateway_auto_discovery_advanced_configuration_monitor_interval false
Enable Auto Discovery (cdp-proxy-api) - Atlas API Enables Knox auto-discovery for the Atlas API in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.atlas-api true gateway_auto_discovery_cdp_proxy_api_enabled_atlas false
Enable Auto Discovery (cdp-proxy-api) - Phoenix/Avatica Enables Knox auto-discovery for the Phoenix/Avatica API in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.avatica true gateway_auto_discovery_cdp_proxy_api_enabled_avatica false
Enable Auto Discovery (cdp-proxy-api) - Cloudera Manager API Enables Knox auto-discovery for the Cloudera Manager API in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.cm-api true gateway_auto_discovery_cdp_proxy_api_enabled_cm_api false
Enable Auto Discovery (cdp-proxy-api) - Cruise Control API Enables Knox auto-discovery for the Cruise Control API in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.cruise-control-api true gateway_auto_discovery_cdp_proxy_api_enabled_cruise_control false
Enable Auto Discovery (cdp-proxy-api) - Hive Server Enables Knox auto-discovery for the Hive Server in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.hive true gateway_auto_discovery_cdp_proxy_api_enabled_hive false
Enable Auto Discovery (cdp-proxy-api) - Impala Catalog Server Enables Knox auto-discovery for the Impala Catalog Server in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.impala true gateway_auto_discovery_cdp_proxy_api_enabled_impala false
Enable Auto Discovery (cdp-proxy-api) - Livy Server API Enables Knox auto-discovery for the Livy Server API in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.livyserver true gateway_auto_discovery_cdp_proxy_api_enabled_livyserver false
Enable Auto Discovery (cdp-proxy-api) - NameNode Enables Knox auto-discovery for the NameNode in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.namenode true gateway_auto_discovery_cdp_proxy_api_enabled_namenode false
Enable Auto Discovery (cdp-proxy-api) - NiFi Enables Knox auto-discovery for the NiFi in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.nifi true gateway_auto_discovery_cdp_proxy_api_enabled_nifi false
Enable Auto Discovery (cdp-proxy-api) - NiFi Registry Enables Knox auto-discovery for the NiFi Registry in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.nifi-registry true gateway_auto_discovery_cdp_proxy_api_enabled_nifi_registry false
Enable Auto Discovery (cdp-proxy-api) - Oozie Server Enables Knox auto-discovery for the Oozie Server in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.oozie true gateway_auto_discovery_cdp_proxy_api_enabled_oozie false
Enable Auto Discovery (cdp-proxy-api) - Profiler Admin API Enables Knox auto-discovery for the Profiler Admin API in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.profiler-admin-api true gateway_auto_discovery_cdp_proxy_api_enabled_profiler_admin_api false
Enable Auto Discovery (cdp-proxy-api) - Profiler Metrics API Enables Knox auto-discovery for the Profiler Metrics API in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.profiler-metrics-api true gateway_auto_discovery_cdp_proxy_api_enabled_profiler_metrics_api false
Enable Auto Discovery (cdp-proxy-api) - Profiler Scheduler API Enables Knox auto-discovery for the Profiler Scheduler API in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.profiler-scheduler-api true gateway_auto_discovery_cdp_proxy_api_enabled_profiler_scheduler_api false
Enable Auto Discovery (cdp-proxy-api) - Ranger Admin Enables Knox auto-discovery for the Ranger Admin in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.ranger true gateway_auto_discovery_cdp_proxy_api_enabled_ranger false
Enable Auto Discovery (cdp-proxy-api) - ResourceManager Enables Knox auto-discovery for the ResourceManager in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.resourcemanager true gateway_auto_discovery_cdp_proxy_api_enabled_resourcemanager false
Enable Auto Discovery (cdp-proxy-api) - Schema Registry API Enables Knox auto-discovery for the Schema Registry API in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.schema-registry true gateway_auto_discovery_cdp_proxy_api_enabled_schema_registry false
Enable Auto Discovery (cdp-proxy-api) - Stream Messaging Manager API Enables Knox auto-discovery for the Stream Messaging Manager API in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.smm-api true gateway_auto_discovery_cdp_proxy_api_enabled_smm false
Enable Auto Discovery (cdp-proxy-api) - Solr Server Enables Knox auto-discovery for the Solr Server in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.solr true gateway_auto_discovery_cdp_proxy_api_enabled_solr false
Enable Auto Discovery (cdp-proxy-api) - HBase Master API Enables Knox auto-discovery for the HBase Master API in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.webhbase true gateway_auto_discovery_cdp_proxy_api_enabled_webhbase false
Enable Auto Discovery (cdp-proxy-api) - WebHDFS API Enables Knox auto-discovery for the WebHDFS API in the cdp-proxy-api topology. gateway.auto.discovery.cdp-proxy-api.enabled.webhdfs true gateway_auto_discovery_cdp_proxy_api_enabled_webhdfs false
Enable Auto Discovery (cdp-proxy) - Atlas API Enables Knox auto-discovery for the Atlas API in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.atlas-api true gateway_auto_discovery_cdp_proxy_enabled_atlas false
Enable Auto Discovery (cdp-proxy) - Atlas Web UI Enables Knox auto-discovery for the Atlas Web UI in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.atlas true gateway_auto_discovery_cdp_proxy_enabled_atlas_ui false
Enable Auto Discovery (cdp-proxy) - Cloudera Manager API Enables Knox auto-discovery for the Cloudera Manager API in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.cm-api true gateway_auto_discovery_cdp_proxy_enabled_cm_api false
Enable Auto Discovery (cdp-proxy) - Cloudera Manager Admin Console Enables Knox auto-discovery for the Cloudera Manager Admin Console in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.cm-ui true gateway_auto_discovery_cdp_proxy_enabled_cm_ui false
Enable Auto Discovery (cdp-proxy) - Data Analytics Studio Enables Knox auto-discovery for the Data Analytics Studio in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.das true gateway_auto_discovery_cdp_proxy_enabled_das false
Enable Auto Discovery (cdp-proxy) - HBase Web UI Enables Knox auto-discovery for the HBase Web UI in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.hbaseui true gateway_auto_discovery_cdp_proxy_enabled_hbase_ui false
Enable Auto Discovery (cdp-proxy) - Namenode Web UI Enables Knox auto-discovery for the Namenode Web UI in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.hdfsui true gateway_auto_discovery_cdp_proxy_enabled_hdfs_ui false
Enable Auto Discovery (cdp-proxy) - Hue Server Enables Knox auto-discovery for the Hue Server in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.hue true gateway_auto_discovery_cdp_proxy_enabled_hue false
Enable Auto Discovery (cdp-proxy) - Impala Catalog Server Web UI Enables Knox auto-discovery for the Impala Catalog Server Web UI in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.impalaui true gateway_auto_discovery_cdp_proxy_enabled_impala_ui false
Enable Auto Discovery (cdp-proxy) - HistoryServer Web UI Enables Knox auto-discovery for the HistoryServer Web UI in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.jobhistoryui true gateway_auto_discovery_cdp_proxy_enabled_jobhistory_ui false
Enable Auto Discovery (cdp-proxy) - Kudu Master Web UI Enables Knox auto-discovery for the Kudu Master Web UI in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.kuduui true gateway_auto_discovery_cdp_proxy_enabled_kudu_ui false
Enable Auto Discovery (cdp-proxy) - Livy Server Web UI Enables Knox auto-discovery for the Livy Server Web UI in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.livyserver true gateway_auto_discovery_cdp_proxy_enabled_livyserver false
Enable Auto Discovery (cdp-proxy) - NameNode Enables Knox auto-discovery for the NameNode in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.namenode true gateway_auto_discovery_cdp_proxy_enabled_namenode false
Enable Auto Discovery (cdp-proxy) - NiFi Enables Knox auto-discovery for the NiFi in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.nifi true gateway_auto_discovery_cdp_proxy_enabled_nifi false
Enable Auto Discovery (cdp-proxy) - NiFi Registry Enables Knox auto-discovery for the NiFi Registry in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.nifi-registry true gateway_auto_discovery_cdp_proxy_enabled_nifi_registry false
Enable Auto Discovery (cdp-proxy) - Oozie Server Enables Knox auto-discovery for the Oozie Server in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.oozie true gateway_auto_discovery_cdp_proxy_enabled_oozie false
Enable Auto Discovery (cdp-proxy) - Oozie Web UI Enables Knox auto-discovery for the Oozie Web UI in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.oozieui true gateway_auto_discovery_cdp_proxy_enabled_oozie_ui false
Enable Auto Discovery (cdp-proxy) - Ranger Admin Enables Knox auto-discovery for the Ranger Admin in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.ranger true gateway_auto_discovery_cdp_proxy_enabled_ranger false
Enable Auto Discovery (cdp-proxy) - Ranger Admin Web UI Enables Knox auto-discovery for the Ranger Admin Web UI in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.rangerui true gateway_auto_discovery_cdp_proxy_enabled_ranger_ui false
Enable Auto Discovery (cdp-proxy) - ResourceManager Enables Knox auto-discovery for the ResourceManager in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.resourcemanager true gateway_auto_discovery_cdp_proxy_enabled_resourcemanager false
Enable Auto Discovery (cdp-proxy) - Stream Messaging Manager API Enables Knox auto-discovery for the Stream Messaging Manager API in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.smm-api true gateway_auto_discovery_cdp_proxy_enabled_smm false
Enable Auto Discovery (cdp-proxy) - Stream Messaging Manager Web UI Enables Knox auto-discovery for the Stream Messaging Manager Web UI in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.smm-ui true gateway_auto_discovery_cdp_proxy_enabled_smm_ui false
Enable Auto Discovery (cdp-proxy) - Solr Server Enables Knox auto-discovery for the Solr Server in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.solr true gateway_auto_discovery_cdp_proxy_enabled_solr false
Enable Auto Discovery (cdp-proxy) - Spark 3 History Server Web UI Enables Knox auto-discovery for the Spark 3 History Server Web UI in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.spark3historyui true gateway_auto_discovery_cdp_proxy_enabled_spark3history_ui false
Enable Auto Discovery (cdp-proxy) - Spark History Server Web UI Enables Knox auto-discovery for the Spark History Server Web UI in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.sparkhistoryui true gateway_auto_discovery_cdp_proxy_enabled_sparkhistory_ui false
Enable Auto Discovery (cdp-proxy) - ResourceManager Web UI Enables Knox auto-discovery for the ResourceManager Web UI in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.yarnui true gateway_auto_discovery_cdp_proxy_enabled_yarn_ui false
Enable Auto Discovery (cdp-proxy) - ResourceManager Web UI V2 Enables Knox auto-discovery for the ResourceManager Web UI V2 in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.yarnuiv2 true gateway_auto_discovery_cdp_proxy_enabled_yarn_ui_v2 false
Enable Auto Discovery (cdp-proxy) - Zeppelin Server Web UI Enables Knox auto-discovery for the Zeppelin Server Web UI in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.zeppelinui true gateway_auto_discovery_cdp_proxy_enabled_zeppelin_ui false
Enable Auto Discovery (cdp-proxy) - Zeppelin Server Enables Knox auto-discovery for the Zeppelin Server in the cdp-proxy topology. gateway.auto.discovery.cdp-proxy.enabled.zeppelinws true gateway_auto_discovery_cdp_proxy_enabled_zeppelin_ws false
Enable/Disable Service Auto-Discovery Whether Knox's service auto-discovery feature is enabled gateway.auto.discovery.enabled true gateway_auto_discovery_enabled false
Knox Simplified Topology Management - Monitoring Interval Defines the frequency of Cloudera Manager resources (descriptors and shared providers) file (cdp-resources.xml) monitoring. gateway.cloudera.manager.descriptors.monitor.interval 10 second(s) gateway_cloudera_manager_descriptors_monitor_interval false
Auto Discovery - Cluster Configuration Monitoring Interval Defines the frequency of cluster configuration monitoring. gateway.cluster.config.monitor.cm.interval 1 minute(s) gateway_cluster_configuration_monitor_interval false
Knox Gateway Configuration Directory Contains configuration files that apply to the gateway globally (i.e. not cluster specific ). gateway_conf_dir /var/lib/knox/gateway/conf gateway_conf_dir false
Knox Gateway Data Directory Contains security and topology specific artifacts as well as important applications for admin-ui gateway_data_dir /var/lib/knox/gateway/data gateway_data_dir false
Gateway - Default App Topology Name 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. default.app.topology.name cdp-proxy gateway_default_topology_name false
Knox Simplified Topology Management - cdp-proxy 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 cdp-proxy providerConfigRef=sso CM-API:httpclient.connectionTimeout=5m CM-API:httpclient.socketTimeout=5m HUE:httpclient.connectionTimeout=5m HUE:httpclient.socketTimeout=5m IMPALA:httpclient.connectionTimeout=5m IMPALA:httpclient.socketTimeout=5m NIFI:useTwoWaySsl=true NIFI-REGISTRY:useTwoWaySsl=true RANGER:replayBufferSize=65 gateway_descriptor_cdp_proxy false
Knox Simplified Topology Management - cdp-proxy-api 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 cdp-proxy-api providerConfigRef=pam CM-API:httpclient.connectionTimeout=5m CM-API:httpclient.socketTimeout=5m HIVE:httpclient.connectionTimeout=5m HIVE:httpclient.socketTimeout=5m IMPALA:httpclient.connectionTimeout=5m IMPALA:httpclient.socketTimeout=5m NIFI:useTwoWaySsl=true NIFI-REGISTRY:useTwoWaySsl=true RANGER:replayBufferSize=65 gateway_descriptor_cdp_proxy_api false
Knox Gateway Dispatch Whitelist 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. gateway.dispatch.whitelist WHITELIST_CONFIG_REPLACEME gateway_dispatch_whitelist false
Knox Gateway Dispatch Whitelist Services The comma-delimited list of service roles for which the 'gateway.dispatch.whitelist' should be applied gateway.dispatch.whitelist.services DATANODE, HBASEUI, HDFSUI, IMPALAUI, JOBHISTORYUI, KUDUUI, NODEUI, YARNUI, YARNUIV2, knoxauth gateway_dispatch_whitelist_services false
Gateway Config Directory The directory within 'gateway_data_dir' that contains gateway topology files and deployments. gateway.gateway.conf.dir deployments gateway_gateway_conf_dir false
Knox Gateway Initial/Max Heapsize Initial/Maximum size for the Java Process heap. Passed to Java -Xmx/-Xms. Measured in megabytes. gateway_heap_size 1 GiB gateway_heap_size true
Additional Gateway Java Options 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 gateway_java_opts gateway_java_opts false
Admin Groups Admin groups for Knox gateway.knox.admin.groups gateway_knox_admin_groups false
Knox Gateway Log Level The logging level of Knox Gateway gateway_log_level ERROR gateway_log_level false
Knox Master Secret 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 gateway_master_secret gateway_master_secret true
Gateway Path The default context path for the gateway. gateway.path gateway gateway_path true
Ranger Knox Plugin Conf Path Staging directory for Ranger Knox Plugin Configuration. This should generally not be changed. gateway_ranger_knox_plugin_conf_path /var/lib/knox/ranger-knox-plugin gateway_ranger_knox_plugin_conf_path true
Ranger Knox Plugin Audit Hdfs Spool Directory Path Spool directory for Ranger audits being written to DFS. xasecure.audit.destination.hdfs.batch.filespool.dir /var/log/knox/gateway/audit/hdfs/spool gateway_ranger_knox_plugin_hdfs_audit_spool_directory true
Ranger Knox Plugin Policy Cache Directory Path The directory where Ranger security policies are cached locally. ranger.plugin.knox.policy.cache.dir /var/lib/ranger/knox/gateway/policy-cache gateway_ranger_knox_plugin_policy_cache_directory true
Ranger Knox Plugin Audit Solr Spool Directory Path Spool directory for Ranger audits being written to Solr. xasecure.audit.destination.solr.batch.filespool.dir /var/log/knox/gateway/audit/solr/spool gateway_ranger_knox_plugin_solr_audit_spool_directory true
Ranger Plugin Trusted Proxy IP Address Accepts a list of IP addresses of proxy servers for trusting. ranger.plugin.knox.trusted.proxy.ipaddress gateway_ranger_plugin_trusted_proxy_ipaddress false
Ranger Plugin Use X-Forwarded For IP Address The parameter is used for identifying the originating IP address of a user connecting to a component through proxy for audit logs. ranger.plugin.knox.use.x-forwarded-for.ipaddress false gateway_ranger_plugin_use_x_forwarded_for_ipaddress false
Cookie Scoping Enabled Enable/Disable cookie scoping feature. gateway.scope.cookies.feature.enabled false gateway_scope_cookies_feature_enabled false
Security - Signing Key Alias The alias for the signing keypair within the keystore specified via gateway_signing_keystore_name gateway.signing.key.alias gateway_signing_key_alias false
Security - Signing Keystore Name The filename of keystore file that contains the signing keypair gateway.signing.keystore.name gateway_signing_keystore_name false
Security - Signing Keystore Type The type of the keystore file where the signing keypair is stored. See gateway_signing_keystore_name gateway.signing.keystore.type gateway_signing_keystore_type false
Knox Simplified Topology Management - SSO Authentication Provider Authentication provider declaration used by the UIs using the Knox SSO capabilities such as the Admin and Home Page UIs. gateway_sso_authentication_provider role=authentication authentication.name=ShiroProvider authentication.param.sessionTimeout=30 authentication.param.redirectToUrl=/$GATEWAY_PATH/knoxsso/knoxauth/login.html authentication.param.restrictedCookies=rememberme, WWW-Authenticate authentication.param.main.pamRealm=org.apache.knox.gateway.shirorealm.KnoxPamRealm authentication.param.main.pamRealm.service=login authentication.param.urls./**=authcBasic gateway_sso_authentication_provider false
Security - TLS Certificate Alias (Optional) The alias for the Gateway’s TLS certificate and keypair within the default keystore or the keystore specified via gateway.tls.keystore.path gateway_tls_certificate_alias gateway_tls_certificate_alias false
Security - TLS Certificate Path (Optional) The path for the TLS certificate which Knox will import in the CM generated/distributed keystore in case SSL is enabled (if any). gateway_tls_certificate_path gateway_tls_certificate_path false
Websockets Enabled Enable/Disable websocket feature. gateway.websocket.feature.enabled true gateway_websocket_feature_enabled false
X-Forwarded Header Context Service Name The service name to be added in x-forward-context header. gateway.xforwarded.header.context.append.servicename LIVYSERVER gateway_xforwarded_header_context_append_servicename false
Admin Group Mapping - Class Name The class name used for Hadoop admin group mapping gateway.group.config.hadoop.security.group.mapping org.apache.hadoop.security.ShellBasedUnixGroupsMapping hadoop_security_group_mapping_class false
Hadoop Group Mapping - Negative Cache Expiration The Hadoop group mapping negative cache expiration in seconds gateway.group.config.hadoop.security.groups.negative-cache.secs 5 second(s) hadoop_security_group_negative_cache_expiration_seconds false
Hadoop Group Mapping - Positive Cache Expiration The Hadoop group mapping positive cache expiration in seconds gateway.group.config.hadoop.security.groups.cache.secs 10 second(s) hadoop_security_group_positive_cache_expiration_seconds false
krb5.conf Location Absolute path to krb5.conf file java.security.krb5.conf /etc/krb5.conf java_security_krb5_conf false
KRB5 Debug Boolean flag indicating whether to enable debug messages for krb5 authentication sun.security.krb5.debug false sun_security_krb5_debug false
Display Name Description Related Name Default Value API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false
Display Name Description Related Name Default Value API Name Required
Gateway HTTP Port The HTTP port for the Gateway. gateway.port 8443 gateway_port true
Display Name Description Related Name Default Value API Name Required
Cgroup CPU Shares 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. cpu.shares 1024 rm_cpu_shares true
Custom Control Group Resources (overrides Cgroup settings) 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.*** custom.cgroups rm_custom_resources false
Cgroup I/O Weight 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. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit 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' memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit 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' memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true
Display Name Description Related Name Default Value API Name Required
Knox Gateway TLS/SSL Client Trust Store File 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 is used when Knox Gateway is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead. gateway.httpclient.truststore.path ssl_client_truststore_location false
Knox Gateway TLS/SSL Client Trust Store Password The password for the Knox Gateway TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. ssl_client_truststore_password false
Enable TLS/SSL for Knox Gateway Encrypt communication between clients and Knox Gateway using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). knox.enableTLS false ssl_enabled false
Knox Gateway TLS/SSL Server JKS Keystore File Location 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 JKS format. gateway.tls.keystore.path ssl_server_keystore_location false
Knox Gateway TLS/SSL Server JKS Keystore File Password The password for the Knox Gateway JKS keystore file. ssl_server_keystore_password false
Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method 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. stacks_collection_method jstack stacks_collection_method false
Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/auto-discovery-advanced-configuration-cdp-proxy-api.properties 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. false role_config_suppression_conf/auto-discovery-advanced-configuration-cdp-proxy-api.properties_role_safety_valve true
Suppress Parameter Validation: Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/auto-discovery-advanced-configuration-cdp-proxy.properties 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. false role_config_suppression_conf/auto-discovery-advanced-configuration-cdp-proxy.properties_role_safety_valve true
Suppress Parameter Validation: Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/cdp-resources.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/cdp-resources.xml parameter. false role_config_suppression_conf/cdp-resources.xml_role_safety_valve true
Suppress Parameter Validation: Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/gateway-site.xml 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. false role_config_suppression_conf/gateway-site.xml_role_safety_valve true
Suppress Parameter Validation: Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-audit.xml 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. false role_config_suppression_conf/ranger-knox-audit.xml_role_safety_valve true
Suppress Parameter Validation: Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-policymgr-ssl.xml 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. false role_config_suppression_conf/ranger-knox-policymgr-ssl.xml_role_safety_valve true
Suppress Parameter Validation: Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-security.xml 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. false role_config_suppression_conf/ranger-knox-security.xml_role_safety_valve true
Suppress Parameter Validation: Knox Simplified Topology Management - API Authentication Provider Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Simplified Topology Management - API Authentication Provider parameter. false role_config_suppression_gateway_api_authentication_provider true
Suppress Parameter Validation: Knox Gateway Configuration Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Configuration Directory parameter. false role_config_suppression_gateway_conf_dir true
Suppress Parameter Validation: Knox Gateway Data Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Data Directory parameter. false role_config_suppression_gateway_data_dir true
Suppress Parameter Validation: Gateway - Default App Topology Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway - Default App Topology Name parameter. false role_config_suppression_gateway_default_topology_name true
Suppress Parameter Validation: Knox Simplified Topology Management - cdp-proxy Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Simplified Topology Management - cdp-proxy parameter. false role_config_suppression_gateway_descriptor_cdp_proxy true
Suppress Parameter Validation: Knox Simplified Topology Management - cdp-proxy-api Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Simplified Topology Management - cdp-proxy-api parameter. false role_config_suppression_gateway_descriptor_cdp_proxy_api true
Suppress Parameter Validation: Knox Gateway Dispatch Whitelist Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Dispatch Whitelist parameter. false role_config_suppression_gateway_dispatch_whitelist true
Suppress Parameter Validation: Knox Gateway Dispatch Whitelist Services Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Dispatch Whitelist Services parameter. false role_config_suppression_gateway_dispatch_whitelist_services true
Suppress Parameter Validation: Gateway Config Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway Config Directory parameter. false role_config_suppression_gateway_gateway_conf_dir true
Suppress Parameter Validation: Knox Gateway Initial/Max Heapsize Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Initial/Max Heapsize parameter. false role_config_suppression_gateway_heap_size true
Suppress Parameter Validation: Additional Gateway Java Options Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional Gateway Java Options parameter. false role_config_suppression_gateway_java_opts true
Suppress Parameter Validation: Admin Groups Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin Groups parameter. false role_config_suppression_gateway_knox_admin_groups true
Suppress Parameter Validation: Knox Master Secret Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Master Secret parameter. false role_config_suppression_gateway_master_secret true
Suppress Parameter Validation: Gateway Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway Path parameter. false role_config_suppression_gateway_path true
Suppress Parameter Validation: Gateway HTTP Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway HTTP Port parameter. false role_config_suppression_gateway_port true
Suppress Parameter Validation: Ranger Knox Plugin Conf Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Knox Plugin Conf Path parameter. false role_config_suppression_gateway_ranger_knox_plugin_conf_path true
Suppress Parameter Validation: Ranger Knox Plugin Audit Hdfs Spool Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Knox Plugin Audit Hdfs Spool Directory Path parameter. false role_config_suppression_gateway_ranger_knox_plugin_hdfs_audit_spool_directory true
Suppress Parameter Validation: Ranger Knox Plugin Policy Cache Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Knox Plugin Policy Cache Directory Path parameter. false role_config_suppression_gateway_ranger_knox_plugin_policy_cache_directory true
Suppress Parameter Validation: Ranger Knox Plugin Audit Solr Spool Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Knox Plugin Audit Solr Spool Directory Path parameter. false role_config_suppression_gateway_ranger_knox_plugin_solr_audit_spool_directory true
Suppress Parameter Validation: Ranger Plugin Trusted Proxy IP Address Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Plugin Trusted Proxy IP Address parameter. false role_config_suppression_gateway_ranger_plugin_trusted_proxy_ipaddress true
Suppress Parameter Validation: Security - Signing Key Alias Whether to suppress configuration warnings produced by the built-in parameter validation for the Security - Signing Key Alias parameter. false role_config_suppression_gateway_signing_key_alias true
Suppress Parameter Validation: Security - Signing Keystore Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Security - Signing Keystore Name parameter. false role_config_suppression_gateway_signing_keystore_name true
Suppress Parameter Validation: Security - Signing Keystore Type Whether to suppress configuration warnings produced by the built-in parameter validation for the Security - Signing Keystore Type parameter. false role_config_suppression_gateway_signing_keystore_type true
Suppress Parameter Validation: Knox Simplified Topology Management - SSO Authentication Provider Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Simplified Topology Management - SSO Authentication Provider parameter. false role_config_suppression_gateway_sso_authentication_provider true
Suppress Parameter Validation: Security - TLS Certificate Alias (Optional) Whether to suppress configuration warnings produced by the built-in parameter validation for the Security - TLS Certificate Alias (Optional) parameter. false role_config_suppression_gateway_tls_certificate_alias true
Suppress Parameter Validation: Security - TLS Certificate Path (Optional) Whether to suppress configuration warnings produced by the built-in parameter validation for the Security - TLS Certificate Path (Optional) parameter. false role_config_suppression_gateway_tls_certificate_path true
Suppress Parameter Validation: X-Forwarded Header Context Service Name Whether to suppress configuration warnings produced by the built-in parameter validation for the X-Forwarded Header Context Service Name parameter. false role_config_suppression_gateway_xforwarded_header_context_append_servicename true
Suppress Parameter Validation: Admin Group Mapping - Class Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin Group Mapping - Class Name parameter. false role_config_suppression_hadoop_security_group_mapping_class true
Suppress Parameter Validation: krb5.conf Location Whether to suppress configuration warnings produced by the built-in parameter validation for the krb5.conf Location parameter. false role_config_suppression_java_security_krb5_conf true
Suppress Parameter Validation: Knox Gateway Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_knox_gateway_role_env_safety_valve true
Suppress Parameter Validation: Knox Gateway Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Knox Gateway Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Knox Gateway TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Knox Gateway TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Knox Gateway TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Knox Gateway TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Gateway TLS/SSL Server JKS Keystore File Password parameter. false role_config_suppression_ssl_server_keystore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Health Test: Audit Pipeline Test 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. false role_health_suppression_knox_knox_gateway_audit_health true
Suppress Health Test: File Descriptors 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. false role_health_suppression_knox_knox_gateway_file_descriptor true
Suppress Health Test: Host Health 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. false role_health_suppression_knox_knox_gateway_host_health true
Suppress Health Test: Log Directory Free Space 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. false role_health_suppression_knox_knox_gateway_log_directory_free_space true
Suppress Health Test: Process Status 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. false role_health_suppression_knox_knox_gateway_scm_health true
Suppress Health Test: Swap Memory Usage 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. false role_health_suppression_knox_knox_gateway_swap_memory_usage true
Suppress Health Test: Unexpected Exits 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. false role_health_suppression_knox_knox_gateway_unexpected_exits true

Categories:

Display Name Description Related Name Default Value API Name Required
Knox IDBroker Advanced Configuration Snippet (Safety Valve) for conf/gateway-reloadable.xml For advanced use only. A string to be inserted into conf/gateway-reloadable.xml for this role only. conf/gateway-reloadable.xml_role_safety_valve false
Knox IDBroker Advanced Configuration Snippet (Safety Valve) for conf/gateway-site.xml For advanced use only. A string to be inserted into conf/gateway-site.xml for this role only. conf/gateway-site.xml_role_safety_valve false
Knox IDBroker Environment Advanced Configuration Snippet (Safety Valve) 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. IDBROKER_role_env_safety_valve false
Knox IDBroker Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Heap Dump Directory 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, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. 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. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
Automatically Restart Process 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. false process_auto_restart true
Enable Metric Collection 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. true process_should_monitor true
Process Start Retry Attempts 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. 3 process_start_retries false
Process Start Wait Timeout 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. 20 process_start_secs false
Display Name Description Related Name Default Value API Name Required
Knox IDBroker Log Directory The log directory for log files of the role Knox IDBroker. log_dir /var/log/knox/idbroker log_dir false
Knox IDBroker Logging Threshold The minimum log level for Knox IDBroker logs INFO log_threshold false
Knox IDBroker Maximum Log File Backups The maximum number of rolled log files to keep for Knox IDBroker logs. Typically used by log4j or logback. 10 max_log_backup_index false
Knox IDBroker Max Log Size The maximum size, in megabytes, per log file for Knox IDBroker logs. Typically used by log4j or logback. 200 MiB max_log_size false
Display Name Description Related Name Default Value API Name Required
Enable Health Alerts for this Role 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 true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % idbroker_fd_thresholds false
Knox IDBroker Host Health Test When computing the overall Knox IDBroker health, consider the host's health. true idbroker_host_health_enabled false
Knox IDBroker Process Health Test Enables the health test that the Knox IDBroker's process state is consistent with the role configuration true idbroker_scm_health_enabled false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds 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. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Metric Filter 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"] }		 monitoring_metric_filter false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
Role Triggers 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.		 [] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false
Display Name Description Related Name Default Value API Name Required
Knox IDBroker Diagnostics Collection Timeout The timeout in milliseconds to wait for diagnostics collection to complete. 5 minute(s) csd_role_diagnostics_timeout false
Knox IDBroker AWS Credentials Key The AWS credentials key idbroker_aws_credentials_key idbroker_aws_credentials_key false
Knox IDBroker AWS Credentials Secret The AWS credentials secret idbroker_aws_credentials_secret idbroker_aws_credentials_secret false
Knox IDBroker AWS Group Mapping 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 idbroker.aws.group.role.mapping idbroker_aws_group_mapping false
Knox IDBroker AWS User Default Group Mapping The list of AWS user default group mappings in 'user=group[;user=group;...;user=group]' format. A 'user=group' declaration allows the given user to get its credentials indicated by the given group (in case the user belongs to different mapped groups) idbroker.aws.user.default.group.mapping idbroker_aws_user_default_group_mapping false
Knox IDBroker AWS User Mapping 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 idbroker.aws.user.role.mapping idbroker_aws_user_mapping false
Knox IDBroker AZURE ADLS2 Tenant Name 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 idbroker_azure_adls2_tenant_name idbroker_azure_adls2_tenant_name false
Knox IDBroker AZURE 'blob-contributor' ClientID The client ID credential for 'blob-contributor' role idbroker_azure_blob_contributor_clientid idbroker_azure_blob_contributor_clientid false
Knox IDBroker AZURE 'blob-contributor' Secret The secret credential for 'blob-contributor' role idbroker_azure_blob_contributor_secret idbroker_azure_blob_contributor_secret false
Knox IDBroker AZURE 'blob-reader' ClientID The client ID credential for 'blob-reader' role idbroker_azure_blob_reader_clientid idbroker_azure_blob_reader_clientid false
Knox IDBroker AZURE 'blob-reader' Secret The secret credential for 'blob-reader' role idbroker_azure_blob_reader_secret idbroker_azure_blob_reader_secret false
Knox IDBroker AZURE Group Mapping 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 idbroker.adls2.group.role.mapping idbroker_azure_group_mapping false
Knox IDBroker AZURE User Default Group Mapping The list of AZURE user default group mappings in 'user=group[;user=group;...;user=group]' format. A 'user=group' declaration allows the given user to get its credentials indicated by the given group (in case the user belongs to different mapped groups) idbroker.azure.user.default.group.mapping idbroker_azure_user_default_group_mapping false
Knox IDBroker AZURE User Mapping 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 idbroker.adls2.user.role.mapping idbroker_azure_user_mapping false
Knox IDBroker AZURE VM Assumer Identity 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. idbroker_azure_vm_assumer_identity idbroker_azure_vm_assumer_identity false
Knox IDBroker Configuration Directory Contains configuration files that apply to the gateway globally (i.e. not cluster specific ). idbroker_conf_dir /var/lib/knox/idbroker/conf idbroker_conf_dir false
Knox IDBroker Data Directory Contains security and topology specific artifacts as well as important applications for admin-ui idbroker_data_dir /var/lib/knox/idbroker/data idbroker_data_dir false
Gateway - Default App Topology Name 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. default.app.topology.name idbroker_default_topology_name false
Gateway Config Directory The directory within 'idbroker_data_dir' that contains gateway topology files and deployments. gateway.gateway.conf.dir deployments idbroker_gateway_gateway_conf_dir false
Admin Groups Admin groups for Knox gateway.knox.admin.groups idbroker_gateway_knox_admin_groups false
Gateway Path The default context path for the gateway. gateway.path gateway idbroker_gateway_path true
Cookie Scoping Enabled Enable/Disable cookie scoping feature. gateway.scope.cookies.feature.enabled false idbroker_gateway_scope_cookies_feature_enabled false
Security - Signing Key Alias The alias for the signing keypair within the keystore specified via idbroker_gateway_signing_keystore_name gateway.signing.key.alias idbroker_gateway_signing_key_alias false
Security - Signing Keystore Name The filename of keystore file that contains the signing keypair gateway.signing.keystore.name idbroker_gateway_signing_keystore_name false
Security - Signing Keystore Type The type of the keystore file where the signing keypair is stored. See idbroker_gateway_signing_keystore_name gateway.signing.keystore.type idbroker_gateway_signing_keystore_type false
Knox IDBroker GCP Credential Key The GCP Credential Key idbroker_gcp_credential_key idbroker_gcp_credential_key false
Knox IDBroker GCP Credential Secret The GCP Credential Secret idbroker_gcp_credential_secret idbroker_gcp_credential_secret false
Knox IDBroker GCP Group Mapping 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 idbroker.gcp.group.role.mapping idbroker_gcp_group_mapping false
Knox IDBroker GCP User Default Group Mapping The list of GCP user default group mappings in 'user=group[;user=group;...;user=group]' format. A 'user=group' declaration allows the given user to get its credentials indicated by the given group (in case the user belongs to different mapped groups) idbroker.gcp.user.default.group.mapping idbroker_gcp_user_default_group_mapping false
Knox IDBroker GCP User Mapping 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 idbroker.gcp.user.role.mapping idbroker_gcp_user_mapping false
Admin Group Mapping - Class Name The class name used for Hadoop admin group mapping gateway.group.config.hadoop.security.group.mapping org.apache.hadoop.security.ShellBasedUnixGroupsMapping idbroker_hadoop_security_group_mapping_class false
IDBroker Initial/Max Heapsize Initial/Maximum size for the Java Process heap. Passed to Java -Xmx/-Xms. Measured in megabytes. idbroker_heap_size 1 GiB idbroker_heap_size true
Additional IDBroker Java Options 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 idbroker_java_opts idbroker_java_opts false
krb5.conf Location Absolute path to krb5.conf file java.security.krb5.conf /etc/krb5.conf idbroker_java_security_krb5_conf false
Kerberos Proxyuser Block Proxyuser configuration used in Knox's 'dt' topology in case Kerberos is enabled. Must conform a valid JSON key-value format! idbroker_kerberos_dt_proxyuser_block hadoop.proxyuser.livy.hosts: * hadoop.proxyuser.livy.groups: * hadoop.proxyuser.hive.hosts: * hadoop.proxyuser.hive.groups: * hadoop.proxyuser.httpfs.hosts: * hadoop.proxyuser.httpfs.groups: * hadoop.proxyuser.hue.hosts: * hadoop.proxyuser.hue.groups: * hadoop.proxyuser.oozie.hosts: * hadoop.proxyuser.oozie.groups: * hadoop.proxyuser.impala.hosts: * hadoop.proxyuser.impala.groups: * idbroker_kerberos_dt_proxyuser_block false
IDBroker Knox Token TTL This indicates the lifespan of the token. Once it expires a new token must be acquired from KnoxToken service. This is in milliseconds. idbroker_knox_token_ttl_ms 7 day(s) idbroker_knox_token_ttl_ms false
Knox IDBroker Log Directory The folder where Knox IDBroker puts it's logs idbroker_log_dir /var/log/knox/idbroker idbroker_log_dir false
IDBroker Log Level The logging level of IDBroker idbroker_log_level ERROR idbroker_log_level false
IDBroker Master Secret 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 idbroker_master_secret idbroker_master_secret true
Gateway Config Refresh Interval Defines the frequency of gateway configuration refresh. gateway.config.refresh.interval 10 second(s) idbroker_relaodable_refresh_interval_ms false
KRB5 Debug Boolean flag indicating whether to enable debug messages for krb5 authentication sun.security.krb5.debug false idbroker_sun_security_krb5_debug false
Display Name Description Related Name Default Value API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false
Display Name Description Related Name Default Value API Name Required
Gateway HTTP Port The HTTP port for the Gateway. gateway.port 8444 idbroker_gateway_port true
Display Name Description Related Name Default Value API Name Required
Cgroup CPU Shares 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. cpu.shares 1024 rm_cpu_shares true
Custom Control Group Resources (overrides Cgroup settings) 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.*** custom.cgroups rm_custom_resources false
Cgroup I/O Weight 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. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit 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' memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit 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' memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true
Display Name Description Related Name Default Value API Name Required
Knox IDBroker TLS/SSL Client Trust Store File 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 is used when Knox IDBroker is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead. gateway.httpclient.truststore.path ssl_client_truststore_location false
Knox IDBroker TLS/SSL Client Trust Store Password The password for the Knox IDBroker TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. ssl_client_truststore_password false
Enable TLS/SSL for Knox IDBroker Encrypt communication between clients and Knox IDBroker using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). knox.enableTLS false ssl_enabled false
Knox IDBroker TLS/SSL Server JKS Keystore File Location 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 JKS format. gateway.tls.keystore.path ssl_server_keystore_location false
Knox IDBroker TLS/SSL Server JKS Keystore File Password The password for the Knox IDBroker JKS keystore file. ssl_server_keystore_password false
Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method 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. stacks_collection_method jstack stacks_collection_method false
Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Knox IDBroker Advanced Configuration Snippet (Safety Valve) for conf/gateway-reloadable.xml 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. false role_config_suppression_conf/gateway-reloadable.xml_role_safety_valve true
Suppress Parameter Validation: Knox IDBroker Advanced Configuration Snippet (Safety Valve) for conf/gateway-site.xml 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. false role_config_suppression_conf/gateway-site.xml_role_safety_valve true
Suppress Parameter Validation: Knox IDBroker AWS Credentials Key Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AWS Credentials Key parameter. false role_config_suppression_idbroker_aws_credentials_key true
Suppress Parameter Validation: Knox IDBroker AWS Credentials Secret Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AWS Credentials Secret parameter. false role_config_suppression_idbroker_aws_credentials_secret true
Suppress Parameter Validation: Knox IDBroker AWS Group Mapping Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AWS Group Mapping parameter. false role_config_suppression_idbroker_aws_group_mapping true
Suppress Parameter Validation: Knox IDBroker AWS User Default Group Mapping Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AWS User Default Group Mapping parameter. false role_config_suppression_idbroker_aws_user_default_group_mapping true
Suppress Parameter Validation: Knox IDBroker AWS User Mapping Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AWS User Mapping parameter. false role_config_suppression_idbroker_aws_user_mapping true
Suppress Parameter Validation: Knox IDBroker AZURE ADLS2 Tenant Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AZURE ADLS2 Tenant Name parameter. false role_config_suppression_idbroker_azure_adls2_tenant_name true
Suppress Parameter Validation: Knox IDBroker AZURE 'blob-contributor' ClientID Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AZURE 'blob-contributor' ClientID parameter. false role_config_suppression_idbroker_azure_blob_contributor_clientid true
Suppress Parameter Validation: Knox IDBroker AZURE 'blob-contributor' Secret Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AZURE 'blob-contributor' Secret parameter. false role_config_suppression_idbroker_azure_blob_contributor_secret true
Suppress Parameter Validation: Knox IDBroker AZURE 'blob-reader' ClientID Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AZURE 'blob-reader' ClientID parameter. false role_config_suppression_idbroker_azure_blob_reader_clientid true
Suppress Parameter Validation: Knox IDBroker AZURE 'blob-reader' Secret Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AZURE 'blob-reader' Secret parameter. false role_config_suppression_idbroker_azure_blob_reader_secret true
Suppress Parameter Validation: Knox IDBroker AZURE Group Mapping Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AZURE Group Mapping parameter. false role_config_suppression_idbroker_azure_group_mapping true
Suppress Parameter Validation: Knox IDBroker AZURE User Default Group Mapping Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AZURE User Default Group Mapping parameter. false role_config_suppression_idbroker_azure_user_default_group_mapping true
Suppress Parameter Validation: Knox IDBroker AZURE User Mapping Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AZURE User Mapping parameter. false role_config_suppression_idbroker_azure_user_mapping true
Suppress Parameter Validation: Knox IDBroker AZURE VM Assumer Identity Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker AZURE VM Assumer Identity parameter. false role_config_suppression_idbroker_azure_vm_assumer_identity true
Suppress Parameter Validation: Knox IDBroker Configuration Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker Configuration Directory parameter. false role_config_suppression_idbroker_conf_dir true
Suppress Parameter Validation: Knox IDBroker Data Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker Data Directory parameter. false role_config_suppression_idbroker_data_dir true
Suppress Parameter Validation: Gateway - Default App Topology Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway - Default App Topology Name parameter. false role_config_suppression_idbroker_default_topology_name true
Suppress Parameter Validation: Gateway Config Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway Config Directory parameter. false role_config_suppression_idbroker_gateway_gateway_conf_dir true
Suppress Parameter Validation: Admin Groups Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin Groups parameter. false role_config_suppression_idbroker_gateway_knox_admin_groups true
Suppress Parameter Validation: Gateway Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway Path parameter. false role_config_suppression_idbroker_gateway_path true
Suppress Parameter Validation: Gateway HTTP Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway HTTP Port parameter. false role_config_suppression_idbroker_gateway_port true
Suppress Parameter Validation: Security - Signing Key Alias Whether to suppress configuration warnings produced by the built-in parameter validation for the Security - Signing Key Alias parameter. false role_config_suppression_idbroker_gateway_signing_key_alias true
Suppress Parameter Validation: Security - Signing Keystore Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Security - Signing Keystore Name parameter. false role_config_suppression_idbroker_gateway_signing_keystore_name true
Suppress Parameter Validation: Security - Signing Keystore Type Whether to suppress configuration warnings produced by the built-in parameter validation for the Security - Signing Keystore Type parameter. false role_config_suppression_idbroker_gateway_signing_keystore_type true
Suppress Parameter Validation: Knox IDBroker GCP Credential Key Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker GCP Credential Key parameter. false role_config_suppression_idbroker_gcp_credential_key true
Suppress Parameter Validation: Knox IDBroker GCP Credential Secret Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker GCP Credential Secret parameter. false role_config_suppression_idbroker_gcp_credential_secret true
Suppress Parameter Validation: Knox IDBroker GCP Group Mapping Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker GCP Group Mapping parameter. false role_config_suppression_idbroker_gcp_group_mapping true
Suppress Parameter Validation: Knox IDBroker GCP User Default Group Mapping Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker GCP User Default Group Mapping parameter. false role_config_suppression_idbroker_gcp_user_default_group_mapping true
Suppress Parameter Validation: Knox IDBroker GCP User Mapping Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker GCP User Mapping parameter. false role_config_suppression_idbroker_gcp_user_mapping true
Suppress Parameter Validation: Admin Group Mapping - Class Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin Group Mapping - Class Name parameter. false role_config_suppression_idbroker_hadoop_security_group_mapping_class true
Suppress Parameter Validation: IDBroker Initial/Max Heapsize Whether to suppress configuration warnings produced by the built-in parameter validation for the IDBroker Initial/Max Heapsize parameter. false role_config_suppression_idbroker_heap_size true
Suppress Parameter Validation: Additional IDBroker Java Options Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional IDBroker Java Options parameter. false role_config_suppression_idbroker_java_opts true
Suppress Parameter Validation: krb5.conf Location Whether to suppress configuration warnings produced by the built-in parameter validation for the krb5.conf Location parameter. false role_config_suppression_idbroker_java_security_krb5_conf true
Suppress Parameter Validation: Kerberos Proxyuser Block Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Proxyuser Block parameter. false role_config_suppression_idbroker_kerberos_dt_proxyuser_block true
Suppress Parameter Validation: Knox IDBroker Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker Log Directory parameter. false role_config_suppression_idbroker_log_dir true
Suppress Parameter Validation: IDBroker Master Secret Whether to suppress configuration warnings produced by the built-in parameter validation for the IDBroker Master Secret parameter. false role_config_suppression_idbroker_master_secret true
Suppress Parameter Validation: Knox IDBroker Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_idbroker_role_env_safety_valve true
Suppress Parameter Validation: Knox IDBroker Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Knox IDBroker Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Knox IDBroker TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Knox IDBroker TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Knox IDBroker TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Knox IDBroker TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox IDBroker TLS/SSL Server JKS Keystore File Password parameter. false role_config_suppression_ssl_server_keystore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Health Test: Audit Pipeline Test 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. false role_health_suppression_knox_idbroker_audit_health true
Suppress Health Test: File Descriptors 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. false role_health_suppression_knox_idbroker_file_descriptor true
Suppress Health Test: Host Health 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. false role_health_suppression_knox_idbroker_host_health true
Suppress Health Test: Log Directory Free Space 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. false role_health_suppression_knox_idbroker_log_directory_free_space true
Suppress Health Test: Process Status 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. false role_health_suppression_knox_idbroker_scm_health true
Suppress Health Test: Swap Memory Usage 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. false role_health_suppression_knox_idbroker_swap_memory_usage true
Suppress Health Test: Unexpected Exits 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. false role_health_suppression_knox_idbroker_unexpected_exits true

Categories:

Display Name Description Related Name Default Value API Name Required
Knox Service Advanced Configuration Snippet (Safety Valve) for conf/gateway-site.xml 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. conf/gateway-site.xml_service_safety_valve false
Knox Service Environment Advanced Configuration Snippet (Safety Valve) 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. KNOX_service_env_safety_valve false
System Group The group that this service's processes should run as. knox process_groupname true
System User The user that this service's processes should run as. knox process_username true
Display Name Description Related Name Default Value API Name Required
Enable Service Level Health Alerts 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 true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Healthy Knox IDBroker Monitoring Thresholds 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. Warning: 99.0 %, Critical: 49.0 % KNOX_IDBROKER_healthy_thresholds false
Healthy Knox Gateway Monitoring Thresholds 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. Warning: 99.0 %, Critical: 49.0 % KNOX_KNOX_GATEWAY_healthy_thresholds false
Service Triggers 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.		 [] service_triggers true
Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones. smon_derived_configs_safety_valve false
Display Name Description Related Name Default Value API Name Required
Automatic Restart on Stop Automatically restart the service when a stop is issued. autorestart_on_stop false autorestart_on_stop false
HDFS Service Name of the HDFS service that this Knox service instance depends on hdfs_service false
Enable Kerberos Authentication Boolean flag indicating whether the Hadoop cluster protected by Gateway is secured with Kerberos gateway.hadoop.kerberos.secured false kerberos.auth.enabled false
Knox PAM Realm - Service Name Using KnoxPamRealm requires a PAM service name. This is the name of the file under '/etc/pam.d' that is used to initialize and configure the PAM subsystem. Normally, this file reflects the application using it. For example 'login', 'sshd', 'su', etc... knox_pam_realm_service login knox_pam_realm_service false
Ranger Knox Plugin Hdfs Audit Directory The HDFS path on which Ranger audits are written. ranger_knox_plugin_hdfs_audit_directory $ranger_base_audit_url/knox ranger_knox_plugin_hdfs_audit_directory false
RANGER Service Name of the RANGER service that this Knox service instance depends on ranger_service false
Save Alias Command Input This parameter serves as the input for the 'Save Alias' command. The input must follow the following format: topology_name_1[:topology_name_2:...:topology_name_N].alias_name=password save_alias_command_input_password save_alias_command_input_password false
Display Name Description Related Name Default Value API Name Required
Kerberos Principal Kerberos principal short name used by all roles of this service. knox kerberos_princ_name true
Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Configuration Validator: Deploy Directory Whether to suppress configuration warnings produced by the Deploy Directory configuration validator. false role_config_suppression_client_config_root_dir true
Suppress Configuration Validator: Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/auto-discovery-advanced-configuration-cdp-proxy-api.properties 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. false role_config_suppression_conf/auto-discovery-advanced-configuration-cdp-proxy-api.properties_role_safety_valve true
Suppress Configuration Validator: Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/auto-discovery-advanced-configuration-cdp-proxy.properties 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. false role_config_suppression_conf/auto-discovery-advanced-configuration-cdp-proxy.properties_role_safety_valve true
Suppress Configuration Validator: Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/cdp-resources.xml Whether to suppress configuration warnings produced by the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/cdp-resources.xml configuration validator. false role_config_suppression_conf/cdp-resources.xml_role_safety_valve true
Suppress Configuration Validator: Knox IDBroker Advanced Configuration Snippet (Safety Valve) for conf/gateway-reloadable.xml Whether to suppress configuration warnings produced by the Knox IDBroker Advanced Configuration Snippet (Safety Valve) for conf/gateway-reloadable.xml configuration validator. false role_config_suppression_conf/gateway-reloadable.xml_role_safety_valve true
Suppress Configuration Validator: Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/gateway-site.xml Whether to suppress configuration warnings produced by the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/gateway-site.xml configuration validator. false role_config_suppression_conf/gateway-site.xml_role_safety_valve true
Suppress Configuration Validator: Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-audit.xml Whether to suppress configuration warnings produced by the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-audit.xml configuration validator. false role_config_suppression_conf/ranger-knox-audit.xml_role_safety_valve true
Suppress Configuration Validator: Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-policymgr-ssl.xml Whether to suppress configuration warnings produced by the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-policymgr-ssl.xml configuration validator. false role_config_suppression_conf/ranger-knox-policymgr-ssl.xml_role_safety_valve true
Suppress Configuration Validator: Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-security.xml Whether to suppress configuration warnings produced by the Knox Gateway Advanced Configuration Snippet (Safety Valve) for conf/ranger-knox-security.xml configuration validator. false role_config_suppression_conf/ranger-knox-security.xml_role_safety_valve true
Suppress Configuration Validator: Knox Simplified Topology Management - API Authentication Provider Whether to suppress configuration warnings produced by the Knox Simplified Topology Management - API Authentication Provider configuration validator. false role_config_suppression_gateway_api_authentication_provider true
Suppress Configuration Validator: Knox Gateway Configuration Directory Whether to suppress configuration warnings produced by the Knox Gateway Configuration Directory configuration validator. false role_config_suppression_gateway_conf_dir true
Suppress Configuration Validator: Knox Gateway Data Directory Whether to suppress configuration warnings produced by the Knox Gateway Data Directory configuration validator. false role_config_suppression_gateway_data_dir true
Suppress Configuration Validator: Gateway - Default App Topology Name Whether to suppress configuration warnings produced by the Gateway - Default App Topology Name configuration validator. false role_config_suppression_gateway_default_topology_name true
Suppress Configuration Validator: Knox Simplified Topology Management - cdp-proxy Whether to suppress configuration warnings produced by the Knox Simplified Topology Management - cdp-proxy configuration validator. false role_config_suppression_gateway_descriptor_cdp_proxy true
Suppress Configuration Validator: Knox Simplified Topology Management - cdp-proxy-api Whether to suppress configuration warnings produced by the Knox Simplified Topology Management - cdp-proxy-api configuration validator. false role_config_suppression_gateway_descriptor_cdp_proxy_api true
Suppress Configuration Validator: Knox Gateway Dispatch Whitelist Whether to suppress configuration warnings produced by the Knox Gateway Dispatch Whitelist configuration validator. false role_config_suppression_gateway_dispatch_whitelist true
Suppress Configuration Validator: Knox Gateway Dispatch Whitelist Services Whether to suppress configuration warnings produced by the Knox Gateway Dispatch Whitelist Services configuration validator. false role_config_suppression_gateway_dispatch_whitelist_services true
Suppress Configuration Validator: Gateway Config Directory Whether to suppress configuration warnings produced by the Gateway Config Directory configuration validator. false role_config_suppression_gateway_gateway_conf_dir true
Suppress Configuration Validator: Knox Gateway Initial/Max Heapsize Whether to suppress configuration warnings produced by the Knox Gateway Initial/Max Heapsize configuration validator. false role_config_suppression_gateway_heap_size true
Suppress Configuration Validator: Additional Gateway Java Options Whether to suppress configuration warnings produced by the Additional Gateway Java Options configuration validator. false role_config_suppression_gateway_java_opts true
Suppress Configuration Validator: Admin Groups Whether to suppress configuration warnings produced by the Admin Groups configuration validator. false role_config_suppression_gateway_knox_admin_groups true
Suppress Configuration Validator: Knox Master Secret Whether to suppress configuration warnings produced by the Knox Master Secret configuration validator. false role_config_suppression_gateway_master_secret true
Suppress Configuration Validator: Gateway Path Whether to suppress configuration warnings produced by the Gateway Path configuration validator. false role_config_suppression_gateway_path true
Suppress Configuration Validator: Gateway HTTP Port Whether to suppress configuration warnings produced by the Gateway HTTP Port configuration validator. false role_config_suppression_gateway_port true
Suppress Configuration Validator: Ranger Knox Plugin Conf Path Whether to suppress configuration warnings produced by the Ranger Knox Plugin Conf Path configuration validator. false role_config_suppression_gateway_ranger_knox_plugin_conf_path true
Suppress Configuration Validator: Ranger Knox Plugin Audit Hdfs Spool Directory Path Whether to suppress configuration warnings produced by the Ranger Knox Plugin Audit Hdfs Spool Directory Path configuration validator. false role_config_suppression_gateway_ranger_knox_plugin_hdfs_audit_spool_directory true
Suppress Configuration Validator: Ranger Knox Plugin Policy Cache Directory Path Whether to suppress configuration warnings produced by the Ranger Knox Plugin Policy Cache Directory Path configuration validator. false role_config_suppression_gateway_ranger_knox_plugin_policy_cache_directory true
Suppress Configuration Validator: Ranger Knox Plugin Audit Solr Spool Directory Path Whether to suppress configuration warnings produced by the Ranger Knox Plugin Audit Solr Spool Directory Path configuration validator. false role_config_suppression_gateway_ranger_knox_plugin_solr_audit_spool_directory true
Suppress Configuration Validator: Ranger Plugin Trusted Proxy IP Address Whether to suppress configuration warnings produced by the Ranger Plugin Trusted Proxy IP Address configuration validator. false role_config_suppression_gateway_ranger_plugin_trusted_proxy_ipaddress true
Suppress Configuration Validator: Security - Signing Key Alias Whether to suppress configuration warnings produced by the Security - Signing Key Alias configuration validator. false role_config_suppression_gateway_signing_key_alias true
Suppress Configuration Validator: Security - Signing Keystore Name Whether to suppress configuration warnings produced by the Security - Signing Keystore Name configuration validator. false role_config_suppression_gateway_signing_keystore_name true
Suppress Configuration Validator: Security - Signing Keystore Type Whether to suppress configuration warnings produced by the Security - Signing Keystore Type configuration validator. false role_config_suppression_gateway_signing_keystore_type true
Suppress Configuration Validator: Knox Simplified Topology Management - SSO Authentication Provider Whether to suppress configuration warnings produced by the Knox Simplified Topology Management - SSO Authentication Provider configuration validator. false role_config_suppression_gateway_sso_authentication_provider true
Suppress Configuration Validator: Security - TLS Certificate Alias (Optional) Whether to suppress configuration warnings produced by the Security - TLS Certificate Alias (Optional) configuration validator. false role_config_suppression_gateway_tls_certificate_alias true
Suppress Configuration Validator: Security - TLS Certificate Path (Optional) Whether to suppress configuration warnings produced by the Security - TLS Certificate Path (Optional) configuration validator. false role_config_suppression_gateway_tls_certificate_path true
Suppress Configuration Validator: X-Forwarded Header Context Service Name Whether to suppress configuration warnings produced by the X-Forwarded Header Context Service Name configuration validator. false role_config_suppression_gateway_xforwarded_header_context_append_servicename true
Suppress Configuration Validator: Admin Group Mapping - Class Name Whether to suppress configuration warnings produced by the Admin Group Mapping - Class Name configuration validator. false role_config_suppression_hadoop_security_group_mapping_class true
Suppress Configuration Validator: Knox IDBroker AWS Credentials Key Whether to suppress configuration warnings produced by the Knox IDBroker AWS Credentials Key configuration validator. false role_config_suppression_idbroker_aws_credentials_key true
Suppress Configuration Validator: Knox IDBroker AWS Credentials Secret Whether to suppress configuration warnings produced by the Knox IDBroker AWS Credentials Secret configuration validator. false role_config_suppression_idbroker_aws_credentials_secret true
Suppress Configuration Validator: Knox IDBroker AWS Group Mapping Whether to suppress configuration warnings produced by the Knox IDBroker AWS Group Mapping configuration validator. false role_config_suppression_idbroker_aws_group_mapping true
Suppress Configuration Validator: Knox IDBroker AWS User Default Group Mapping Whether to suppress configuration warnings produced by the Knox IDBroker AWS User Default Group Mapping configuration validator. false role_config_suppression_idbroker_aws_user_default_group_mapping true
Suppress Configuration Validator: Knox IDBroker AWS User Mapping Whether to suppress configuration warnings produced by the Knox IDBroker AWS User Mapping configuration validator. false role_config_suppression_idbroker_aws_user_mapping true
Suppress Configuration Validator: Knox IDBroker AZURE ADLS2 Tenant Name Whether to suppress configuration warnings produced by the Knox IDBroker AZURE ADLS2 Tenant Name configuration validator. false role_config_suppression_idbroker_azure_adls2_tenant_name true
Suppress Configuration Validator: Knox IDBroker AZURE 'blob-contributor' ClientID Whether to suppress configuration warnings produced by the Knox IDBroker AZURE 'blob-contributor' ClientID configuration validator. false role_config_suppression_idbroker_azure_blob_contributor_clientid true
Suppress Configuration Validator: Knox IDBroker AZURE 'blob-contributor' Secret Whether to suppress configuration warnings produced by the Knox IDBroker AZURE 'blob-contributor' Secret configuration validator. false role_config_suppression_idbroker_azure_blob_contributor_secret true
Suppress Configuration Validator: Knox IDBroker AZURE 'blob-reader' ClientID Whether to suppress configuration warnings produced by the Knox IDBroker AZURE 'blob-reader' ClientID configuration validator. false role_config_suppression_idbroker_azure_blob_reader_clientid true
Suppress Configuration Validator: Knox IDBroker AZURE 'blob-reader' Secret Whether to suppress configuration warnings produced by the Knox IDBroker AZURE 'blob-reader' Secret configuration validator. false role_config_suppression_idbroker_azure_blob_reader_secret true
Suppress Configuration Validator: Knox IDBroker AZURE Group Mapping Whether to suppress configuration warnings produced by the Knox IDBroker AZURE Group Mapping configuration validator. false role_config_suppression_idbroker_azure_group_mapping true
Suppress Configuration Validator: Knox IDBroker AZURE User Default Group Mapping Whether to suppress configuration warnings produced by the Knox IDBroker AZURE User Default Group Mapping configuration validator. false role_config_suppression_idbroker_azure_user_default_group_mapping true
Suppress Configuration Validator: Knox IDBroker AZURE User Mapping Whether to suppress configuration warnings produced by the Knox IDBroker AZURE User Mapping configuration validator. false role_config_suppression_idbroker_azure_user_mapping true
Suppress Configuration Validator: Knox IDBroker AZURE VM Assumer Identity Whether to suppress configuration warnings produced by the Knox IDBroker AZURE VM Assumer Identity configuration validator. false role_config_suppression_idbroker_azure_vm_assumer_identity true
Suppress Configuration Validator: Knox IDBroker Configuration Directory Whether to suppress configuration warnings produced by the Knox IDBroker Configuration Directory configuration validator. false role_config_suppression_idbroker_conf_dir true
Suppress Configuration Validator: Knox IDBroker Data Directory Whether to suppress configuration warnings produced by the Knox IDBroker Data Directory configuration validator. false role_config_suppression_idbroker_data_dir true
Suppress Configuration Validator: Gateway - Default App Topology Name Whether to suppress configuration warnings produced by the Gateway - Default App Topology Name configuration validator. false role_config_suppression_idbroker_default_topology_name true
Suppress Configuration Validator: Gateway Config Directory Whether to suppress configuration warnings produced by the Gateway Config Directory configuration validator. false role_config_suppression_idbroker_gateway_gateway_conf_dir true
Suppress Configuration Validator: Admin Groups Whether to suppress configuration warnings produced by the Admin Groups configuration validator. false role_config_suppression_idbroker_gateway_knox_admin_groups true
Suppress Configuration Validator: Gateway Path Whether to suppress configuration warnings produced by the Gateway Path configuration validator. false role_config_suppression_idbroker_gateway_path true
Suppress Configuration Validator: Gateway HTTP Port Whether to suppress configuration warnings produced by the Gateway HTTP Port configuration validator. false role_config_suppression_idbroker_gateway_port true
Suppress Configuration Validator: Security - Signing Key Alias Whether to suppress configuration warnings produced by the Security - Signing Key Alias configuration validator. false role_config_suppression_idbroker_gateway_signing_key_alias true
Suppress Configuration Validator: Security - Signing Keystore Name Whether to suppress configuration warnings produced by the Security - Signing Keystore Name configuration validator. false role_config_suppression_idbroker_gateway_signing_keystore_name true
Suppress Configuration Validator: Security - Signing Keystore Type Whether to suppress configuration warnings produced by the Security - Signing Keystore Type configuration validator. false role_config_suppression_idbroker_gateway_signing_keystore_type true
Suppress Configuration Validator: Knox IDBroker GCP Credential Key Whether to suppress configuration warnings produced by the Knox IDBroker GCP Credential Key configuration validator. false role_config_suppression_idbroker_gcp_credential_key true
Suppress Configuration Validator: Knox IDBroker GCP Credential Secret Whether to suppress configuration warnings produced by the Knox IDBroker GCP Credential Secret configuration validator. false role_config_suppression_idbroker_gcp_credential_secret true
Suppress Configuration Validator: Knox IDBroker GCP Group Mapping Whether to suppress configuration warnings produced by the Knox IDBroker GCP Group Mapping configuration validator. false role_config_suppression_idbroker_gcp_group_mapping true
Suppress Configuration Validator: Knox IDBroker GCP User Default Group Mapping Whether to suppress configuration warnings produced by the Knox IDBroker GCP User Default Group Mapping configuration validator. false role_config_suppression_idbroker_gcp_user_default_group_mapping true
Suppress Configuration Validator: Knox IDBroker GCP User Mapping Whether to suppress configuration warnings produced by the Knox IDBroker GCP User Mapping configuration validator. false role_config_suppression_idbroker_gcp_user_mapping true
Suppress Configuration Validator: Admin Group Mapping - Class Name Whether to suppress configuration warnings produced by the Admin Group Mapping - Class Name configuration validator. false role_config_suppression_idbroker_hadoop_security_group_mapping_class true
Suppress Configuration Validator: IDBroker Initial/Max Heapsize Whether to suppress configuration warnings produced by the IDBroker Initial/Max Heapsize configuration validator. false role_config_suppression_idbroker_heap_size true
Suppress Configuration Validator: Additional IDBroker Java Options Whether to suppress configuration warnings produced by the Additional IDBroker Java Options configuration validator. false role_config_suppression_idbroker_java_opts true
Suppress Configuration Validator: krb5.conf Location Whether to suppress configuration warnings produced by the krb5.conf Location configuration validator. false role_config_suppression_idbroker_java_security_krb5_conf true
Suppress Configuration Validator: Kerberos Proxyuser Block Whether to suppress configuration warnings produced by the Kerberos Proxyuser Block configuration validator. false role_config_suppression_idbroker_kerberos_dt_proxyuser_block true
Suppress Configuration Validator: Knox IDBroker Log Directory Whether to suppress configuration warnings produced by the Knox IDBroker Log Directory configuration validator. false role_config_suppression_idbroker_log_dir true
Suppress Configuration Validator: IDBroker Master Secret Whether to suppress configuration warnings produced by the IDBroker Master Secret configuration validator. false role_config_suppression_idbroker_master_secret true
Suppress Configuration Validator: Knox IDBroker Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Knox IDBroker Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_idbroker_role_env_safety_valve true
Suppress Configuration Validator: krb5.conf Location Whether to suppress configuration warnings produced by the krb5.conf Location configuration validator. false role_config_suppression_java_security_krb5_conf true
Suppress Configuration Validator: Knox Gateway Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Knox Gateway Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_knox_gateway_role_env_safety_valve true
Suppress Configuration Validator: Knox Gateway Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Knox Gateway Logging Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_log4j_safety_valve true
Suppress Configuration Validator: Knox Gateway Log Directory Whether to suppress configuration warnings produced by the Knox Gateway Log Directory configuration validator. false role_config_suppression_log_dir true
Suppress Configuration Validator: Heap Dump Directory Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator. false role_config_suppression_oom_heap_dump_dir true
Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator. false role_config_suppression_rm_custom_resources true
Suppress Configuration Validator: Role Triggers Whether to suppress configuration warnings produced by the Role Triggers configuration validator. false role_config_suppression_role_triggers true
Suppress Configuration Validator: Knox Gateway TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the Knox Gateway TLS/SSL Client Trust Store File configuration validator. false role_config_suppression_ssl_client_truststore_location true
Suppress Configuration Validator: Knox Gateway TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the Knox Gateway TLS/SSL Client Trust Store Password configuration validator. false role_config_suppression_ssl_client_truststore_password true
Suppress Configuration Validator: Knox Gateway TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the Knox Gateway TLS/SSL Server JKS Keystore File Location configuration validator. false role_config_suppression_ssl_server_keystore_location true
Suppress Configuration Validator: Knox Gateway TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the Knox Gateway TLS/SSL Server JKS Keystore File Password configuration validator. false role_config_suppression_ssl_server_keystore_password true
Suppress Configuration Validator: Stacks Collection Directory Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator. false role_config_suppression_stacks_collection_directory true
Suppress Parameter Validation: Knox Service Advanced Configuration Snippet (Safety Valve) for conf/gateway-site.xml 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. false service_config_suppression_conf/gateway-site.xml_service_safety_valve true
Suppress Configuration Validator: Gateway Count Validator Whether to suppress configuration warnings produced by the Gateway Count Validator configuration validator. false service_config_suppression_gateway_count_validator true
Suppress Configuration Validator: Knox IDBroker Count Validator Whether to suppress configuration warnings produced by the Knox IDBroker Count Validator configuration validator. false service_config_suppression_idbroker_count_validator true
Suppress Parameter Validation: Kerberos Principal Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Principal parameter. false service_config_suppression_kerberos_princ_name true
Suppress Configuration Validator: Knox Gateway Count Validator Whether to suppress configuration warnings produced by the Knox Gateway Count Validator configuration validator. false service_config_suppression_knox_gateway_count_validator true
Suppress Parameter Validation: Knox PAM Realm - Service Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox PAM Realm - Service Name parameter. false service_config_suppression_knox_pam_realm_service true
Suppress Parameter Validation: Knox Service Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Service Environment Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_knox_service_env_safety_valve true
Suppress Parameter Validation: System Group Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter. false service_config_suppression_process_groupname true
Suppress Parameter Validation: System User Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter. false service_config_suppression_process_username true
Suppress Parameter Validation: Ranger Knox Plugin Hdfs Audit Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Knox Plugin Hdfs Audit Directory parameter. false service_config_suppression_ranger_knox_plugin_hdfs_audit_directory true
Suppress Parameter Validation: Save Alias Command Input Whether to suppress configuration warnings produced by the built-in parameter validation for the Save Alias Command Input parameter. false service_config_suppression_save_alias_command_input_password true
Suppress Parameter Validation: Service Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter. false service_config_suppression_service_triggers true
Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_smon_derived_configs_safety_valve true
Suppress Health Test: Knox IDBroker Health 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. false service_health_suppression_knox_idbroker_healthy true
Suppress Health Test: Knox Gateway Health 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. false service_health_suppression_knox_knox_gateway_healthy true

We want your opinion

How can we improve this page?

What kind of feedback do you have?