Atlas Properties in Cloudera Runtime 7.2.x

Role groups:

Atlas Server

Advanced

Atlas Server Environment Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration.
Related Name
Default Value
API Name: ATLAS_SERVER_role_env_safety_valve
Required: false

Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/atlas-application.properties

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

Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-audit.xml

Description: For advanced use only. A string to be inserted into conf/ranger-atlas-audit.xml for this role only.
Related Name
Default Value
API Name: conf/ranger-atlas-audit.xml_role_safety_valve
Required: false

Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-policymgr-ssl.xml

Description: For advanced use only. A string to be inserted into conf/ranger-atlas-policymgr-ssl.xml for this role only.
Related Name
Default Value
API Name: conf/ranger-atlas-policymgr-ssl.xml_role_safety_valve
Required: false

Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-security.xml

Description: For advanced use only. A string to be inserted into conf/ranger-atlas-security.xml for this role only.
Related Name
Default Value
API Name: conf/ranger-atlas-security.xml_role_safety_valve
Required: false

Atlas Server Logging Advanced Configuration Snippet (Safety Valve)

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

Heap Dump Directory

Description: Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, 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.
Related Name: oom_heap_dump_dir
Default Value: /tmp
API Name: oom_heap_dump_dir
Required: false

Dump Heap When Out of Memory

Description: When set, generates heap dump file when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value: true
API Name: oom_heap_dump_enabled
Required: true

Kill When Out of Memory

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

Automatically Restart Process

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

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

Logs

Atlas Server Log Directory

Description: The log directory for log files of the role Atlas Server.
Related Name: atlas.log.base.dir
Default Value: /var/log/atlas
API Name: log_dir
Required: false

Atlas Server Logging Threshold

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

Atlas Server Maximum Log File Backups

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

Atlas Server Max Log Size

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

Monitoring

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: atlas_server_fd_thresholds
Required: false

Atlas Server Host Health Test

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

Atlas Server Process Health Test

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

Enable Health Alerts for this Role

Description: When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

Description: When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value: false
API Name: enable_config_alerts
Required: false

Log Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: log_directory_free_space_absolute_thresholds
Required: false

Log Directory Free Space Monitoring Percentage Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: log_directory_free_space_percentage_thresholds
Required: false

Metric Filter

Description

Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:

Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
Metric Name - The name of a metric that will be included or excluded during metric collection.

If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:

Include only Health Test Metric Set: Selected.
Include/Exclude Custom Metrics: Set to Include.
Metric Name: jvm_heap_used_mb

You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:

