Schema Registry Properties in Cloudera Runtime 7.1

Role groups:

Schema Registry Server

Advanced

Schema Registry Server XML Override

Description
For advanced use only, replace entire XML in the logback configuration file for Schema Registry Server, ignoring all logging configuration.
Related Name
logback_safety_valve
Default Value
API Name
logback_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, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role.
Related Name
oom_heap_dump_dir
Default Value
/tmp
API Name
oom_heap_dump_dir
Required
false

Dump Heap When Out of Memory

Description
When set, generates 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

Schema Registry Server Advanced Configuration Snippet (Safety Valve) for registry.yaml

Description
For advanced use only. A string to be inserted into registry.yaml for this role only.
Related Name
Default Value
API Name
registry.yaml_role_safety_valve
Required
false

Schema Registry 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
SCHEMA_REGISTRY_SERVER_role_env_safety_valve
Required
false

Logs

Schema Registry Server Log Directory

Description
The log directory for log files of the role Schema Registry Server.
Related Name
log_dir
Default Value
/var/log/schemaregistry
API Name
log_dir
Required
false

Schema Registry Server Logging Threshold

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

Schema Registry Server Maximum Log File Backups

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

Schema Registry Server Max Log Size

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

Monitoring

Enable Health Alerts for this Role

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

Enable Configuration Change Alerts

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

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

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
schema_registry_server_fd_thresholds
Required
false

Schema Registry Server Host Health Test

Description
When computing the overall Schema Registry Server health, consider the host's health.
Related Name
Default Value
true
API Name
schema_registry_server_host_health_enabled
Required
false

Schema Registry Server Process Health Test

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

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

Schema Registry Admin Port

Description
The admin port for the server.
Related Name
schema.registry.adminPort
Default Value
7789
API Name
schema.registry.adminPort
Required
true

Schema Registry Allowed Resources

Description
Allowed resources for Schema Registry.
Related Name
schema.registry.allowed.resources
Default Value
401.html, back-default.png, favicon.ico
API Name
schema.registry.allowed.resources
Required
false

Schema Version Cache Expiry Interval

Description
Schema version cache expiry interval.
Related Name
schema.registry.cache.expiry.interval
Default Value
3600
API Name
schema.registry.cache.expiry.interval
Required
true

Schema Registry Cache Size

Description
Schema Registry cache size.
Related Name
schema.registry.cache.size
Default Value
1000
API Name
schema.registry.cache.size
Required
true

Password For HTTP Proxy Server Username

Description
Password For HTTP Proxy Server Username.
Related Name
schema.registry.httpProxyPassword
Default Value
API Name
schema.registry.httpProxyPassword
Required
false

HTTP Proxy Server

Description
URL for http proxy server. Please enter it in format protocol_name://host_name:port_number.
Related Name
schema.registry.httpProxyServer
Default Value
API Name
schema.registry.httpProxyServer
Required
false

HTTP Proxy Server Availability

Description
Boolean to set if HTTP Proxy Server is available or not.
Related Name
schema.registry.httpProxyServer.available
Default Value
false
API Name
schema.registry.httpProxyServer.available
Required
false

Username For HTTP Proxy Server

Description
Username for http proxy server.
Related Name
schema.registry.httpProxyUsername
Default Value
API Name
schema.registry.httpProxyUsername
Required
false

Schema Registry Jar Storage Directory Path

Description
Jar storage directory path.
Related Name
schema.registry.jar.storage.directory.path
Default Value
/tmp/schema-registry/local-jars
API Name
schema.registry.jar.storage.directory.path
Required
false

Schema Registry Jar Storage HDFS URL

Description
URL of the directory to be used for storing jars on HDFS when HDFS is not selected as an optional dependency.
Related Name
schema.registry.jar.storage.hdfs.url
Default Value
hdfs://localhost:8020
API Name
schema.registry.jar.storage.hdfs.url
Required
false

Schema Registry Jar Storage Type

Description
Jar storage type for storing jars on the local filesystem or on HDFS. If 'hdfs' is set but HDFS is not selected as an optional dependency, please provide a value for the 'Schema Registry Jar Storage HDFS URL' property.
Related Name
schema.registry.jar.storage.type
Default Value
local
API Name
schema.registry.jar.storage.type
Required
false

