Zeppelin Properties in CDH 6.1.0

Role groups:

Service-Wide

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
System Group The group that this service's processes should run as. zeppelin process_groupname true
System User The user that this service's processes should run as. zeppelin process_username true
Zeppelin 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. ZEPPELIN_service_env_safety_valve false

Monitoring

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
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
Zeppelin Server Role Health Test When computing the overall ZEPPELIN health, consider Zeppelin Server's health true ZEPPELIN_ZEPPELIN_SERVER_health_enabled false

Other

Display Name Description Related Name Default Value API Name Required
HDFS Service Name of the HDFS service that this Zeppelin service instance depends on hdfs_service true
Knox Service Name of the Knox service that this Zeppelin service instance depends on knox_service false
Livy Service Name of the Livy service that this Zeppelin service instance depends on livy_service false
Spark Service Name of the Spark service that this Zeppelin service instance depends on spark_on_yarn_service true
YARN Service Name of the YARN service that this Zeppelin service instance depends on yarn_service true
Zeppelin Authentication Method Indicates whether Kerberos is enabled. zeppelin.authentication.method.kerberos false zeppelin.authentication.method.kerberos false

Security

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

Suppressions

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: Zeppelin Server Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Zeppelin Server Logging Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_log4j_safety_valve true
Suppress Configuration Validator: Zeppelin Server Log Directory Whether to suppress configuration warnings produced by the Zeppelin Server 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: Zeppelin Server TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the Zeppelin Server TLS/SSL Client Trust Store File configuration validator. false role_config_suppression_ssl_client_truststore_location true
Suppress Configuration Validator: Zeppelin Server TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the Zeppelin Server TLS/SSL Client Trust Store Password configuration validator. false role_config_suppression_ssl_client_truststore_password true
Suppress Configuration Validator: Zeppelin Server TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the Zeppelin Server TLS/SSL Server JKS Keystore File Location configuration validator. false role_config_suppression_ssl_server_keystore_location true
Suppress Configuration Validator: Zeppelin Server TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the Zeppelin Server 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 Configuration Validator: Zeppelin Server Advanced Configuration Snippet (Safety Valve) for zeppelin-conf/zeppelin-env.sh Whether to suppress configuration warnings produced by the Zeppelin Server Advanced Configuration Snippet (Safety Valve) for zeppelin-conf/zeppelin-env.sh configuration validator. false role_config_suppression_zeppelin-conf/zeppelin-env.sh_role_safety_valve true
Suppress Configuration Validator: Zeppelin Server Advanced Configuration Snippet (Safety Valve) for zeppelin-conf/zeppelin-site.xml Whether to suppress configuration warnings produced by the Zeppelin Server Advanced Configuration Snippet (Safety Valve) for zeppelin-conf/zeppelin-site.xml configuration validator. false role_config_suppression_zeppelin-conf/zeppelin-site.xml_role_safety_valve true
Suppress Configuration Validator: Admin Group Whether to suppress configuration warnings produced by the Admin Group configuration validator. false role_config_suppression_zeppelin.admin.group true
Suppress Configuration Validator: Zeppelin anonymous Whether to suppress configuration warnings produced by the Zeppelin anonymous configuration validator. false role_config_suppression_zeppelin.anonymous.allowed true
Suppress Configuration Validator: Zeppelin interpreter config location Whether to suppress configuration warnings produced by the Zeppelin interpreter config location configuration validator. false role_config_suppression_zeppelin.config.fs.dir true
Suppress Configuration Validator: Zeppelin config storage class Whether to suppress configuration warnings produced by the Zeppelin config storage class configuration validator. false role_config_suppression_zeppelin.config.storage.class true
Suppress Configuration Validator: Zeppelin Local repository location Whether to suppress configuration warnings produced by the Zeppelin Local repository location configuration validator. false role_config_suppression_zeppelin.dep.localrepo true
Suppress Configuration Validator: Zeppelin interpreter group order Whether to suppress configuration warnings produced by the Zeppelin interpreter group order configuration validator. false role_config_suppression_zeppelin.interpreter.group.order true
Suppress Configuration Validator: Zeppelin Local repository location Whether to suppress configuration warnings produced by the Zeppelin Local repository location configuration validator. false role_config_suppression_zeppelin.interpreter.localrepo true
Suppress Configuration Validator: Zeppelin notebook location Whether to suppress configuration warnings produced by the Zeppelin notebook location configuration validator. false role_config_suppression_zeppelin.notebook.dir true
Suppress Configuration Validator: Zeppelin notebook storage class Whether to suppress configuration warnings produced by the Zeppelin notebook storage class configuration validator. false role_config_suppression_zeppelin.notebook.storage true
Suppress Configuration Validator: Zeppelin Server Bind Address Whether to suppress configuration warnings produced by the Zeppelin Server Bind Address configuration validator. false role_config_suppression_zeppelin.server.addr true
Suppress Configuration Validator: Zeppelin shiro knox main block Whether to suppress configuration warnings produced by the Zeppelin shiro knox main block configuration validator. false role_config_suppression_zeppelin.shiro.knox.main.block true
Suppress Configuration Validator: Zeppelin shiro main block Whether to suppress configuration warnings produced by the Zeppelin shiro main block configuration validator. false role_config_suppression_zeppelin.shiro.main.block true
Suppress Configuration Validator: Zeppelin shiro main session block Whether to suppress configuration warnings produced by the Zeppelin shiro main session block configuration validator. false role_config_suppression_zeppelin.shiro.main.session.block true
Suppress Configuration Validator: Zeppelin shiro roles block Whether to suppress configuration warnings produced by the Zeppelin shiro roles block configuration validator. false role_config_suppression_zeppelin.shiro.roles.block true
Suppress Configuration Validator: Zeppelin shiro urls block Whether to suppress configuration warnings produced by the Zeppelin shiro urls block configuration validator. false role_config_suppression_zeppelin.shiro.urls.block true
Suppress Configuration Validator: Zeppelin shiro user block Whether to suppress configuration warnings produced by the Zeppelin shiro user block configuration validator. false role_config_suppression_zeppelin.shiro.user.block true
Suppress Configuration Validator: Zeppelin ssl client auth Whether to suppress configuration warnings produced by the Zeppelin ssl client auth configuration validator. false role_config_suppression_zeppelin.ssl.client.auth true
Suppress Configuration Validator: Zeppelin ssl keystore type Whether to suppress configuration warnings produced by the Zeppelin ssl keystore type configuration validator. false role_config_suppression_zeppelin.ssl.keystore.type true
Suppress Configuration Validator: Zeppelin ssl truststore type Whether to suppress configuration warnings produced by the Zeppelin ssl truststore type configuration validator. false role_config_suppression_zeppelin.ssl.truststore.type true
Suppress Configuration Validator: Zeppelin temp webapps directory Whether to suppress configuration warnings produced by the Zeppelin temp webapps directory configuration validator. false role_config_suppression_zeppelin.war.tempdir true
Suppress Configuration Validator: Zeppelin websocket text size Whether to suppress configuration warnings produced by the Zeppelin websocket text size configuration validator. false role_config_suppression_zeppelin.websocket.max.text.message.size true
Suppress Configuration Validator: Zeppelin Server Port Whether to suppress configuration warnings produced by the Zeppelin Server Port configuration validator. false role_config_suppression_zeppelin_server_port true
Suppress Configuration Validator: Zeppelin Server Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Zeppelin Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_zeppelin_server_role_env_safety_valve true
Suppress Configuration Validator: Zeppelin Server SSL Port Whether to suppress configuration warnings produced by the Zeppelin Server SSL Port configuration validator. false role_config_suppression_zeppelin_server_ssl_port 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 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: 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 Configuration Validator: Zeppelin Server Count Validator Whether to suppress configuration warnings produced by the Zeppelin Server Count Validator configuration validator. false service_config_suppression_zeppelin_server_count_validator true
Suppress Parameter Validation: Zeppelin Service Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Service Environment Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_zeppelin_service_env_safety_valve true
Suppress Health Test: Zeppelin Server Health Whether to suppress the results of the Zeppelin Server Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false service_health_suppression_zeppelin_zeppelin_zeppelin_server_health true