{
  "includeHealthTestMetricSet": true, 
  "filterType": "whitelist",
  "metrics": ["jvm_heap_used_mb"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

Role Triggers

Description

The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:

triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
triggerExpression (mandatory) - A tsquery expression representing the trigger.
streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.

For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:

[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad",
  "streamThreshold": 0, "enabled": "true"}]

See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: unexpected_exits_thresholds
Required: false

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Related Name
Default Value: 5 minute(s)
API Name: unexpected_exits_window
Required: false

Other

Admin Password

Description: Password for the Atlas Admin user configured in property atlas.admin.username with default value named "admin". Password should be minimum 8 characters with minimum one alphabet and one numeric. Unsupported special characters are " ' \ ` ´.
Related Name: atlas.admin.password
Default Value
API Name: atlas_admin_password
Required: false

Admin Username

Description: Admin Login user.
Related Name: atlas.admin.username
Default Value: admin
API Name: atlas_admin_username
Required: false

Audit ZooKeeper Session Timeout

Description: Audit ZooKeeper Session Timeout
Related Name: atlas.audit.zookeeper.session.timeout.ms
Default Value: 1 minute(s)
API Name: atlas_audit_zookeeper_session_timeout_ms
Required: false

Enable File Authentication

Description: Whether file-based authentication is enabled.
Related Name: atlas.authentication.method.file
Default Value: false
API Name: atlas_authentication_method_file
Required: false

Path to Credentials for File-based Login.

Description: Path to Credentials for File-based Login
Related Name: atlas.authentication.method.file.filename
Default Value: ATLAS_USER_CREDENTIALS_CONF_PATH/users-credentials.properties
API Name: atlas_authentication_method_file_filename
Required: false

Enable LDAP Authentication

Description: Whether LDAP is used for authentication.
Related Name: atlas.authentication.method.ldap
Default Value: false
API Name: atlas_authentication_method_ldap
Required: false

AD Base DN

Description: The Distinguished Name (DN) of the starting point for directory server searches.
Related Name: atlas.authentication.method.ldap.ad.base.dn
Default Value
API Name: atlas_authentication_method_ldap_ad_base_dn
Required: false

AD Bind DN Username

Description: Full distinguished name (DN), including common name (CN), of an LDAP user account that has privileges to search.
Related Name: atlas.authentication.method.ldap.ad.bind.dn
Default Value
API Name: atlas_authentication_method_ldap_ad_bind_dn
Required: false

AD Bind DN Password

Description: Password for the account that can search
Related Name: atlas.authentication.method.ldap.ad.bind.password
Default Value
API Name: atlas_authentication_method_ldap_ad_bind_password
Required: false

AD User Default Role

Description: AD User default Role
Related Name: atlas.authentication.method.ldap.ad.default.role
Default Value: ROLE_USER
API Name: atlas_authentication_method_ldap_ad_default_role
Required: false

AD Domain Name (Only for AD)

Description: AD domain, only used if Authentication method is AD
Related Name: atlas.authentication.method.ldap.ad.domain
Default Value
API Name: atlas_authentication_method_ldap_ad_domain
Required: false

AD Referral

Description: This parameter is only used if Authentication method is AD. Set to follow if multiple ADsss servers are configured to return continuation references for results. Set to ignore (default) if no referrals should be followed. When this parameter is set to throw, all of the normal entries are returned in the enumeration first, before the ReferralException is thrown.
Related Name: atlas.authentication.method.ldap.ad.referral
Default Value: ignore
API Name: atlas_authentication_method_ldap_ad_referral
Required: false

AD URL

Description: AD URL, only used if Authentication method is AD
Related Name: atlas.authentication.method.ldap.ad.url
Default Value
API Name: atlas_authentication_method_ldap_ad_url
Required: false

AD User Search Filter

Description: AD User Search Filter
Related Name: atlas.authentication.method.ldap.ad.user.searchfilter
Default Value: (sAMAccountName=0)
API Name: atlas_authentication_method_ldap_ad_user_searchfilter
Required: false

LDAP DN

Description: The Distinguished Name (DN) of the starting point for directory server searches.
Related Name: atlas.authentication.method.ldap.base.dn
Default Value
API Name: atlas_authentication_method_ldap_base_dn
Required: false

LDAP Bind DN Username

Description: Full distinguished name (DN), including common name (CN), of an LDAP user account that has privileges to search.
Related Name: atlas.authentication.method.ldap.bind.dn
Default Value
API Name: atlas_authentication_method_ldap_bind_dn
Required: false

LDAP Bind DN Password

Description: Password for the account that can search in LDAP
Related Name: atlas.authentication.method.ldap.bind.password
Default Value
API Name: atlas_authentication_method_ldap_bind_password
Required: false

LDAP User Default Role

Description: LDAP User Default Role
Related Name: atlas.authentication.method.ldap.default.role
Default Value: ROLE_USER
API Name: atlas_authentication_method_ldap_default_role
Required: false

LDAP Group-Role Attribute

Description: LDAP Group-Role Attribute
Related Name: atlas.authentication.method.ldap.groupRoleAttribute
Default Value: cn
API Name: atlas_authentication_method_ldap_groupRoleAttribute
Required: false

LDAP Group-Search Base

Description: LDAP Group-Search Base
Related Name: atlas.authentication.method.ldap.groupSearchBase
Default Value
API Name: atlas_authentication_method_ldap_groupSearchBase
Required: false

LDAP Group-Search Filter

Description: LDAP Group-Search Filter
Related Name: atlas.authentication.method.ldap.groupSearchFilter
Default Value
API Name: atlas_authentication_method_ldap_groupSearchFilter
Required: false

LDAP Referral

Description: This parameter is only used if Authentication method is LDAP. Set to follow if multiple LDAP servers are configured to return continuation references for results. Set to ignore (default) if no referrals should be followed. When this parameter is set to throw, all of the normal entries are returned in the enumeration first, before the ReferralException is thrown.
Related Name: atlas.authentication.method.ldap.referral
Default Value: ignore
API Name: atlas_authentication_method_ldap_referral
Required: false

LDAP Authentication Type

Description: The LDAP type (ldap, ad, or none).
Related Name: atlas.authentication.method.ldap.type
Default Value: none
API Name: atlas_authentication_method_ldap_type
Required: false

LDAP UGI Groups

Description: LDAP UGI Groups
Related Name: atlas.authentication.method.ldap.ugi-groups
Default Value: false
API Name: atlas_authentication_method_ldap_ugi_groups
Required: false

LDAP Server URL

Description: LDAP Server URL. Sample values = ldap://localhost:389 or ldaps://localhost:636
Related Name: atlas.authentication.method.ldap.url
Default Value
API Name: atlas_authentication_method_ldap_url
Required: false

LDAP User Search Filter

Description: LDAP User Search Filter
Related Name: atlas.authentication.method.ldap.user.searchfilter
Default Value
API Name: atlas_authentication_method_ldap_user_searchfilter
Required: false

User DN Pattern

Description: User DN Pattern. This pattern is used to create a distinguished name (DN) for a user during login
Related Name: atlas.authentication.method.ldap.userDNpattern
Default Value: uid=
API Name: atlas_authentication_method_ldap_userDNpattern
Required: false

Enable PAM Authentication

Description: Whether PAM is used for authentication.
Related Name: atlas.authentication.method.pam
Default Value: true
API Name: atlas_authentication_method_pam
Required: false

Enable Knox Trusted Proxy Support

Description: Determine if the Atlas service should allow authentication using Knox trusted proxy.
Related Name: atlas.authentication.method.trustedproxy
Default Value: true
API Name: atlas_authentication_method_trustedproxy
Required: false

Kafka Zookeeper Connection Timeout

Description: Kafka Zookeeper Connection Timeout
Related Name: atlas.kafka.zookeeper.connection.timeout.ms
Default Value: 30 second(s)
API Name: atlas_kafka_zookeeper_connection_timeout_ms
Required: false

Kafka ZooKeeper Session Timeout

Description: Kafka ZooKeeper Session Timeout
Related Name: atlas.kafka.zookeeper.session.timeout.ms
Default Value: 1 minute(s)
API Name: atlas_kafka_zookeeper_session_timeout_ms
Required: false

Kafka ZooKeeper Sync Time

Description: Kafka ZooKeeper Sync Time
Related Name: atlas.kafka.zookeeper.sync.time.ms
Default Value: 20 millisecond(s)
API Name: atlas_kafka_zookeeper_sync_time_ms
Required: false

Atlas Max Heapsize

Description: Maximum size for the Java Process heap. Passed to Java -Xmx. Measured in megabytes.
Related Name: atlas_max_heap_size
Default Value: 2 GiB
API Name: atlas_max_heap_size
Required: true

Knox Proxy User Groups

Description: Accepts a list of group names. The Knox user can impersonate only the users that belong to the groups specified in the list. The wildcard value * may be used to allow impersonation of any user belonging to any group.
Related Name: atlas.proxyuser.knox.groups
Default Value: *
API Name: atlas_proxyuser_knox_groups
Required: false

Knox Proxy User Hosts

Description: Accepts a list of IP addresses, IP addressranges in CIDR format and/or host names. The Knox user can impersonate only the requests coming from hosts specified in the list. The wildcard value * may be used to allow impersonation from any host.
Related Name: atlas.proxyuser.knox.hosts
Default Value: *
API Name: atlas_proxyuser_knox_hosts
Required: false

Knox Proxy User Users

Description: Accepts a list of usernames. The Knox user can impersonate only the users specified in the list. The wildcard value * may be used to allow impersonation of any user.
Related Name: atlas.proxyuser.knox.users
Default Value: *
API Name: atlas_proxyuser_knox_users
Required: false

Proxy Users

Description: Atlas service can be proxied through Knox, hence need to configure the proxy users using which Atlas service can be proxied
Related Name: atlas.proxyusers
Default Value
API Name: atlas_proxyusers
Required: false

Server Bind Address

Description: The Server will bind to this address.
Related Name: atlas.server.bind.address
Default Value: 0.0.0.0
API Name: atlas_server_bind_address
Required: false

Simple Authz policy file

Description: Path for the Simple Authz Policies File.
Related Name: atlas.simple.authz.policy.file
Default Value: ATLAS_SIMPLE_AUTHZ_POLICY_CONF_PATH/atlas-simple-authz-policy.json
API Name: atlas_simple_authz_policy_file
Required: false

Initial Solr Replication Factor for Collections

Description: Solr Replication Factor for Collections. This only affects the initial setting and has no effect once Atlas has started for the first time.
Related Name: atlas_solr_replication_factor
Default Value: 1
API Name: atlas_solr_replication_factor
Required: false

Initial Solr Shards for Atlas Collections

Description: Solr Shards for Collections. This only affects the initial setting and has no effect once Atlas has started for the first time.
Related Name: atlas_solr_shards
Default Value: 1
API Name: atlas_solr_shards
Required: false

Excluded Wire Encryption Protocols

Description: A comma-separated list of the wire encryption protocols to exclude when TLS is enabled. Some versions of cURL do not work with TLSv1.2.
Related Name: atlas.ssl.exclude.protocols
Default Value: TLSv1.2
API Name: atlas_ssl_exclude_protocols
Required: false

Knox SSO browser User-Agent

Description: Knox SSO browser User-Agent
Related Name: atlas.sso.knox.browser.useragent
Default Value
API Name: atlas_sso_knox_browser_useragent
Required: false

Enable Knox SSO

Description: Enable Knox SSO
Related Name: atlas.sso.knox.enabled
Default Value: false
API Name: atlas_sso_knox_enabled
Required: false

Knox SSO provider URL

Description: Knox SSO provider URL.
Related Name: atlas.sso.knox.providerurl
Default Value
API Name: atlas_sso_knox_providerurl
Required: false

Knox SSO Public-Key

Description: Knox SSO Public-Key
Related Name: atlas.sso.knox.publicKey
Default Value
API Name: atlas_sso_knox_publicKey
Required: false

Atlas Server Diagnostics Collection Timeout

Description: The timeout in milliseconds to wait for diagnostics collection to complete.
Related Name
Default Value: 5 minute(s)
API Name: csd_role_diagnostics_timeout
Required: false

Kafka Message Retention Time

Description: The maximum time for retaining Kafka messages for topic ATLAS_HOOK. If set to -1, no time limit will be applied. This configuration will be only effective for pre-start initialization of Atlas service and ineffective once the ATLAS_HOOK topic is created for Atlas.
Related Name: retention.ms
Default Value: 31 day(s)
API Name: kafka_message_retention_ms
Required: false

Ranger Atlas Plugin Audit Hdfs Spool Directory Path

Description: Spool directory for Ranger audits being written to DFS.
Related Name: xasecure.audit.destination.hdfs.batch.filespool.dir
Default Value: /var/log/atlas/audit/hdfs/spool
API Name: ranger_atlas_plugin_hdfs_audit_spool_directory
Required: true

Ranger Atlas Plugin Policy Cache Directory Path

Description: The directory where Ranger security policies are cached locally.
Related Name: ranger.plugin.atlas.policy.cache.dir
Default Value: /var/lib/ranger/atlas/policy-cache
API Name: ranger_atlas_plugin_policy_cache_directory
Required: true

Ranger Atlas Plugin Audit Solr Spool Directory Path

Description: Spool directory for Ranger audits being written to Solr.
Related Name: xasecure.audit.destination.solr.batch.filespool.dir
Default Value: /var/log/atlas/audit/solr/spool
API Name: ranger_atlas_plugin_solr_audit_spool_directory
Required: true

Ranger Plugin Trusted Proxy IP Address

Description: Accepts a list of IP addresses of proxy servers for trusting.
Related Name: ranger.plugin.atlas.trusted.proxy.ipaddress
Default Value
API Name: ranger_plugin_trusted_proxy_ipaddress
Required: false

Ranger Plugin Use X-Forwarded For IP Address

Description: The parameter is used for identifying the originating IP address of a user connecting to a component through proxy for audit logs.
Related Name: ranger.plugin.atlas.use.x-forwarded-for.ipaddress
Default Value: false
API Name: ranger_plugin_use_x_forwarded_for_ipaddress
Required: false

Performance

Maximum Process File Descriptors

Description: If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value.
Related Name
Default Value
API Name: rlimit_fds
Required: false

Ports and Addresses

Server HTTP port

Description: Server HTTP port
Related Name: atlas.server.http.port
Default Value: 31000
API Name: atlas_server_http_port
Required: false

Server HTTPS Port

Description: Server HTTPS Port
Related Name: atlas.server.https.port
Default Value: 31443
API Name: atlas_server_https_port
Required: false

Resource Management

Cgroup CPU Shares

Description: Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup I/O Weight

Description: Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager.
Related Name: blkio.weight
Default Value: 500
API Name: rm_io_weight
Required: true

Cgroup Memory Hard Limit

Description: Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may end the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit
Required: true

Cgroup Memory Soft Limit

Description: Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may end the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit
Required: true

Security

Atlas Server TLS/SSL Client Trust Store File

Description: The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Atlas Server might connect to. This is used when Atlas 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.
Related Name: truststore.file
Default Value
API Name: ssl_client_truststore_location
Required: false

Atlas Server TLS/SSL Client Trust Store Password

Description: The password for the Atlas 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.
Related Name: truststore.password
Default Value
API Name: ssl_client_truststore_password
Required: false

Enable TLS/SSL for Atlas Server

Description: Encrypt communication between clients and Atlas Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name: atlas.enableTLS
Default Value: false
API Name: ssl_enabled
Required: false

Atlas Server TLS/SSL Server JKS Keystore Key Password

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

Atlas Server TLS/SSL Server JKS Keystore File Location

Description: The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Atlas Server is acting as a TLS/SSL server. The keystore must be in JKS format.
Related Name: keystore.file
Default Value
API Name: ssl_server_keystore_location
Required: false

Atlas Server TLS/SSL Server JKS Keystore File Password

Description: The password for the Atlas Server JKS keystore file.
Related Name: keystore.password
Default Value
API Name: ssl_server_keystore_password
Required: false

Stacks Collection

Stacks Collection Data Retention

Description: The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name: stacks_collection_data_retention
Default Value: 100 MiB
API Name: stacks_collection_data_retention
Required: false

Stacks Collection Directory

Description: The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory.
Related Name: stacks_collection_directory
Default Value
API Name: stacks_collection_directory
Required: false

Stacks Collection Enabled

Description: Whether or not periodic stacks collection is enabled.
Related Name: stacks_collection_enabled
Default Value: false
API Name: stacks_collection_enabled
Required: true

Stacks Collection Frequency

Description: The frequency with which stacks are collected.
Related Name: stacks_collection_frequency
Default Value: 5.0 second(s)
API Name: stacks_collection_frequency
Required: false

Stacks Collection Method

Description: The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped.
Related Name: stacks_collection_method
Default Value: jstack
API Name: stacks_collection_method
Required: false

Suppressions

Suppress Parameter Validation: Admin Password

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

Suppress Parameter Validation: Admin Username

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

Suppress Parameter Validation: Path to Credentials for File-based Login.

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Path to Credentials for File-based Login. parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_file_filename
Required: true

Suppress Parameter Validation: AD Base DN

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the AD Base DN parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_ad_base_dn
Required: true

Suppress Parameter Validation: AD Bind DN Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the AD Bind DN Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_ad_bind_dn
Required: true

Suppress Parameter Validation: AD Bind DN Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the AD Bind DN Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_ad_bind_password
Required: true

Suppress Parameter Validation: AD User Default Role

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the AD User Default Role parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_ad_default_role
Required: true

Suppress Parameter Validation: AD Domain Name (Only for AD)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the AD Domain Name (Only for AD) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_ad_domain
Required: true

Suppress Parameter Validation: AD URL

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

Suppress Parameter Validation: AD User Search Filter

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the AD User Search Filter parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_ad_user_searchfilter
Required: true

Suppress Parameter Validation: LDAP DN

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

Suppress Parameter Validation: LDAP Bind DN Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Bind DN Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_bind_dn
Required: true

Suppress Parameter Validation: LDAP Bind DN Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Bind DN Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_bind_password
Required: true

Suppress Parameter Validation: LDAP User Default Role

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP User Default Role parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_default_role
Required: true

Suppress Parameter Validation: LDAP Group-Role Attribute

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Group-Role Attribute parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_grouproleattribute
Required: true

Suppress Parameter Validation: LDAP Group-Search Base

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Group-Search Base parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_groupsearchbase
Required: true

Suppress Parameter Validation: LDAP Group-Search Filter

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Group-Search Filter parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_groupsearchfilter
Required: true

Suppress Parameter Validation: LDAP Server URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Server URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_url
Required: true

Suppress Parameter Validation: LDAP User Search Filter

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP User Search Filter parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_user_searchfilter
Required: true

Suppress Parameter Validation: User DN Pattern

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the User DN Pattern parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_userdnpattern
Required: true

Suppress Parameter Validation: Atlas Max Heapsize

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Atlas Max Heapsize parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_max_heap_size
Required: true

Suppress Parameter Validation: Knox Proxy User Groups

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Proxy User Groups parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_proxyuser_knox_groups
Required: true

Suppress Parameter Validation: Knox Proxy User Hosts

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Proxy User Hosts parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_proxyuser_knox_hosts
Required: true

Suppress Parameter Validation: Knox Proxy User Users

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Proxy User Users parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_proxyuser_knox_users
Required: true

Suppress Parameter Validation: Proxy Users

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

Suppress Parameter Validation: Server Bind Address

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Server Bind Address parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_server_bind_address
Required: true

Suppress Parameter Validation: Server HTTP port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Server HTTP port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_server_http_port
Required: true

Suppress Parameter Validation: Server HTTPS Port

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

Suppress Parameter Validation: Atlas Server Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Simple Authz policy file

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Simple Authz policy file parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_simple_authz_policy_file
Required: true

Suppress Parameter Validation: Excluded Wire Encryption Protocols

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Excluded Wire Encryption Protocols parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_ssl_exclude_protocols
Required: true

Suppress Parameter Validation: Knox SSO browser User-Agent

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox SSO browser User-Agent parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_sso_knox_browser_useragent
Required: true

Suppress Parameter Validation: Knox SSO provider URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox SSO provider URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_sso_knox_providerurl
Required: true

Suppress Parameter Validation: Knox SSO Public-Key

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox SSO Public-Key parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_sso_knox_publickey
Required: true

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/atlas-application.properties

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/atlas-application.properties parameter.
Related Name
Default Value: false
API Name: role_config_suppression_conf/atlas-application.properties_role_safety_valve
Required: true

Suppress Parameter Validation: Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-audit.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-audit.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_conf/ranger-atlas-audit.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-policymgr-ssl.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-policymgr-ssl.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_conf/ranger-atlas-policymgr-ssl.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-security.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-security.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_conf/ranger-atlas-security.xml_role_safety_valve
Required: true

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

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

Suppress Parameter Validation: Atlas Server Log Directory

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

Suppress Parameter Validation: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Parameter Validation: Ranger Atlas Plugin Audit Hdfs Spool Directory Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Atlas Plugin Audit Hdfs Spool Directory Path parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ranger_atlas_plugin_hdfs_audit_spool_directory
Required: true

Suppress Parameter Validation: Ranger Atlas Plugin Policy Cache Directory Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Atlas Plugin Policy Cache Directory Path parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ranger_atlas_plugin_policy_cache_directory
Required: true

Suppress Parameter Validation: Ranger Atlas Plugin Audit Solr Spool Directory Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Atlas Plugin Audit Solr Spool Directory Path parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ranger_atlas_plugin_solr_audit_spool_directory
Required: true

Suppress Parameter Validation: Ranger Plugin Trusted Proxy IP Address

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Plugin Trusted Proxy IP Address parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ranger_plugin_trusted_proxy_ipaddress
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: Role Triggers

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

Suppress Parameter Validation: Atlas Server TLS/SSL Client Trust Store File

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

Suppress Parameter Validation: Atlas Server TLS/SSL Client Trust Store Password

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

Suppress Parameter Validation: Atlas Server TLS/SSL Server JKS Keystore Key Password

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

Suppress Parameter Validation: Atlas Server TLS/SSL Server JKS Keystore File Location

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

Suppress Parameter Validation: Atlas Server TLS/SSL Server JKS Keystore File Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Atlas Server TLS/SSL Server JKS Keystore File Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_password
Required: true

Suppress Parameter Validation: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Health Test: Audit Pipeline Test

Description: Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_atlas_atlas_server_audit_health
Required: true

Suppress Health Test: File Descriptors

Description: Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_atlas_atlas_server_file_descriptor
Required: true

Suppress Health Test: Host Health

Description: Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_atlas_atlas_server_host_health
Required: true

Suppress Health Test: Log Directory Free Space

Description: Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_atlas_atlas_server_log_directory_free_space
Required: true

Suppress Health Test: Process Status

Description: Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_atlas_atlas_server_scm_health
Required: true

Suppress Health Test: Swap Memory Usage

Description: Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_atlas_atlas_server_swap_memory_usage
Required: true

Suppress Health Test: Unexpected Exits

Description: Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_atlas_atlas_server_unexpected_exits
Required: true

Gateway

Advanced

Atlas Client Advanced Configuration Snippet (Safety Valve) for atlas-conf/atlas-client.properties

Description: For advanced use only, a string to be inserted into the client configuration for atlas-conf/atlas-client.properties.
Related Name
Default Value
API Name: atlas-conf/atlas-client.properties_client_config_safety_valve
Required: false

Deploy Directory

Description: The directory where the client configs will be deployed
Related Name
Default Value: /etc/atlas
API Name: client_config_root_dir
Required: true

Monitoring

Enable Configuration Change Alerts

Description: When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value: false
API Name: enable_config_alerts
Required: false

Other

Alternatives Priority

Description: The priority level that the client configuration will have in the Alternatives system on the hosts. Higher priority levels will cause Alternatives to prefer this configuration over any others.
Related Name
Default Value: 50
API Name: client_config_priority
Required: true

Security

Gateway TLS/SSL Client Trust Store File

Description: The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Gateway might connect to. This is used when Gateway is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead.
Related Name: atlas.kafka.ssl.truststore.location
Default Value
API Name: ssl_client_truststore_location
Required: false

Gateway TLS/SSL Client Trust Store Password

Description: The password for the Gateway TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information.
Related Name: atlas.kafka.ssl.truststore.password
Default Value
API Name: ssl_client_truststore_password
Required: false

Suppressions

Suppress Parameter Validation: Atlas Client Advanced Configuration Snippet (Safety Valve) for atlas-conf/atlas-client.properties

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Atlas Client Advanced Configuration Snippet (Safety Valve) for atlas-conf/atlas-client.properties parameter.
Related Name
Default Value: false
API Name: role_config_suppression_atlas-conf/atlas-client.properties_client_config_safety_valve
Required: true

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Deploy Directory

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

Suppress Parameter Validation: Gateway TLS/SSL Client Trust Store File

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

Suppress Parameter Validation: Gateway TLS/SSL Client Trust Store Password

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

Service-Wide

Advanced

Atlas Service Environment Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: ATLAS_service_env_safety_valve
Required: false

System Group

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

System User

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

Monitoring

Healthy Atlas Server Monitoring Thresholds

Description: The health test thresholds of the overall Atlas Server health. The check returns "Concerning" health if the percentage of "Healthy" Atlas Servers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Atlas Servers falls below the critical threshold.
Related Name
Default Value: Warning: 99.0 %, Critical: 90.0 %
API Name: ATLAS_ATLAS_SERVER_healthy_thresholds
Required: false

Enable Service Level Health Alerts

Description: When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

Description: When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value: false
API Name: enable_config_alerts
Required: false

Service Triggers

Description

The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:

triggerName (mandatory) - The name of the trigger. This value must be unique for the specific service.
triggerExpression (mandatory) - A tsquery expression representing the trigger.
streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.

For example, the following JSON formatted trigger fires if there are more than 10 DataNodes with more than 500 file descriptors opened:

[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad",
  "streamThreshold": 10, "enabled": "true"}]