Java Home Path Override

Description
Java home path override for Schema Registry.
Related Name
schema.registry.jdk.home
Default Value
API Name
schema.registry.jdk.home
Required
false

Schema Registry Kerberos Name Rules

Description
Kerberos name rules for Schema Registry.
Related Name
schema.registry.kerberos.name.rules
Default Value
RULE:[2:$1@$0]([jt]t@.*EXAMPLE.COM)s/.*/$MAPRED_USER/ RULE:[2:$1@$0]([nd]n@.*EXAMPLE.COM)s/.*/$HDFS_USER/DEFAULT
API Name
schema.registry.kerberos.name.rules
Required
false

Schema Registry Kerberos Non Browser User Agents

Description
Non browser user agents if kerberos is enabled.
Related Name
schema.registry.kerberos.non.browser.user.agents
Default Value
API Name
schema.registry.kerberos.non.browser.user.agents
Required
false

Schema Registry Port

Description
The port on which server accepts connections.
Related Name
schema.registry.port
Default Value
7788
API Name
schema.registry.port
Required
true

Schema Registry Servlet Filter

Description
Schema Registry servlet filter class.
Related Name
schema.registry.servlet.filter
Default Value
com.hortonworks.registries.auth.server.AuthenticationFilter
API Name
schema.registry.servlet.filter
Required
true

Schema Registry Admin Port (SSL)

Description
HTTPS admin port Schema Registry node runs on when SSL is enabled.
Related Name
schema.registry.ssl.adminPort
Default Value
7791
API Name
schema.registry.ssl.adminPort
Required
false

SSL Keystore Type

Description
The keystore type. It is blank by default but required if schema registry's ssl is enabled. e.g. PKCS12 or JKS.
Related Name
schema.registry.ssl.keyStoreType
Default Value
jks
API Name
schema.registry.ssl.keyStoreType
Required
false

Schema Registry Port (SSL)

Description
HTTPS port Schema Registry node runs on when SSL is enabled.
Related Name
schema.registry.ssl.port
Default Value
7790
API Name
schema.registry.ssl.port
Required
false

SSL TrustStore Type

Description
The truststore type. It is blank by default but required if schema registry's ssl is enabled. e.g. PKCS12 or JKS.
Related Name
schema.registry.ssl.trustStoreType
Default Value
jks
API Name
schema.registry.ssl.trustStoreType
Required
false

SSL ValidateCerts

Description
Whether or not to validate TLS certificates before starting. If enabled, it will refuse to start with expired or otherwise invalid certificates.
Related Name
schema.registry.ssl.validateCerts
Default Value
false
API Name
schema.registry.ssl.validateCerts
Required
false

SSL ValidatePeers

Description
Whether or not to validate TLS peer certificates.
Related Name
schema.registry.ssl.validatePeers
Default Value
false
API Name
schema.registry.ssl.validatePeers
Required
false

Schema Registry Query Timeout

Description
Schema Registry query timeout.
Related Name
schema.registry.storage.query.timeout
Default Value
30 second(s)
API Name
schema.registry.storage.query.timeout
Required
true

Schema Registry Token Validity

Description
Kerberos token validity for Schema Registry in ms.
Related Name
schema.registry.token.validity
Default Value
36000
API Name
schema.registry.token.validity
Required
false

Schema Registry Log Max Backup Index

Description
The number of backup files.
Related Name
schema_registry_log_maxbackupindex
Default Value
20
API Name
schema_registry_log_maxbackupindex
Required
false

Schema Registry Log Max File Size

Description
The maximum size of backup file before the log is rotated.
Related Name
schema_registry_log_maxfilesize
Default Value
256MB
API Name
schema_registry_log_maxfilesize
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

Resource Management

Cgroup CPU Shares

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

Custom Control Group Resources (overrides Cgroup settings)

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

Cgroup I/O Weight

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

Cgroup Memory Hard Limit

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

Cgroup Memory Soft Limit

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

Security

Schema Registry Server TLS/SSL Trust Store File

Description
The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Schema Registry Server might connect to. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead.
Related Name
schema.registry.ssl.trustStorePath
Default Value
API Name
ssl_client_truststore_location
Required
false