Zeppelin Server

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Zeppelin Server 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
Zeppelin Server Advanced Configuration Snippet (Safety Valve) for zeppelin-conf/zeppelin-env.sh For advanced use only. A string to be inserted into zeppelin-conf/zeppelin-env.sh for this role only. zeppelin-conf/zeppelin-env.sh_role_safety_valve false
Zeppelin Server Advanced Configuration Snippet (Safety Valve) for zeppelin-conf/zeppelin-site.xml For advanced use only. A string to be inserted into zeppelin-conf/zeppelin-site.xml for this role only. zeppelin-conf/zeppelin-site.xml_role_safety_valve false
Zeppelin Server 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. ZEPPELIN_SERVER_role_env_safety_valve false

Logs

Display Name Description Related Name Default Value API Name Required
Zeppelin Server Log Directory The log directory for log files of the role Zeppelin Server. log_dir /var/log/zeppelin log_dir false
Zeppelin Server Logging Threshold The minimum log level for Zeppelin Server logs INFO log_threshold false
Zeppelin Server Maximum Log File Backups The maximum number of rolled log files to keep for Zeppelin Server logs. Typically used by log4j or logback. 10 max_log_backup_index false
Zeppelin Server Max Log Size The maximum size, in megabytes, per log file for Zeppelin Server logs. Typically used by log4j or logback. 200 MiB max_log_size false