Related Name

Default Value

[]

API Name

service_triggers

Required

true

Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones.
Related Name
Default Value
API Name: smon_derived_configs_safety_valve
Required: false

Other

HBase Service

Description: Name of the HBase service that this Atlas service instance depends on
Related Name
Default Value
API Name: hbase_service
Required: true

HDFS Service

Description: Name of the HDFS service that this Atlas service instance depends on
Related Name
Default Value
API Name: hdfs_service
Required: true

KAFKA Service

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

Enable Kerberos Authentication

Description: Indicates whether Kerberos is enabled.
Related Name: atlas.authentication.method.kerberos
Default Value: false
API Name: kerberos.auth.enable
Required: false

Ranger Atlas Plugin Hdfs Audit Directory

Description: The DFS path on which Ranger audits are written.
Related Name: ranger_atlas_plugin_hdfs_audit_directory
Default Value: $ranger_base_audit_url/atlas
API Name: ranger_atlas_plugin_hdfs_audit_directory
Required: false

RANGER Service

Description: Name of the RANGER service that this Atlas service instance depends on
Related Name
Default Value
API Name: ranger_service
Required: false

Solr Service

Description: Name of the Solr service that this Atlas service instance depends on
Related Name
Default Value
API Name: solr_service
Required: true

Suppressions