Schema Registry Server TLS/SSL Trust Store Password

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

Enable TLS/SSL for Schema Registry Server

Description
Encrypt communication between clients and Schema Registry Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name
ssl.enable
Default Value
false
API Name
ssl_enabled
Required
false

Schema Registry 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 Schema Registry Server is acting as a TLS/SSL server. The keystore must be in JKS format.
Related Name
schema.registry.ssl.keyStorePath
Default Value
API Name
ssl_server_keystore_location
Required
false

Schema Registry Server TLS/SSL Server JKS Keystore File Password

Description
The password for the Schema Registry Server JKS keystore file.
Related Name
schema.registry.ssl.keyStorePassword
Default Value
API Name
ssl_server_keystore_password
Required
false

Stacks Collection

Stacks Collection Data Retention

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

Stacks Collection Directory

Description
The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name
stacks_collection_directory
Default Value
API Name
stacks_collection_directory
Required
false

Stacks Collection Enabled

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

Stacks Collection Frequency

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

Stacks Collection Method

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

Suppressions

Suppress Configuration Validator: CDH Version Validator

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

Suppress Parameter Validation: Schema Registry Server Log Directory

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

Suppress Parameter Validation: Schema Registry Server XML Override

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Server XML Override parameter.
Related Name
Default Value
false
API Name
role_config_suppression_logback_safety_valve
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: Schema Registry Server Advanced Configuration Snippet (Safety Valve) for registry.yaml

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Server Advanced Configuration Snippet (Safety Valve) for registry.yaml parameter.
Related Name
Default Value
false
API Name
role_config_suppression_registry.yaml_role_safety_valve
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: Schema Registry Admin Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Admin Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.adminport
Required
true

Suppress Parameter Validation: Schema Registry Allowed Resources

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Allowed Resources parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.allowed.resources
Required
true

Suppress Parameter Validation: Password For HTTP Proxy Server Username

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Password For HTTP Proxy Server Username parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.httpproxypassword
Required
true

Suppress Parameter Validation: HTTP Proxy Server

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the HTTP Proxy Server parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.httpproxyserver
Required
true

Suppress Parameter Validation: Username For HTTP Proxy Server

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Username For HTTP Proxy Server parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.httpproxyusername
Required
true

Suppress Parameter Validation: Schema Registry Jar Storage Directory Path

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Jar Storage Directory Path parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.jar.storage.directory.path
Required
true

Suppress Parameter Validation: Schema Registry Jar Storage HDFS URL

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Jar Storage HDFS URL parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.jar.storage.hdfs.url
Required
true

Suppress Parameter Validation: Java Home Path Override

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Home Path Override parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.jdk.home
Required
true

Suppress Parameter Validation: Schema Registry Kerberos Name Rules

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Kerberos Name Rules parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.kerberos.name.rules
Required
true

Suppress Parameter Validation: Schema Registry Kerberos Non Browser User Agents

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Kerberos Non Browser User Agents parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.kerberos.non.browser.user.agents
Required
true

Suppress Parameter Validation: Schema Registry Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.port
Required
true

Suppress Parameter Validation: Schema Registry Servlet Filter

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Servlet Filter parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.servlet.filter
Required
true

Suppress Parameter Validation: Schema Registry Admin Port (SSL)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Admin Port (SSL) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.ssl.adminport
Required
true

Suppress Parameter Validation: SSL Keystore Type

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL Keystore Type parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.ssl.keystoretype
Required
true

Suppress Parameter Validation: Schema Registry Port (SSL)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Port (SSL) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.ssl.port
Required
true

Suppress Parameter Validation: SSL TrustStore Type

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL TrustStore Type parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.ssl.truststoretype
Required
true

Suppress Parameter Validation: SSL ValidateCerts

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL ValidateCerts parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.ssl.validatecerts
Required
true

Suppress Parameter Validation: SSL ValidatePeers

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL ValidatePeers parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.ssl.validatepeers
Required
true

Suppress Parameter Validation: Schema Registry Log Max Backup Index

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Log Max Backup Index parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema_registry_log_maxbackupindex
Required
true

Suppress Parameter Validation: Schema Registry Log Max File Size

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Log Max File Size parameter.
Related Name
Default Value
false
API Name
role_config_suppression_schema_registry_log_maxfilesize
Required
true

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

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