Monitoring

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
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
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 % zeppelin_server_fd_thresholds false
Zeppelin Server Host Health Test When computing the overall Zeppelin Server health, consider the host's health. true zeppelin_server_host_health_enabled false
Zeppelin Server Process Health Test Enables the health test that the Zeppelin Server's process state is consistent with the role configuration true zeppelin_server_scm_health_enabled false

Other

Display Name Description Related Name Default Value API Name Required
Admin Group Admin group for Zeppelin zeppelin.admin.group admins zeppelin.admin.group false
Zeppelin anonymous Anonymous user allowed by default zeppelin.anonymous.allowed false zeppelin.anonymous.allowed false
Zeppelin interpreter config location location of config file zeppelin.config.fs.dir file:///var/lib/zeppelin/conf zeppelin.config.fs.dir false
Zeppelin config storage class config persistence layer implementation zeppelin.config.storage.class org.apache.zeppelin.storage.FileSystemConfigStorage zeppelin.config.storage.class false
Zeppelin Local repository location Local repository for dependency loader zeppelin.dep.localrepo /var/lib/zeppelin/local-repo zeppelin.dep.localrepo false
Zeppelin interpreter group order Zeppelin interpreter group order zeppelin.interpreter.group.order livy, md, angular, sh, jdbc, spark zeppelin.interpreter.group.order false
Zeppelin Local repository location Local repository for interpreter's additional dependency loading zeppelin.interpreter.localRepo /var/lib/zeppelin/local-repo zeppelin.interpreter.localRepo false
Zeppelin notebook location path or URI for notebook persist zeppelin.notebook.dir file:///var/lib/zeppelin/notebook zeppelin.notebook.dir false
Zeppelin notebook public access Make notebook public by default when created, private otherwise zeppelin.notebook.public false zeppelin.notebook.public false
Zeppelin notebook storage class versioned notebook persistence layer implementation zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.FileSystemNotebookRepo zeppelin.notebook.storage false
Zeppelin Server Bind Address Zeppelin Server Bind Address zeppelin.server.addr 0.0.0.0 zeppelin.server.addr false
Zeppelin shiro knox main block Content of shiro knox main block zeppelin.shiro.knox.main.block krbRealm = org.apache.zeppelin.realm.kerberos.KerberosRealm krbRealm.principal=SPNEGO_PRINCIPAL krbRealm.keytab=KEYTAB_FILE krbRealm.nameRules=DEFAULT krbRealm.signatureSecretFile=CONF_DIR/http_secret krbRealm.tokenValidity=36000 krbRealm.cookieDomain=DOMAIN krbRealm.cookiePath=/ authc = org.apache.zeppelin.realm.kerberos.KerberosAuthenticationFilter zeppelin.shiro.knox.main.block false
Zeppelin shiro main block Content of main block zeppelin.shiro.main.block pamRealm=org.apache.zeppelin.realm.PamRealm pamRealm.service=sshd zeppelin.shiro.main.block false
Zeppelin shiro main session block Content of main session block zeppelin.shiro.main.session.block sessionManager = org.apache.shiro.web.session.mgt.DefaultWebSessionManager cookie = org.apache.shiro.web.servlet.SimpleCookie cookie.name = JSESSIONID cookie.httpOnly = true sessionManager.sessionIdCookie = $cookie securityManager.sessionManager = $sessionManager securityManager.sessionManager.globalSessionTimeout = 86400000 shiro.loginUrl = /api/login zeppelin.shiro.main.session.block false
Zeppelin shiro roles block Content of roles block zeppelin.shiro.roles.block zeppelin.shiro.roles.block false
Zeppelin shiro urls block Content of urls block zeppelin.shiro.urls.block /api/version = anon /api/interpreter/setting/restart/** = authc /api/interpreter/** = authc, roles[zeppelin_admin_group] /api/notebook-repositories/** = authc, roles[zeppelin_admin_group] /api/configurations/** = authc, roles[zeppelin_admin_group] /api/credential/** = authc, roles[zeppelin_admin_group] /api/admin/** = authc, roles[zeppelin_admin_group] /** = authc zeppelin.shiro.urls.block false
Zeppelin shiro user block Content of user block zeppelin.shiro.user.block zeppelin.shiro.user.block false
Zeppelin ssl client auth Should client authentication be used for SSL connections? zeppelin.ssl.client.auth false zeppelin.ssl.client.auth false
Zeppelin ssl keystore type The format of the given keystore (e.g. JKS or PKCS12) zeppelin.ssl.keystore.type jks zeppelin.ssl.keystore.type false
Zeppelin ssl truststore type The format of the given truststore (e.g. JKS or PKCS12). Defaults to the same type as the keystore type zeppelin.ssl.truststore.type jks zeppelin.ssl.truststore.type false
Zeppelin temp webapps directory Location of jetty temporary directory zeppelin.war.tempdir /var/lib/zeppelin/webapps zeppelin.war.tempdir false
Zeppelin websocket text size Size in characters of the maximum text message to be received by websocket. Defaults to 1024000 zeppelin.websocket.max.text.message.size 1024000 zeppelin.websocket.max.text.message.size false

Performance

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

Ports and Addresses

Display Name Description Related Name Default Value API Name Required
Zeppelin Server Port The port of the Zeppelin server zeppelin.server.port 8885 zeppelin_server_port false
Zeppelin Server SSL Port The SSL port of the Zeppelin server zeppelin.server.ssl.port 8886 zeppelin_server_ssl_port false

Resource Management

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

Security

Display Name Description Related Name Default Value API Name Required
Zeppelin Server 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 Zeppelin Server might connect to. This is used when Zeppelin Server 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. zeppelin.ssl.truststore.path ssl_client_truststore_location false
Zeppelin Server TLS/SSL Client Trust Store Password The password for the Zeppelin Server 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. zeppelin.ssl.truststore.password ssl_client_truststore_password false
Enable TLS/SSL for Zeppelin Server Encrypt communication between clients and Zeppelin Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). zeppelin.ssl false ssl_enabled false
Zeppelin Server 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 Zeppelin Server is acting as a TLS/SSL server. The keystore must be in JKS format. zeppelin.ssl.keystore.path ssl_server_keystore_location false
Zeppelin Server TLS/SSL Server JKS Keystore File Password The password for the Zeppelin Server JKS keystore file. zeppelin.ssl.keystore.password ssl_server_keystore_password false

Stacks Collection

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

Suppressions

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: Zeppelin Server Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Server Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Zeppelin Server Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Server 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: Zeppelin Server TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Server TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Zeppelin Server TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Server TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Zeppelin Server TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Server TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Zeppelin Server TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Server 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 Parameter Validation: Zeppelin Server Advanced Configuration Snippet (Safety Valve) for zeppelin-conf/zeppelin-env.sh Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Server Advanced Configuration Snippet (Safety Valve) for zeppelin-conf/zeppelin-env.sh parameter. false role_config_suppression_zeppelin-conf/zeppelin-env.sh_role_safety_valve true
Suppress Parameter Validation: Zeppelin Server Advanced Configuration Snippet (Safety Valve) for zeppelin-conf/zeppelin-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Server Advanced Configuration Snippet (Safety Valve) for zeppelin-conf/zeppelin-site.xml parameter. false role_config_suppression_zeppelin-conf/zeppelin-site.xml_role_safety_valve true
Suppress Parameter Validation: Admin Group Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin Group parameter. false role_config_suppression_zeppelin.admin.group true
Suppress Parameter Validation: Zeppelin anonymous Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin anonymous parameter. false role_config_suppression_zeppelin.anonymous.allowed true
Suppress Parameter Validation: Zeppelin interpreter config location Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin interpreter config location parameter. false role_config_suppression_zeppelin.config.fs.dir true
Suppress Parameter Validation: Zeppelin config storage class Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin config storage class parameter. false role_config_suppression_zeppelin.config.storage.class true
Suppress Parameter Validation: Zeppelin Local repository location Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Local repository location parameter. false role_config_suppression_zeppelin.dep.localrepo true
Suppress Parameter Validation: Zeppelin interpreter group order Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin interpreter group order parameter. false role_config_suppression_zeppelin.interpreter.group.order true
Suppress Parameter Validation: Zeppelin Local repository location Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Local repository location parameter. false role_config_suppression_zeppelin.interpreter.localrepo true
Suppress Parameter Validation: Zeppelin notebook location Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin notebook location parameter. false role_config_suppression_zeppelin.notebook.dir true
Suppress Parameter Validation: Zeppelin notebook storage class Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin notebook storage class parameter. false role_config_suppression_zeppelin.notebook.storage true
Suppress Parameter Validation: Zeppelin Server Bind Address Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Server Bind Address parameter. false role_config_suppression_zeppelin.server.addr true
Suppress Parameter Validation: Zeppelin shiro knox main block Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin shiro knox main block parameter. false role_config_suppression_zeppelin.shiro.knox.main.block true
Suppress Parameter Validation: Zeppelin shiro main block Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin shiro main block parameter. false role_config_suppression_zeppelin.shiro.main.block true
Suppress Parameter Validation: Zeppelin shiro main session block Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin shiro main session block parameter. false role_config_suppression_zeppelin.shiro.main.session.block true
Suppress Parameter Validation: Zeppelin shiro roles block Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin shiro roles block parameter. false role_config_suppression_zeppelin.shiro.roles.block true
Suppress Parameter Validation: Zeppelin shiro urls block Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin shiro urls block parameter. false role_config_suppression_zeppelin.shiro.urls.block true
Suppress Parameter Validation: Zeppelin shiro user block Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin shiro user block parameter. false role_config_suppression_zeppelin.shiro.user.block true
Suppress Parameter Validation: Zeppelin ssl client auth Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin ssl client auth parameter. false role_config_suppression_zeppelin.ssl.client.auth true
Suppress Parameter Validation: Zeppelin ssl keystore type Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin ssl keystore type parameter. false role_config_suppression_zeppelin.ssl.keystore.type true
Suppress Parameter Validation: Zeppelin ssl truststore type Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin ssl truststore type parameter. false role_config_suppression_zeppelin.ssl.truststore.type true
Suppress Parameter Validation: Zeppelin temp webapps directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin temp webapps directory parameter. false role_config_suppression_zeppelin.war.tempdir true
Suppress Parameter Validation: Zeppelin websocket text size Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin websocket text size parameter. false role_config_suppression_zeppelin.websocket.max.text.message.size true
Suppress Parameter Validation: Zeppelin Server Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Server Port parameter. false role_config_suppression_zeppelin_server_port true
Suppress Parameter Validation: Zeppelin Server Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Server Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_zeppelin_server_role_env_safety_valve true
Suppress Parameter Validation: Zeppelin Server SSL Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Server SSL Port parameter. false role_config_suppression_zeppelin_server_ssl_port 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_zeppelin_zeppelin_server_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_zeppelin_zeppelin_server_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_zeppelin_zeppelin_server_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_zeppelin_zeppelin_server_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_zeppelin_zeppelin_server_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_zeppelin_zeppelin_server_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_zeppelin_zeppelin_server_unexpected_exits true