Suppress Configuration Validator: Atlas Client Advanced Configuration Snippet (Safety Valve) for atlas-conf/atlas-client.properties

Description: Whether to suppress configuration warnings produced by the Atlas Client Advanced Configuration Snippet (Safety Valve) for atlas-conf/atlas-client.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas-conf/atlas-client.properties_client_config_safety_valve
Required: true

Suppress Configuration Validator: Admin Password

Description: Whether to suppress configuration warnings produced by the Admin Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_admin_password
Required: true

Suppress Configuration Validator: Admin Username

Description: Whether to suppress configuration warnings produced by the Admin Username configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_admin_username
Required: true

Suppress Configuration Validator: Path to Credentials for File-based Login.

Description: Whether to suppress configuration warnings produced by the Path to Credentials for File-based Login. configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_file_filename
Required: true

Suppress Configuration Validator: AD Base DN

Description: Whether to suppress configuration warnings produced by the AD Base DN configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_ad_base_dn
Required: true

Suppress Configuration Validator: AD Bind DN Username

Description: Whether to suppress configuration warnings produced by the AD Bind DN Username configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_ad_bind_dn
Required: true

Suppress Configuration Validator: AD Bind DN Password

Description: Whether to suppress configuration warnings produced by the AD Bind DN Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_ad_bind_password
Required: true