Suppress Parameter Validation: Schema Registry Server TLS/SSL Trust Store File

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

Suppress Parameter Validation: Schema Registry Server TLS/SSL Trust Store Password

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

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

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry 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: Schema Registry Server TLS/SSL Server JKS Keystore File Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry 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_schemaregistry_schema_registry_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_schemaregistry_schema_registry_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_schemaregistry_schema_registry_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_schemaregistry_schema_registry_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_schemaregistry_schema_registry_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_schemaregistry_schema_registry_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_schemaregistry_schema_registry_server_unexpected_exits
Required
true

Service-Wide

Advanced

System Group

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

System User

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

Schema Registry 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
SCHEMAREGISTRY_service_env_safety_valve
Required
false

Database

Schema Registry Database Host

Description
Hostname of the database used by Schema Registry. If the port is non-default for your database type, use host:port notation.
Related Name
schema.registry.storage.connector.host
Default Value
localhost
API Name
database_host
Required
true

Schema Registry Database Name

Description
Name of Schema Registry database.
Related Name
schema.registry.storage.connector.name
Default Value
schemaregistry
API Name
database_name
Required
true

Schema Registry Database User Password

Description
Password for Schema Registry database.
Related Name
schema.registry.storage.connector.password
Default Value
API Name
database_password
Required
true

Schema Registry Database Port

Description
Port for Schema Registry database.
Related Name
schema.registry.storage.connector.port
Default Value
3306
API Name
database_port
Required
true

Schema Registry Database Type

Description
Database type to be used (postgres).
Related Name
schema.registry.storage.connector.type
Default Value
mysql
API Name
database_type
Required
true

Schema Registry Database User

Description
User for Schema Registry database.
Related Name
schema.registry.storage.connector.user
Default Value
schemaregistry
API Name
database_user
Required
true

Monitoring

Enable Service Level Health Alerts

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

Enable Configuration Change Alerts

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

Healthy Schema Registry Server Monitoring Thresholds

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

Service Triggers

Description
The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific service.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger fires if there are more than 10 DataNodes with more than 500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad", "streamThreshold": 10, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
Related Name
Default Value
[]
API Name
service_triggers
Required
true

Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

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

Other

Enable Kerberos Authentication

Description
Enables Kerberos authentication for this Schema Registry service.
Related Name
kerberos.auth.enable
Default Value
false
API Name
kerberos.auth.enable
Required
false

Suppressions

Suppress Configuration Validator: CDH Version Validator

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

Suppress Configuration Validator: Schema Registry Server Log Directory

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

Suppress Configuration Validator: Schema Registry Server XML Override

Description
Whether to suppress configuration warnings produced by the Schema Registry Server XML Override configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_logback_safety_valve
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: Schema Registry Server Advanced Configuration Snippet (Safety Valve) for registry.yaml

Description
Whether to suppress configuration warnings produced by the Schema Registry Server Advanced Configuration Snippet (Safety Valve) for registry.yaml configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_registry.yaml_role_safety_valve
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: Schema Registry Admin Port

Description
Whether to suppress configuration warnings produced by the Schema Registry Admin Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.adminport
Required
true

Suppress Configuration Validator: Schema Registry Allowed Resources

Description
Whether to suppress configuration warnings produced by the Schema Registry Allowed Resources configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.allowed.resources
Required
true

Suppress Configuration Validator: Password For HTTP Proxy Server Username

Description
Whether to suppress configuration warnings produced by the Password For HTTP Proxy Server Username configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.httpproxypassword
Required
true

Suppress Configuration Validator: HTTP Proxy Server

Description
Whether to suppress configuration warnings produced by the HTTP Proxy Server configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.httpproxyserver
Required
true

Suppress Configuration Validator: Username For HTTP Proxy Server

Description
Whether to suppress configuration warnings produced by the Username For HTTP Proxy Server configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.httpproxyusername
Required
true

Suppress Configuration Validator: Schema Registry Jar Storage Directory Path

Description
Whether to suppress configuration warnings produced by the Schema Registry Jar Storage Directory Path configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.jar.storage.directory.path
Required
true

Suppress Configuration Validator: Schema Registry Jar Storage HDFS URL

