Cloudera Data Science Workbench Properties in CDH 5.13.0
Role groups:
Application
Advanced
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Application Advanced Configuration Snippet (Safety Valve) for cdsw.properties | For advanced use only. A string to be inserted into cdsw.properties for this role only. | cdsw.properties_role_safety_valve | false | ||
Application 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. | CDSW_APPLICATION_role_env_safety_valve | false | ||
Automatically Restart Process | When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. | 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 |
Logs
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Application Log Directory | The log directory for log files of the role Application. | APPLICATION_MONITOR_LOG_DIR | /var/log/cdsw | log_dir | false |
Monitoring
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
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 % | cdsw_application_fd_thresholds | false | |
Application Host Health Test | When computing the overall Application health, consider the host's health. | true | cdsw_application_host_health_enabled | false | |
Application Process Health Test | Enables the health test that the Application's process state is consistent with the role configuration | true | cdsw_application_scm_health_enabled | false | |
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 | |
Process Swap Memory Thresholds | The health test thresholds on the swap memory usage of the process. | Warning: Any, 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:
|
[] | 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 |
Other
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Application Monitor Log File Backups | Maximum number of Application Monitor log files being stored for backups. | APPLICATION_MONITOR_LOG_BACKUP_COUNT | 5 | cdsw.application.monitor.log.backup_count | false |
Application Monitor Log Verbosity Level | Level of verbosity in Cloudera Data Science Workbench Application Monitor logs. | APPLICATION_MONITOR_LOG_LEVEL | INFO | cdsw.application.monitor.log.level | false |
Application Monitor Maximum Logs Size | The maximum log size per log file, for Cloudera Data Science Workbench Application Monitor logs. | APPLICATION_MONITOR_LOG_MAX_SIZE_MB | 2 GiB | cdsw.application.monitor.log.max_size | false |
Enable TLS | Enable and enforce HTTPS (TLS/SSL) access to the web application (optional). Both internal and external termination are supported. To enable internal termination, you must also set the TLS Certificate for Internal Termination and TLS Key for Internal Termination parameters. If these parameters are not set, terminate TLS using an external proxy. | TLS_ENABLE | cdsw.enable.tls.config | false | |
TLS Certificate for Internal Termination | Complete path to the certificate (in PEM format) used for internal TLS termination. Set the TLS Certificate for Internal Termination and TLS Key for Internal Termination parameters only if you are not terminating TLS externally. You must also set the Enable TLS property to enable and enforce termination. The certificate must include both DOMAIN and *.DOMAIN as hostnames. Self-signed certificates are not supported unless trusted fully by clients. Accepting an invalid certificate manually can cause connection failures for unknown subdomains. | TLS_CERT | cdsw.tls.cert.config | false | |
TLS Key for Internal Termination | Complete path to the private key (in PEM format) used for internal TLS termination. Set the TLS Certificate for Internal Termination and TLS Key for Internal Termination parameters only if you are not terminating TLS externally. You must also set the Enable TLS property to enable and enforce termination. | TLS_KEY | cdsw.tls.key.config | false | |
Graceful Shutdown Timeout | The timeout in milliseconds to wait for graceful shutdown to complete. | 10 minute(s) | graceful_stop_timeout | 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 |
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 |
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 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. | 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 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. | memory.soft_limit_in_bytes | -1 MiB | rm_memory_soft_limit | 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 Parameter Validation: Application Advanced Configuration Snippet (Safety Valve) for cdsw.properties | Whether to suppress configuration warnings produced by the built-in parameter validation for the Application Advanced Configuration Snippet (Safety Valve) for cdsw.properties parameter. | false | role_config_suppression_cdsw.properties_role_safety_valve | true | |
Suppress Parameter Validation: TLS Certificate for Internal Termination | Whether to suppress configuration warnings produced by the built-in parameter validation for the TLS Certificate for Internal Termination parameter. | false | role_config_suppression_cdsw.tls.cert.config | true | |
Suppress Parameter Validation: TLS Key for Internal Termination | Whether to suppress configuration warnings produced by the built-in parameter validation for the TLS Key for Internal Termination parameter. | false | role_config_suppression_cdsw.tls.key.config | true | |
Suppress Parameter Validation: Application Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Application Environment Advanced Configuration Snippet (Safety Valve) parameter. | false | role_config_suppression_cdsw_application_role_env_safety_valve | true | |
Suppress Parameter Validation: Application Log Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Application Log Directory parameter. | false | role_config_suppression_log_dir | 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 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_cdsw_cdsw_application_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_cdsw_cdsw_application_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_cdsw_cdsw_application_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_cdsw_cdsw_application_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_cdsw_cdsw_application_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_cdsw_cdsw_application_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_cdsw_cdsw_application_unexpected_exits | true |
Docker Daemon
Advanced
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Docker Daemon Advanced Configuration Snippet (Safety Valve) for cdsw.properties | For advanced use only. A string to be inserted into cdsw.properties for this role only. | cdsw.properties_role_safety_valve | false | ||
Docker Daemon 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. | CDSW_DOCKER_role_env_safety_valve | false | ||
Automatically Restart Process | When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. | 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 |
Monitoring
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
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 % | cdsw_docker_fd_thresholds | false | |
Docker Daemon Host Health Test | When computing the overall Docker Daemon health, consider the host's health. | true | cdsw_docker_host_health_enabled | false | |
Docker Daemon Process Health Test | Enables the health test that the Docker Daemon's process state is consistent with the role configuration | true | cdsw_docker_scm_health_enabled | false | |
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 | |
Process Swap Memory Thresholds | The health test thresholds on the swap memory usage of the process. | Warning: Any, 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:
|
[] | 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 |
Other
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Docker Block Device | Cloudera Data Science Workbench installer will format and mount Docker on each gateway host. Do not mount these block devices prior to installation. Every Cloudera Data Science Workbench gateway host must have one or more block devices with at least 500 GB dedicated to storage of Docker images. SSDs are strongly recommended. Use the full path, for instance "/dev/xvde". | DOCKER_BLOCK_DEVICES | cdsw.docker.devices.config | true | |
Docker Daemon Diagnostics Collection Timeout | The timeout in milliseconds to wait for diagnostics collection to complete. | 3 minute(s) | csd_role_diagnostics_timeout | false | |
Graceful Shutdown Timeout | The timeout in milliseconds to wait for graceful shutdown to complete. | 10 minute(s) | graceful_stop_timeout | 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 |
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 |
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 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. | 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 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. | memory.soft_limit_in_bytes | -1 MiB | rm_memory_soft_limit | 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 Parameter Validation: Docker Block Device | Whether to suppress configuration warnings produced by the built-in parameter validation for the Docker Block Device parameter. | false | role_config_suppression_cdsw.docker.devices.config | true | |
Suppress Parameter Validation: Docker Daemon Advanced Configuration Snippet (Safety Valve) for cdsw.properties | Whether to suppress configuration warnings produced by the built-in parameter validation for the Docker Daemon Advanced Configuration Snippet (Safety Valve) for cdsw.properties parameter. | false | role_config_suppression_cdsw.properties_role_safety_valve | true | |
Suppress Parameter Validation: Docker Daemon Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Docker Daemon Environment Advanced Configuration Snippet (Safety Valve) parameter. | false | role_config_suppression_cdsw_docker_role_env_safety_valve | 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 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_cdsw_cdsw_docker_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_cdsw_cdsw_docker_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_cdsw_cdsw_docker_host_health | 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_cdsw_cdsw_docker_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_cdsw_cdsw_docker_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_cdsw_cdsw_docker_unexpected_exits | true |
Master
Advanced
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Master Advanced Configuration Snippet (Safety Valve) for cdsw.properties | For advanced use only. A string to be inserted into cdsw.properties for this role only. | cdsw.properties_role_safety_valve | false | ||
Master 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. | CDSW_MASTER_role_env_safety_valve | false | ||
Automatically Restart Process | When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. | 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 |
Monitoring
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
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 % | cdsw_master_fd_thresholds | false | |
Master Host Health Test | When computing the overall Master health, consider the host's health. | true | cdsw_master_host_health_enabled | false | |
Master Process Health Test | Enables the health test that the Master's process state is consistent with the role configuration | true | cdsw_master_scm_health_enabled | false | |
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 | |
Process Swap Memory Thresholds | The health test thresholds on the swap memory usage of the process. | Warning: Any, 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:
|
[] | 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 |
Other
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Graceful Shutdown Timeout | The timeout in milliseconds to wait for graceful shutdown to complete. | 10 minute(s) | graceful_stop_timeout | 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 |
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 |
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 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. | 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 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. | memory.soft_limit_in_bytes | -1 MiB | rm_memory_soft_limit | 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 Parameter Validation: Master Advanced Configuration Snippet (Safety Valve) for cdsw.properties | Whether to suppress configuration warnings produced by the built-in parameter validation for the Master Advanced Configuration Snippet (Safety Valve) for cdsw.properties parameter. | false | role_config_suppression_cdsw.properties_role_safety_valve | true | |
Suppress Parameter Validation: Master Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Master Environment Advanced Configuration Snippet (Safety Valve) parameter. | false | role_config_suppression_cdsw_master_role_env_safety_valve | 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 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_cdsw_cdsw_master_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_cdsw_cdsw_master_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_cdsw_cdsw_master_host_health | 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_cdsw_cdsw_master_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_cdsw_cdsw_master_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_cdsw_cdsw_master_unexpected_exits | true |
Service_wide
Advanced
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Cloudera Data Science Workbench Service Advanced Configuration Snippet (Safety Valve) for cdsw.properties | For advanced use only, a string to be inserted into cdsw.properties. Applies to configurations of all roles in this service except client configuration. | cdsw.properties_service_safety_valve | false | ||
Cloudera Data Science Workbench 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. | CDSW_service_env_safety_valve | false | ||
System Group | The group that this service's processes should run as. | root | process_groupname | true | |
System User | The user that this service's processes should run as. | root | process_username | true |
Monitoring
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Application Role Health Test | When computing the overall CDSW health, consider Application's health | true | CDSW_CDSW_APPLICATION_health_enabled | false | |
Healthy Docker Daemon Monitoring Thresholds | The health test thresholds of the overall Docker Daemon health. The check returns "Concerning" health if the percentage of "Healthy" Docker Daemons falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Docker Daemons falls below the critical threshold. | Warning: 95.0 %, Critical: 70.0 % | CDSW_CDSW_DOCKER_healthy_thresholds | false | |
Master Role Health Test | When computing the overall CDSW health, consider Master's health | true | CDSW_CDSW_MASTER_health_enabled | false | |
Healthy Worker Monitoring Thresholds | The health test thresholds of the overall Worker health. The check returns "Concerning" health if the percentage of "Healthy" Workers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Workers falls below the critical threshold. | Warning: 95.0 %, Critical: 70.0 % | CDSW_CDSW_WORKER_healthy_thresholds | false | |
Enable CDSW Status | Enables or disables the health test. When disabled, the test does not run at all, nor generate health history. | true | CDSW_STATUS_HEALTH_test_enable | false | |
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:
|
[] | 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 |
Other
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Wildcard DNS Domain | Wildcard DNS domain configured to point to the master node. If the wildcard DNS entries are configured as cdsw.your_domain.com and *.cdsw.your_domain.com, then this property should be set to cdsw.your_domain.com. For more information on setting up a wildcard DNS subdomain, see the Cloudera Data Science Workbench Installation Guide. | DOMAIN | cdsw.domain.config | true | |
Enable GPU Support | If it is enabled, then GPU's will be available for use by the cluster. It will have no effect on a node that does not have GPU support. | NVIDIA_GPU_ENABLE | false | cdsw.enable.gpu.config | false |
HTTP Proxy | If your deployment is behind an HTTP proxy, set the HTTP_PROXY here in the form "http://host:port/" or "https://host:port/". | HTTP_PROXY | cdsw.http.proxy.config | false | |
HTTPS Proxy | If your deployment is behind an HTTPS proxy, set the HTTPS_PROXY here in the form "http://host:port/" or "https://host:port/". | HTTPS_PROXY | cdsw.https.proxy.config | false | |
Install Required Packages | If it is enabled, 'Prepare Node' command will install all the required package dependencies. See Installing and Upgrading Cloudera Data Science Workbench for the list of required packages. | cdsw.install.required.packages | true | cdsw.install.required.packages | false |
Master Node IPv4 Address | IPv4 address for the master node that is reachable from the worker nodes. Within an AWS VPC, MASTER_IP should be set to the internal IP of the master node; for instance, "10.251.50.12" corresponding to master node name of ip-10-251-50-12.ec2.internal. If left empty, CDSW will resolve the IP address of master node and use it. | MASTER_IP | cdsw.master.ip.config | false | |
No Proxy | Comma-separated list of hostnames that should be skipped from the proxy. These include 127.0.0.1, localhost, the value of MASTER_IP, and any private Docker registries and HTTP services inside the firewall that Cloudera Data Science Workbench users might want to access from the engines. | NO_PROXY | cdsw.no.proxy.config | false | |
NVIDIA GPU Driver Library Path | Absolute path to the directory containing the NVIDIA GPU drivers. For instructions on how to create this directory, see Cloudera Data Science Workbench documentation. | NVIDIA_LIBRARY_PATH | cdsw.nvidia.lib.path.config | false | |
SOCKS Proxy | If your deployment is behind a SOCKS proxy, set the ALL_PROXY here in the form "socks5://host:port". | ALL_PROXY | cdsw.socks.proxy.config | false | |
HBase Service | Name of the HBase service that this Cloudera Data Science Workbench service instance depends on | hbase_service | false | ||
HDFS Service | Name of the HDFS service that this Cloudera Data Science Workbench service instance depends on | hdfs_service | false | ||
Hive Service | Name of the Hive service that this Cloudera Data Science Workbench service instance depends on | hive_service | false | ||
Sentry Service | Name of the Sentry service that this Cloudera Data Science Workbench service instance depends on | sentry_service | false | ||
Solr Service | Name of the Solr service that this Cloudera Data Science Workbench service instance depends on | solr_service | false | ||
SPARK2_ON_YARN Service | Name of the SPARK2_ON_YARN service that this Cloudera Data Science Workbench service instance depends on | spark2_on_yarn_service | true | ||
YARN (MR2 Included) Service | Name of the YARN (MR2 Included) service that this Cloudera Data Science Workbench service instance depends on | yarn_service | true |
Suppressions
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Suppress Parameter Validation: Wildcard DNS Domain | Whether to suppress configuration warnings produced by the built-in parameter validation for the Wildcard DNS Domain parameter. | false | service_config_suppression_cdsw.domain.config | true | |
Suppress Parameter Validation: HTTP Proxy | Whether to suppress configuration warnings produced by the built-in parameter validation for the HTTP Proxy parameter. | false | service_config_suppression_cdsw.http.proxy.config | true | |
Suppress Parameter Validation: HTTPS Proxy | Whether to suppress configuration warnings produced by the built-in parameter validation for the HTTPS Proxy parameter. | false | service_config_suppression_cdsw.https.proxy.config | true | |
Suppress Parameter Validation: Master Node IPv4 Address | Whether to suppress configuration warnings produced by the built-in parameter validation for the Master Node IPv4 Address parameter. | false | service_config_suppression_cdsw.master.ip.config | true | |
Suppress Parameter Validation: No Proxy | Whether to suppress configuration warnings produced by the built-in parameter validation for the No Proxy parameter. | false | service_config_suppression_cdsw.no.proxy.config | true | |
Suppress Parameter Validation: NVIDIA GPU Driver Library Path | Whether to suppress configuration warnings produced by the built-in parameter validation for the NVIDIA GPU Driver Library Path parameter. | false | service_config_suppression_cdsw.nvidia.lib.path.config | true | |
Suppress Parameter Validation: Cloudera Data Science Workbench Service Advanced Configuration Snippet (Safety Valve) for cdsw.properties | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cloudera Data Science Workbench Service Advanced Configuration Snippet (Safety Valve) for cdsw.properties parameter. | false | service_config_suppression_cdsw.properties_service_safety_valve | true | |
Suppress Parameter Validation: SOCKS Proxy | Whether to suppress configuration warnings produced by the built-in parameter validation for the SOCKS Proxy parameter. | false | service_config_suppression_cdsw.socks.proxy.config | true | |
Suppress Configuration Validator: Application Count Validator | Whether to suppress configuration warnings produced by the Application Count Validator configuration validator. | false | service_config_suppression_cdsw_application_count_validator | true | |
Suppress Configuration Validator: Docker Daemon Count Validator | Whether to suppress configuration warnings produced by the Docker Daemon Count Validator configuration validator. | false | service_config_suppression_cdsw_docker_count_validator | true | |
Suppress Configuration Validator: Master Count Validator | Whether to suppress configuration warnings produced by the Master Count Validator configuration validator. | false | service_config_suppression_cdsw_master_count_validator | true | |
Suppress Parameter Validation: Cloudera Data Science Workbench Service Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cloudera Data Science Workbench Service Environment Advanced Configuration Snippet (Safety Valve) parameter. | false | service_config_suppression_cdsw_service_env_safety_valve | true | |
Suppress Configuration Validator: Worker Count Validator | Whether to suppress configuration warnings produced by the Worker Count Validator configuration validator. | false | service_config_suppression_cdsw_worker_count_validator | 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 Health Test: Application Health | Whether to suppress the results of the Application 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_cdsw_cdsw_cdsw_application_health | true | |
Suppress Health Test: Master Health | Whether to suppress the results of the Master 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_cdsw_cdsw_cdsw_master_health | true | |
Suppress Health Test: Docker Daemon Health | Whether to suppress the results of the Docker Daemon 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_cdsw_cdsw_docker_healthy | true | |
Suppress Health Test: Worker Health | Whether to suppress the results of the Worker 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_cdsw_cdsw_worker_healthy | true | |
Suppress Health Test: CDSW Status | Whether to suppress the results of the CDSW 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 | service_health_suppression_cdsw_status_health | true |
Worker
Advanced
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Worker Advanced Configuration Snippet (Safety Valve) for cdsw.properties | For advanced use only. A string to be inserted into cdsw.properties for this role only. | cdsw.properties_role_safety_valve | false | ||
Worker 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. | CDSW_WORKER_role_env_safety_valve | false | ||
Automatically Restart Process | When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. | 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 |
Monitoring
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
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 % | cdsw_worker_fd_thresholds | false | |
Worker Host Health Test | When computing the overall Worker health, consider the host's health. | true | cdsw_worker_host_health_enabled | false | |
Worker Process Health Test | Enables the health test that the Worker's process state is consistent with the role configuration | true | cdsw_worker_scm_health_enabled | false | |
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 | |
Process Swap Memory Thresholds | The health test thresholds on the swap memory usage of the process. | Warning: Any, 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:
|
[] | 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 |
Other
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Graceful Shutdown Timeout | The timeout in milliseconds to wait for graceful shutdown to complete. | 10 minute(s) | graceful_stop_timeout | 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 |
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 |
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 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. | 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 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. | memory.soft_limit_in_bytes | -1 MiB | rm_memory_soft_limit | 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 Parameter Validation: Worker Advanced Configuration Snippet (Safety Valve) for cdsw.properties | Whether to suppress configuration warnings produced by the built-in parameter validation for the Worker Advanced Configuration Snippet (Safety Valve) for cdsw.properties parameter. | false | role_config_suppression_cdsw.properties_role_safety_valve | true | |
Suppress Parameter Validation: Worker Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Worker Environment Advanced Configuration Snippet (Safety Valve) parameter. | false | role_config_suppression_cdsw_worker_role_env_safety_valve | 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 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_cdsw_cdsw_worker_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_cdsw_cdsw_worker_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_cdsw_cdsw_worker_host_health | 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_cdsw_cdsw_worker_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_cdsw_cdsw_worker_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_cdsw_cdsw_worker_unexpected_exits | true |