Suppress Configuration Validator: AD User Default Role

Description: Whether to suppress configuration warnings produced by the AD User Default Role configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_ad_default_role
Required: true

Suppress Configuration Validator: AD Domain Name (Only for AD)

Description: Whether to suppress configuration warnings produced by the AD Domain Name (Only for AD) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_ad_domain
Required: true

Suppress Configuration Validator: AD URL

Description: Whether to suppress configuration warnings produced by the AD URL configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_ad_url
Required: true

Suppress Configuration Validator: AD User Search Filter

Description: Whether to suppress configuration warnings produced by the AD User Search Filter configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_ad_user_searchfilter
Required: true

Suppress Configuration Validator: LDAP DN

Description: Whether to suppress configuration warnings produced by the LDAP DN configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_base_dn
Required: true

Suppress Configuration Validator: LDAP Bind DN Username

Description: Whether to suppress configuration warnings produced by the LDAP Bind DN Username configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_bind_dn
Required: true

Suppress Configuration Validator: LDAP Bind DN Password

Description: Whether to suppress configuration warnings produced by the LDAP Bind DN Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_bind_password
Required: true

Suppress Configuration Validator: LDAP User Default Role

Description: Whether to suppress configuration warnings produced by the LDAP User Default Role configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_default_role
Required: true