Description
Whether to suppress configuration warnings produced by the Schema Registry Jar Storage HDFS URL configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.jar.storage.hdfs.url
Required
true

Suppress Configuration Validator: Java Home Path Override

Description
Whether to suppress configuration warnings produced by the Java Home Path Override configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.jdk.home
Required
true

Suppress Configuration Validator: Schema Registry Kerberos Name Rules

Description
Whether to suppress configuration warnings produced by the Schema Registry Kerberos Name Rules configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.kerberos.name.rules
Required
true

Suppress Configuration Validator: Schema Registry Kerberos Non Browser User Agents

Description
Whether to suppress configuration warnings produced by the Schema Registry Kerberos Non Browser User Agents configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.kerberos.non.browser.user.agents
Required
true

Suppress Configuration Validator: Schema Registry Port

Description
Whether to suppress configuration warnings produced by the Schema Registry Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.port
Required
true

Suppress Configuration Validator: Schema Registry Servlet Filter

Description
Whether to suppress configuration warnings produced by the Schema Registry Servlet Filter configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.servlet.filter
Required
true

Suppress Configuration Validator: Schema Registry Admin Port (SSL)

Description
Whether to suppress configuration warnings produced by the Schema Registry Admin Port (SSL) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.ssl.adminport
Required
true

Suppress Configuration Validator: SSL Keystore Type

Description
Whether to suppress configuration warnings produced by the SSL Keystore Type configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.ssl.keystoretype
Required
true

Suppress Configuration Validator: Schema Registry Port (SSL)

Description
Whether to suppress configuration warnings produced by the Schema Registry Port (SSL) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.ssl.port
Required
true

Suppress Configuration Validator: SSL TrustStore Type

Description
Whether to suppress configuration warnings produced by the SSL TrustStore Type configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.ssl.truststoretype
Required
true

Suppress Configuration Validator: SSL ValidateCerts

Description
Whether to suppress configuration warnings produced by the SSL ValidateCerts configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.ssl.validatecerts
Required
true

Suppress Configuration Validator: SSL ValidatePeers

Description
Whether to suppress configuration warnings produced by the SSL ValidatePeers configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema.registry.ssl.validatepeers
Required
true

Suppress Configuration Validator: Schema Registry Log Max Backup Index

Description
Whether to suppress configuration warnings produced by the Schema Registry Log Max Backup Index configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema_registry_log_maxbackupindex
Required
true

Suppress Configuration Validator: Schema Registry Log Max File Size

Description
Whether to suppress configuration warnings produced by the Schema Registry Log Max File Size configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_schema_registry_log_maxfilesize
Required
true

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

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

Suppress Configuration Validator: Schema Registry Server TLS/SSL Trust Store File

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

Suppress Configuration Validator: Schema Registry Server TLS/SSL Trust Store Password

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

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

Description
Whether to suppress configuration warnings produced by the Schema Registry 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: Schema Registry Server TLS/SSL Server JKS Keystore File Password

Description
Whether to suppress configuration warnings produced by the Schema Registry 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 Parameter Validation: Schema Registry Database Host

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Database Host parameter.
Related Name
Default Value
false
API Name
service_config_suppression_database_host
Required
true

Suppress Parameter Validation: Schema Registry Database Name

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Database Name parameter.
Related Name
Default Value
false
API Name
service_config_suppression_database_name
Required
true

Suppress Parameter Validation: Schema Registry Database User Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Database User Password parameter.
Related Name
Default Value
false
API Name
service_config_suppression_database_password
Required
true

Suppress Parameter Validation: Schema Registry Database Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Database Port parameter.
Related Name
Default Value
false
API Name
service_config_suppression_database_port
Required
true

Suppress Parameter Validation: Schema Registry Database User

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Database User parameter.
Related Name
Default Value
false
API Name
service_config_suppression_database_user
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 Configuration Validator: Schema Registry Server Count Validator

Description
Whether to suppress configuration warnings produced by the Schema Registry Server Count Validator configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_schema_registry_server_count_validator
Required
true

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

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Service Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
service_config_suppression_schemaregistry_service_env_safety_valve
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: Schema Registry Server Health

Description
Whether to suppress the results of the Schema Registry 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_schemaregistry_schema_registry_server_healthy
Required
true