Suppress Configuration Validator: LDAP Group-Role Attribute

Description: Whether to suppress configuration warnings produced by the LDAP Group-Role Attribute configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_grouproleattribute
Required: true

Suppress Configuration Validator: LDAP Group-Search Base

Description: Whether to suppress configuration warnings produced by the LDAP Group-Search Base configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_groupsearchbase
Required: true

Suppress Configuration Validator: LDAP Group-Search Filter

Description: Whether to suppress configuration warnings produced by the LDAP Group-Search Filter configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_groupsearchfilter
Required: true

Suppress Configuration Validator: LDAP Server URL

Description: Whether to suppress configuration warnings produced by the LDAP Server URL configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_url
Required: true

Suppress Configuration Validator: LDAP User Search Filter

Description: Whether to suppress configuration warnings produced by the LDAP User Search Filter configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_user_searchfilter
Required: true

Suppress Configuration Validator: User DN Pattern

Description: Whether to suppress configuration warnings produced by the User DN Pattern configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_authentication_method_ldap_userdnpattern
Required: true

Suppress Configuration Validator: Atlas Max Heapsize

Description: Whether to suppress configuration warnings produced by the Atlas Max Heapsize configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_max_heap_size
Required: true

Suppress Configuration Validator: Knox Proxy User Groups

Description: Whether to suppress configuration warnings produced by the Knox Proxy User Groups configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_proxyuser_knox_groups
Required: true

Suppress Configuration Validator: Knox Proxy User Hosts

Description: Whether to suppress configuration warnings produced by the Knox Proxy User Hosts configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_proxyuser_knox_hosts
Required: true

Suppress Configuration Validator: Knox Proxy User Users

Description: Whether to suppress configuration warnings produced by the Knox Proxy User Users configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_proxyuser_knox_users
Required: true

Suppress Configuration Validator: Proxy Users

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

Suppress Configuration Validator: Server Bind Address

Description: Whether to suppress configuration warnings produced by the Server Bind Address configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_server_bind_address
Required: true

Suppress Configuration Validator: Server HTTP port

Description: Whether to suppress configuration warnings produced by the Server HTTP port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_server_http_port
Required: true

Suppress Configuration Validator: Server HTTPS Port

Description: Whether to suppress configuration warnings produced by the Server HTTPS Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_server_https_port
Required: true

Suppress Configuration Validator: Atlas Server Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Configuration Validator: Simple Authz policy file

Description: Whether to suppress configuration warnings produced by the Simple Authz policy file configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_simple_authz_policy_file
Required: true

Suppress Configuration Validator: Excluded Wire Encryption Protocols

Description: Whether to suppress configuration warnings produced by the Excluded Wire Encryption Protocols configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_ssl_exclude_protocols
Required: true

Suppress Configuration Validator: Knox SSO browser User-Agent

Description: Whether to suppress configuration warnings produced by the Knox SSO browser User-Agent configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_sso_knox_browser_useragent
Required: true

Suppress Configuration Validator: Knox SSO provider URL

Description: Whether to suppress configuration warnings produced by the Knox SSO provider URL configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_sso_knox_providerurl
Required: true

Suppress Configuration Validator: Knox SSO Public-Key

Description: Whether to suppress configuration warnings produced by the Knox SSO Public-Key configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_atlas_sso_knox_publickey
Required: true

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Configuration Validator: Deploy Directory

Description: Whether to suppress configuration warnings produced by the Deploy Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_client_config_root_dir
Required: true

Suppress Configuration Validator: Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/atlas-application.properties

Description: Whether to suppress configuration warnings produced by the Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/atlas-application.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_conf/atlas-application.properties_role_safety_valve
Required: true

Suppress Configuration Validator: Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-audit.xml

Description: Whether to suppress configuration warnings produced by the Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-audit.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_conf/ranger-atlas-audit.xml_role_safety_valve
Required: true

Suppress Configuration Validator: Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-policymgr-ssl.xml

Description: Whether to suppress configuration warnings produced by the Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-policymgr-ssl.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_conf/ranger-atlas-policymgr-ssl.xml_role_safety_valve
Required: true

Suppress Configuration Validator: Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-security.xml

Description: Whether to suppress configuration warnings produced by the Atlas Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-atlas-security.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_conf/ranger-atlas-security.xml_role_safety_valve
Required: true

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

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

Suppress Configuration Validator: Atlas Server Log Directory

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

Suppress Configuration Validator: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Configuration Validator: Ranger Atlas Plugin Audit Hdfs Spool Directory Path

Description: Whether to suppress configuration warnings produced by the Ranger Atlas Plugin Audit Hdfs Spool Directory Path configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ranger_atlas_plugin_hdfs_audit_spool_directory
Required: true

Suppress Configuration Validator: Ranger Atlas Plugin Policy Cache Directory Path

Description: Whether to suppress configuration warnings produced by the Ranger Atlas Plugin Policy Cache Directory Path configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ranger_atlas_plugin_policy_cache_directory
Required: true

Suppress Configuration Validator: Ranger Atlas Plugin Audit Solr Spool Directory Path

Description: Whether to suppress configuration warnings produced by the Ranger Atlas Plugin Audit Solr Spool Directory Path configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ranger_atlas_plugin_solr_audit_spool_directory
Required: true

Suppress Configuration Validator: Ranger Plugin Trusted Proxy IP Address

Description: Whether to suppress configuration warnings produced by the Ranger Plugin Trusted Proxy IP Address configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ranger_plugin_trusted_proxy_ipaddress
Required: true

Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Configuration Validator: Role Triggers

Description: Whether to suppress configuration warnings produced by the Role Triggers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Configuration Validator: Atlas Server TLS/SSL Client Trust Store File

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

Suppress Configuration Validator: Atlas Server TLS/SSL Client Trust Store Password

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

Suppress Configuration Validator: Atlas Server TLS/SSL Server JKS Keystore Key Password

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

Suppress Configuration Validator: Atlas Server TLS/SSL Server JKS Keystore File Location

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

Suppress Configuration Validator: Atlas Server TLS/SSL Server JKS Keystore File Password

Description: Whether to suppress configuration warnings produced by the Atlas Server TLS/SSL Server JKS Keystore File Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_password
Required: true

Suppress Configuration Validator: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Configuration Validator: Atlas Server Count Validator

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

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

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

Suppress Configuration Validator: Gateway Count Validator

Description: Whether to suppress configuration warnings produced by the Gateway Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_gateway_count_validator
Required: true

Suppress Parameter Validation: System Group

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

Suppress Parameter Validation: System User

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

Suppress Parameter Validation: Ranger Atlas Plugin Hdfs Audit Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Atlas Plugin Hdfs Audit Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_atlas_plugin_hdfs_audit_directory
Required: true

Suppress Parameter Validation: Service Triggers

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

Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: service_config_suppression_smon_derived_configs_safety_valve
Required: true

Suppress Health Test: Atlas Server Health

Description: Whether to suppress the results of the Atlas Server Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: service_health_suppression_atlas_atlas_server_healthy
Required: true