Schema Registry Properties in Cloudera Runtime 7.1.2
Role groups:
Schema Registry Server
Categories:
Advanced
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Schema Registry Server XML Override | For advanced use only, replace entire XML in the logback configuration file for Schema Registry Server, ignoring all logging configuration. |
logback_safety_valve
|
logback_safety_valve
|
false | |
| Heap Dump Directory | Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role. |
oom_heap_dump_dir
|
/tmp |
oom_heap_dump_dir
|
false |
| Dump Heap When Out of Memory | When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. | true |
oom_heap_dump_enabled
|
true | |
| Kill When Out of Memory | When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. | true |
oom_sigkill_enabled
|
true | |
| Automatically Restart Process | When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. | false |
process_auto_restart
|
true | |
| Enable Metric Collection | Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. | true |
process_should_monitor
|
true | |
| Process Start Retry Attempts | Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. | 3 |
process_start_retries
|
false | |
| Process Start Wait Timeout | The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. | 20 |
process_start_secs
|
false | |
| Schema Registry Server Advanced Configuration Snippet (Safety Valve) for registry.yaml | For advanced use only. A string to be inserted into registry.yaml for this role only. |
registry.yaml_role_safety_valve
|
false | ||
| Schema Registry Server Environment Advanced Configuration Snippet (Safety Valve) | For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. |
SCHEMA_REGISTRY_SERVER_role_env_safety_valve
|
false |
Logs
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Schema Registry Server Log Directory | The log directory for log files of the role Schema Registry Server. |
log_dir
|
/var/log/schemaregistry |
log_dir
|
false |
| Schema Registry Server Logging Threshold | The minimum log level for Schema Registry Server logs | INFO |
log_threshold
|
false | |
| Schema Registry Server Maximum Log File Backups | The maximum number of rolled log files to keep for Schema Registry Server logs. Typically used by log4j or logback. | 10 |
max_log_backup_index
|
false | |
| Schema Registry Server Max Log Size | The maximum size, in megabytes, per log file for Schema Registry Server logs. Typically used by log4j or logback. | 200 MiB |
max_log_size
|
false |
Monitoring
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Enable Health Alerts for this Role | When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold | true |
enable_alerts
|
false | |
| Enable Configuration Change Alerts | When set, Cloudera Manager will send alerts when this entity's configuration changes. | false |
enable_config_alerts
|
false | |
| Log Directory Free Space Monitoring Absolute Thresholds | The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. | Warning: 10 GiB, Critical: 5 GiB |
log_directory_free_space_absolute_thresholds
|
false | |
| Log Directory Free Space Monitoring Percentage Thresholds | The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. | Warning: Never, Critical: Never |
log_directory_free_space_percentage_thresholds
|
false | |
| Metric Filter | Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
jvm_heap_used_mb metric:
{
"includeHealthTestMetricSet": true,
"filterType": "whitelist",
"metrics": ["jvm_heap_used_mb"]
} |
monitoring_metric_filter
|
false | ||
| Process Swap Memory Thresholds | The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. | Warning: 200 B, Critical: Never |
process_swap_memory_thresholds
|
false | |
| Role Triggers | The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
[{"triggerName": "sample-trigger",
"triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad",
"streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. |
[] |
role_triggers
|
true | |
| File Descriptor Monitoring Thresholds | The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. | Warning: 50.0 %, Critical: 70.0 % |
schema_registry_server_fd_thresholds
|
false | |
| Schema Registry Server Host Health Test | When computing the overall Schema Registry Server health, consider the host's health. | true |
schema_registry_server_host_health_enabled
|
false | |
| Schema Registry Server Process Health Test | Enables the health test that the Schema Registry Server's process state is consistent with the role configuration | true |
schema_registry_server_scm_health_enabled
|
false | |
| Unexpected Exits Thresholds | The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. | Warning: Never, Critical: Any |
unexpected_exits_thresholds
|
false | |
| Unexpected Exits Monitoring Period | The period to review when computing unexpected exits. | 5 minute(s) |
unexpected_exits_window
|
false |
Other
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Schema Registry Admin Port | The admin port for the server. |
schema.registry.adminPort
|
7789 |
schema.registry.adminPort
|
true |
| Schema Registry Allowed Resources | Allowed resources for Schema Registry. |
schema.registry.allowed.resources
|
401.html, back-default.png, favicon.ico |
schema.registry.allowed.resources
|
false |
| Schema Version Cache Expiry Interval | Schema version cache expiry interval. |
schema.registry.cache.expiry.interval
|
3600 |
schema.registry.cache.expiry.interval
|
true |
| Schema Registry Cache Size | Schema Registry cache size. |
schema.registry.cache.size
|
1000 |
schema.registry.cache.size
|
true |
| Password For HTTP Proxy Server Username | Password For HTTP Proxy Server Username. |
schema.registry.httpProxyPassword
|
schema.registry.httpProxyPassword
|
false | |
| HTTP Proxy Server | URL for http proxy server. Please enter it in format protocol_name://host_name:port_number. |
schema.registry.httpProxyServer
|
schema.registry.httpProxyServer
|
false | |
| HTTP Proxy Server Availability | Boolean to set if HTTP Proxy Server is available or not. |
schema.registry.httpProxyServer.available
|
false |
schema.registry.httpProxyServer.available
|
false |
| Username For HTTP Proxy Server | Username for http proxy server. |
schema.registry.httpProxyUsername
|
schema.registry.httpProxyUsername
|
false | |
| Schema Registry Jar Storage Directory Path | Jar storage directory path. |
schema.registry.jar.storage.directory.path
|
/tmp/schema-registry/local-jars |
schema.registry.jar.storage.directory.path
|
false |
| Schema Registry Jar Storage HDFS URL | URL of the directory to be used for storing jars on HDFS when HDFS is not selected as an optional dependency. |
schema.registry.jar.storage.hdfs.url
|
hdfs://localhost:8020 |
schema.registry.jar.storage.hdfs.url
|
false |
| Schema Registry Jar Storage Type | 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. |
schema.registry.jar.storage.type
|
local |
schema.registry.jar.storage.type
|
false |
| Java Home Path Override | Java home path override for Schema Registry. |
schema.registry.jdk.home
|
schema.registry.jdk.home
|
false | |
| Schema Registry Kerberos Name Rules | Kerberos name rules for Schema Registry. |
schema.registry.kerberos.name.rules
|
RULE:[2:$1@$0]([jt]t@.*EXAMPLE.COM)s/.*/$MAPRED_USER/ RULE:[2:$1@$0]([nd]n@.*EXAMPLE.COM)s/.*/$HDFS_USER/DEFAULT |
schema.registry.kerberos.name.rules
|
false |
| Schema Registry Kerberos Non Browser User Agents | Non browser user agents if kerberos is enabled. |
schema.registry.kerberos.non.browser.user.agents
|
schema.registry.kerberos.non.browser.user.agents
|
false | |
| Schema Registry Port | The port on which server accepts connections. |
schema.registry.port
|
7788 |
schema.registry.port
|
true |
| Schema Registry Servlet Filter | Schema Registry servlet filter class. |
schema.registry.servlet.filter
|
com.hortonworks.registries.auth.server.AuthenticationFilter |
schema.registry.servlet.filter
|
true |
| Schema Registry Admin Port (SSL) | HTTPS admin port Schema Registry node runs on when SSL is enabled. |
schema.registry.ssl.adminPort
|
7791 |
schema.registry.ssl.adminPort
|
false |
| SSL Keystore Type | The keystore type. It is blank by default but required if schema registry's ssl is enabled. e.g. PKCS12 or JKS. |
schema.registry.ssl.keyStoreType
|
jks |
schema.registry.ssl.keyStoreType
|
false |
| Schema Registry Port (SSL) | HTTPS port Schema Registry node runs on when SSL is enabled. |
schema.registry.ssl.port
|
7790 |
schema.registry.ssl.port
|
false |
| SSL TrustStore Type | The truststore type. It is blank by default but required if schema registry's ssl is enabled. e.g. PKCS12 or JKS. |
schema.registry.ssl.trustStoreType
|
jks |
schema.registry.ssl.trustStoreType
|
false |
| SSL ValidateCerts | Whether or not to validate TLS certificates before starting. If enabled, it will refuse to start with expired or otherwise invalid certificates. |
schema.registry.ssl.validateCerts
|
false |
schema.registry.ssl.validateCerts
|
false |
| SSL ValidatePeers | Whether or not to validate TLS peer certificates. |
schema.registry.ssl.validatePeers
|
false |
schema.registry.ssl.validatePeers
|
false |
| Schema Registry Query Timeout | Schema Registry query timeout. |
schema.registry.storage.query.timeout
|
30 second(s) |
schema.registry.storage.query.timeout
|
true |
| Schema Registry Token Validity | Kerberos token validity for Schema Registry in ms. |
schema.registry.token.validity
|
36000 |
schema.registry.token.validity
|
false |
| Schema Registry Log Max Backup Index | The number of backup files. |
schema_registry_log_maxbackupindex
|
20 |
schema_registry_log_maxbackupindex
|
false |
| Schema Registry Log Max File Size | The maximum size of backup file before the log is rotated. |
schema_registry_log_maxfilesize
|
256MB |
schema_registry_log_maxfilesize
|
false |
Performance
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Maximum Process File Descriptors | If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. |
rlimit_fds
|
false |
Resource Management
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Cgroup CPU Shares | Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. |
cpu.shares
|
1024 |
rm_cpu_shares
|
true |
| Custom Control Group Resources (overrides Cgroup settings) | Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.*** |
custom.cgroups
|
rm_custom_resources
|
false | |
| Cgroup I/O Weight | Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. |
blkio.weight
|
500 |
rm_io_weight
|
true |
| Cgroup Memory Hard Limit | Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' |
memory.limit_in_bytes
|
-1 MiB |
rm_memory_hard_limit
|
true |
| Cgroup Memory Soft Limit | Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' |
memory.soft_limit_in_bytes
|
-1 MiB |
rm_memory_soft_limit
|
true |
Security
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Schema Registry Server TLS/SSL Client Trust Store File | The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Schema Registry Server might connect to. This is used when Schema Registry 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. |
schema.registry.ssl.trustStorePath
|
ssl_client_truststore_location
|
false | |
| Schema Registry Server TLS/SSL Client Trust Store Password | The password for the Schema Registry 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. |
schema.registry.ssl.trustStorePassword
|
ssl_client_truststore_password
|
false | |
| Enable TLS/SSL for Schema Registry Server | Encrypt communication between clients and Schema Registry Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). |
ssl.enable
|
false |
ssl_enabled
|
false |
| Schema Registry Server TLS/SSL Server JKS Keystore File Location | The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Schema Registry Server is acting as a TLS/SSL server. The keystore must be in JKS format. |
schema.registry.ssl.keyStorePath
|
ssl_server_keystore_location
|
false | |
| Schema Registry Server TLS/SSL Server JKS Keystore File Password | The password for the Schema Registry Server JKS keystore file. |
schema.registry.ssl.keyStorePassword
|
ssl_server_keystore_password
|
false |
Stacks Collection
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Stacks Collection Data Retention | The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. |
stacks_collection_data_retention
|
100 MiB |
stacks_collection_data_retention
|
false |
| Stacks Collection Directory | The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. |
stacks_collection_directory
|
stacks_collection_directory
|
false | |
| Stacks Collection Enabled | Whether or not periodic stacks collection is enabled. |
stacks_collection_enabled
|
false |
stacks_collection_enabled
|
true |
| Stacks Collection Frequency | The frequency with which stacks are collected. |
stacks_collection_frequency
|
5.0 second(s) |
stacks_collection_frequency
|
false |
| Stacks Collection Method | The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped. |
stacks_collection_method
|
jstack |
stacks_collection_method
|
false |
Suppressions
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Suppress Configuration Validator: CDH Version Validator | Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. | false |
role_config_suppression_cdh_version_validator
|
true | |
| Suppress Parameter Validation: Schema Registry Server Log Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Server Log Directory parameter. | false |
role_config_suppression_log_dir
|
true | |
| Suppress Parameter Validation: Schema Registry Server XML Override | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Server XML Override parameter. | false |
role_config_suppression_logback_safety_valve
|
true | |
| Suppress Parameter Validation: Heap Dump Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. | false |
role_config_suppression_oom_heap_dump_dir
|
true | |
| Suppress Parameter Validation: Schema Registry Server Advanced Configuration Snippet (Safety Valve) for registry.yaml | 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. | false |
role_config_suppression_registry.yaml_role_safety_valve
|
true | |
| Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. | false |
role_config_suppression_rm_custom_resources
|
true | |
| Suppress Parameter Validation: Role Triggers | Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. | false |
role_config_suppression_role_triggers
|
true | |
| Suppress Parameter Validation: Schema Registry Admin Port | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Admin Port parameter. | false |
role_config_suppression_schema.registry.adminport
|
true | |
| Suppress Parameter Validation: Schema Registry Allowed Resources | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Allowed Resources parameter. | false |
role_config_suppression_schema.registry.allowed.resources
|
true | |
| Suppress Parameter Validation: Password For HTTP Proxy Server Username | Whether to suppress configuration warnings produced by the built-in parameter validation for the Password For HTTP Proxy Server Username parameter. | false |
role_config_suppression_schema.registry.httpproxypassword
|
true | |
| Suppress Parameter Validation: HTTP Proxy Server | Whether to suppress configuration warnings produced by the built-in parameter validation for the HTTP Proxy Server parameter. | false |
role_config_suppression_schema.registry.httpproxyserver
|
true | |
| Suppress Parameter Validation: Username For HTTP Proxy Server | Whether to suppress configuration warnings produced by the built-in parameter validation for the Username For HTTP Proxy Server parameter. | false |
role_config_suppression_schema.registry.httpproxyusername
|
true | |
| Suppress Parameter Validation: Schema Registry Jar Storage Directory Path | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Jar Storage Directory Path parameter. | false |
role_config_suppression_schema.registry.jar.storage.directory.path
|
true | |
| Suppress Parameter Validation: Schema Registry Jar Storage HDFS URL | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Jar Storage HDFS URL parameter. | false |
role_config_suppression_schema.registry.jar.storage.hdfs.url
|
true | |
| Suppress Parameter Validation: Java Home Path Override | Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Home Path Override parameter. | false |
role_config_suppression_schema.registry.jdk.home
|
true | |
| Suppress Parameter Validation: Schema Registry Kerberos Name Rules | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Kerberos Name Rules parameter. | false |
role_config_suppression_schema.registry.kerberos.name.rules
|
true | |
| Suppress Parameter Validation: Schema Registry Kerberos Non Browser User Agents | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Kerberos Non Browser User Agents parameter. | false |
role_config_suppression_schema.registry.kerberos.non.browser.user.agents
|
true | |
| Suppress Parameter Validation: Schema Registry Port | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Port parameter. | false |
role_config_suppression_schema.registry.port
|
true | |
| Suppress Parameter Validation: Schema Registry Servlet Filter | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Servlet Filter parameter. | false |
role_config_suppression_schema.registry.servlet.filter
|
true | |
| Suppress Parameter Validation: Schema Registry Admin Port (SSL) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Admin Port (SSL) parameter. | false |
role_config_suppression_schema.registry.ssl.adminport
|
true | |
| Suppress Parameter Validation: SSL Keystore Type | Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL Keystore Type parameter. | false |
role_config_suppression_schema.registry.ssl.keystoretype
|
true | |
| Suppress Parameter Validation: Schema Registry Port (SSL) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Port (SSL) parameter. | false |
role_config_suppression_schema.registry.ssl.port
|
true | |
| Suppress Parameter Validation: SSL TrustStore Type | Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL TrustStore Type parameter. | false |
role_config_suppression_schema.registry.ssl.truststoretype
|
true | |
| Suppress Parameter Validation: SSL ValidateCerts | Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL ValidateCerts parameter. | false |
role_config_suppression_schema.registry.ssl.validatecerts
|
true | |
| Suppress Parameter Validation: SSL ValidatePeers | Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL ValidatePeers parameter. | false |
role_config_suppression_schema.registry.ssl.validatepeers
|
true | |
| Suppress Parameter Validation: Schema Registry Log Max Backup Index | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Log Max Backup Index parameter. | false |
role_config_suppression_schema_registry_log_maxbackupindex
|
true | |
| Suppress Parameter Validation: Schema Registry Log Max File Size | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Log Max File Size parameter. | false |
role_config_suppression_schema_registry_log_maxfilesize
|
true | |
| Suppress Parameter Validation: Schema Registry Server Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Server Environment Advanced Configuration Snippet (Safety Valve) parameter. | false |
role_config_suppression_schema_registry_server_role_env_safety_valve
|
true | |
| Suppress Parameter Validation: Schema Registry Server TLS/SSL Client Trust Store File | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Server TLS/SSL Client Trust Store File parameter. | false |
role_config_suppression_ssl_client_truststore_location
|
true | |
| Suppress Parameter Validation: Schema Registry Server TLS/SSL Client Trust Store Password | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Server TLS/SSL Client Trust Store Password parameter. | false |
role_config_suppression_ssl_client_truststore_password
|
true | |
| Suppress Parameter Validation: Schema Registry Server TLS/SSL Server JKS Keystore File Location | 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. | false |
role_config_suppression_ssl_server_keystore_location
|
true | |
| Suppress Parameter Validation: Schema Registry Server TLS/SSL Server JKS Keystore File Password | 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. | false |
role_config_suppression_ssl_server_keystore_password
|
true | |
| Suppress Parameter Validation: Stacks Collection Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. | false |
role_config_suppression_stacks_collection_directory
|
true | |
| Suppress Health Test: Audit Pipeline Test | Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_schemaregistry_schema_registry_server_audit_health
|
true | |
| Suppress Health Test: File Descriptors | Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_schemaregistry_schema_registry_server_file_descriptor
|
true | |
| Suppress Health Test: Host Health | Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_schemaregistry_schema_registry_server_host_health
|
true | |
| Suppress Health Test: Log Directory Free Space | Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_schemaregistry_schema_registry_server_log_directory_free_space
|
true | |
| Suppress Health Test: Process Status | Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_schemaregistry_schema_registry_server_scm_health
|
true | |
| Suppress Health Test: Swap Memory Usage | Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_schemaregistry_schema_registry_server_swap_memory_usage
|
true | |
| Suppress Health Test: Unexpected Exits | Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_schemaregistry_schema_registry_server_unexpected_exits
|
true |
Service-Wide
Categories:
Advanced
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| System Group | The group that this service's processes should run as. | hadoop |
process_groupname
|
true | |
| System User | The user that this service's processes should run as. | schemaregistry |
process_username
|
true | |
| Schema Registry Service Environment Advanced Configuration Snippet (Safety Valve) | For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of all roles in this service except client configuration. |
SCHEMAREGISTRY_service_env_safety_valve
|
false |
Database
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Schema Registry Database Host | Hostname of the database used by Schema Registry. If the port is non-default for your database type, use host:port notation. |
schema.registry.storage.connector.host
|
localhost |
database_host
|
true |
| Schema Registry Database Name | Name of Schema Registry database. |
schema.registry.storage.connector.name
|
schemaregistry |
database_name
|
true |
| Schema Registry Database User Password | Password for Schema Registry database. |
schema.registry.storage.connector.password
|
database_password
|
true | |
| Schema Registry Database Port | Port for Schema Registry database. |
schema.registry.storage.connector.port
|
3306 |
database_port
|
true |
| Schema Registry Database Type | Database type to be used (postgres). |
schema.registry.storage.connector.type
|
mysql |
database_type
|
true |
| Schema Registry Database User | User for Schema Registry database. |
schema.registry.storage.connector.user
|
schemaregistry |
database_user
|
true |
Monitoring
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Enable Service Level Health Alerts | When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold | true |
enable_alerts
|
false | |
| Enable Configuration Change Alerts | When set, Cloudera Manager will send alerts when this entity's configuration changes. | false |
enable_config_alerts
|
false | |
| Schema Registry Server Role Health Test | When computing the overall SCHEMAREGISTRY health, consider Schema Registry Server's health | true |
SCHEMAREGISTRY_SCHEMA_REGISTRY_SERVER_health_enabled
|
false | |
| Service Triggers | The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
[{"triggerName": "sample-trigger",
"triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad",
"streamThreshold": 10, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. |
[] |
service_triggers
|
true | |
| Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) | For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones. |
smon_derived_configs_safety_valve
|
false |
Other
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Enable Kerberos Authentication | Enables Kerberos authentication for this Schema Registry service. |
kerberos.auth.enable
|
false |
kerberos.auth.enable
|
false |
Suppressions
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Suppress Configuration Validator: CDH Version Validator | Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. | false |
role_config_suppression_cdh_version_validator
|
true | |
| Suppress Configuration Validator: Schema Registry Server Log Directory | Whether to suppress configuration warnings produced by the Schema Registry Server Log Directory configuration validator. | false |
role_config_suppression_log_dir
|
true | |
| Suppress Configuration Validator: Schema Registry Server XML Override | Whether to suppress configuration warnings produced by the Schema Registry Server XML Override configuration validator. | false |
role_config_suppression_logback_safety_valve
|
true | |
| Suppress Configuration Validator: Heap Dump Directory | Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator. | false |
role_config_suppression_oom_heap_dump_dir
|
true | |
| Suppress Configuration Validator: Schema Registry Server Advanced Configuration Snippet (Safety Valve) for registry.yaml | Whether to suppress configuration warnings produced by the Schema Registry Server Advanced Configuration Snippet (Safety Valve) for registry.yaml configuration validator. | false |
role_config_suppression_registry.yaml_role_safety_valve
|
true | |
| Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings) | Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator. | false |
role_config_suppression_rm_custom_resources
|
true | |
| Suppress Configuration Validator: Role Triggers | Whether to suppress configuration warnings produced by the Role Triggers configuration validator. | false |
role_config_suppression_role_triggers
|
true | |
| Suppress Configuration Validator: Schema Registry Admin Port | Whether to suppress configuration warnings produced by the Schema Registry Admin Port configuration validator. | false |
role_config_suppression_schema.registry.adminport
|
true | |
| Suppress Configuration Validator: Schema Registry Allowed Resources | Whether to suppress configuration warnings produced by the Schema Registry Allowed Resources configuration validator. | false |
role_config_suppression_schema.registry.allowed.resources
|
true | |
| Suppress Configuration Validator: Password For HTTP Proxy Server Username | Whether to suppress configuration warnings produced by the Password For HTTP Proxy Server Username configuration validator. | false |
role_config_suppression_schema.registry.httpproxypassword
|
true | |
| Suppress Configuration Validator: HTTP Proxy Server | Whether to suppress configuration warnings produced by the HTTP Proxy Server configuration validator. | false |
role_config_suppression_schema.registry.httpproxyserver
|
true | |
| Suppress Configuration Validator: Username For HTTP Proxy Server | Whether to suppress configuration warnings produced by the Username For HTTP Proxy Server configuration validator. | false |
role_config_suppression_schema.registry.httpproxyusername
|
true | |
| Suppress Configuration Validator: Schema Registry Jar Storage Directory Path | Whether to suppress configuration warnings produced by the Schema Registry Jar Storage Directory Path configuration validator. | false |
role_config_suppression_schema.registry.jar.storage.directory.path
|
true | |
| Suppress Configuration Validator: Schema Registry Jar Storage HDFS URL | Whether to suppress configuration warnings produced by the Schema Registry Jar Storage HDFS URL configuration validator. | false |
role_config_suppression_schema.registry.jar.storage.hdfs.url
|
true | |
| Suppress Configuration Validator: Java Home Path Override | Whether to suppress configuration warnings produced by the Java Home Path Override configuration validator. | false |
role_config_suppression_schema.registry.jdk.home
|
true | |
| Suppress Configuration Validator: Schema Registry Kerberos Name Rules | Whether to suppress configuration warnings produced by the Schema Registry Kerberos Name Rules configuration validator. | false |
role_config_suppression_schema.registry.kerberos.name.rules
|
true | |
| Suppress Configuration Validator: Schema Registry Kerberos Non Browser User Agents | Whether to suppress configuration warnings produced by the Schema Registry Kerberos Non Browser User Agents configuration validator. | false |
role_config_suppression_schema.registry.kerberos.non.browser.user.agents
|
true | |
| Suppress Configuration Validator: Schema Registry Port | Whether to suppress configuration warnings produced by the Schema Registry Port configuration validator. | false |
role_config_suppression_schema.registry.port
|
true | |
| Suppress Configuration Validator: Schema Registry Servlet Filter | Whether to suppress configuration warnings produced by the Schema Registry Servlet Filter configuration validator. | false |
role_config_suppression_schema.registry.servlet.filter
|
true | |
| Suppress Configuration Validator: Schema Registry Admin Port (SSL) | Whether to suppress configuration warnings produced by the Schema Registry Admin Port (SSL) configuration validator. | false |
role_config_suppression_schema.registry.ssl.adminport
|
true | |
| Suppress Configuration Validator: SSL Keystore Type | Whether to suppress configuration warnings produced by the SSL Keystore Type configuration validator. | false |
role_config_suppression_schema.registry.ssl.keystoretype
|
true | |
| Suppress Configuration Validator: Schema Registry Port (SSL) | Whether to suppress configuration warnings produced by the Schema Registry Port (SSL) configuration validator. | false |
role_config_suppression_schema.registry.ssl.port
|
true | |
| Suppress Configuration Validator: SSL TrustStore Type | Whether to suppress configuration warnings produced by the SSL TrustStore Type configuration validator. | false |
role_config_suppression_schema.registry.ssl.truststoretype
|
true | |
| Suppress Configuration Validator: SSL ValidateCerts | Whether to suppress configuration warnings produced by the SSL ValidateCerts configuration validator. | false |
role_config_suppression_schema.registry.ssl.validatecerts
|
true | |
| Suppress Configuration Validator: SSL ValidatePeers | Whether to suppress configuration warnings produced by the SSL ValidatePeers configuration validator. | false |
role_config_suppression_schema.registry.ssl.validatepeers
|
true | |
| Suppress Configuration Validator: Schema Registry Log Max Backup Index | Whether to suppress configuration warnings produced by the Schema Registry Log Max Backup Index configuration validator. | false |
role_config_suppression_schema_registry_log_maxbackupindex
|
true | |
| Suppress Configuration Validator: Schema Registry Log Max File Size | Whether to suppress configuration warnings produced by the Schema Registry Log Max File Size configuration validator. | false |
role_config_suppression_schema_registry_log_maxfilesize
|
true | |
| Suppress Configuration Validator: Schema Registry Server Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the Schema Registry Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator. | false |
role_config_suppression_schema_registry_server_role_env_safety_valve
|
true | |
| Suppress Configuration Validator: Schema Registry Server TLS/SSL Client Trust Store File | Whether to suppress configuration warnings produced by the Schema Registry Server TLS/SSL Client Trust Store File configuration validator. | false |
role_config_suppression_ssl_client_truststore_location
|
true | |
| Suppress Configuration Validator: Schema Registry Server TLS/SSL Client Trust Store Password | Whether to suppress configuration warnings produced by the Schema Registry Server TLS/SSL Client Trust Store Password configuration validator. | false |
role_config_suppression_ssl_client_truststore_password
|
true | |
| Suppress Configuration Validator: Schema Registry Server TLS/SSL Server JKS Keystore File Location | Whether to suppress configuration warnings produced by the Schema Registry Server TLS/SSL Server JKS Keystore File Location configuration validator. | false |
role_config_suppression_ssl_server_keystore_location
|
true | |
| Suppress Configuration Validator: Schema Registry Server TLS/SSL Server JKS Keystore File Password | Whether to suppress configuration warnings produced by the Schema Registry Server TLS/SSL Server JKS Keystore File Password configuration validator. | false |
role_config_suppression_ssl_server_keystore_password
|
true | |
| Suppress Configuration Validator: Stacks Collection Directory | Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator. | false |
role_config_suppression_stacks_collection_directory
|
true | |
| Suppress Parameter Validation: Schema Registry Database Host | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Database Host parameter. | false |
service_config_suppression_database_host
|
true | |
| Suppress Parameter Validation: Schema Registry Database Name | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Database Name parameter. | false |
service_config_suppression_database_name
|
true | |
| Suppress Parameter Validation: Schema Registry Database User Password | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Database User Password parameter. | false |
service_config_suppression_database_password
|
true | |
| Suppress Parameter Validation: Schema Registry Database Port | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Database Port parameter. | false |
service_config_suppression_database_port
|
true | |
| Suppress Parameter Validation: Schema Registry Database User | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Database User parameter. | false |
service_config_suppression_database_user
|
true | |
| Suppress Parameter Validation: System Group | Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter. | false |
service_config_suppression_process_groupname
|
true | |
| Suppress Parameter Validation: System User | Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter. | false |
service_config_suppression_process_username
|
true | |
| Suppress Configuration Validator: Schema Registry Server Count Validator | Whether to suppress configuration warnings produced by the Schema Registry Server Count Validator configuration validator. | false |
service_config_suppression_schema_registry_server_count_validator
|
true | |
| Suppress Parameter Validation: Schema Registry Service Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry Service Environment Advanced Configuration Snippet (Safety Valve) parameter. | false |
service_config_suppression_schemaregistry_service_env_safety_valve
|
true | |
| Suppress Parameter Validation: Service Triggers | Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter. | false |
service_config_suppression_service_triggers
|
true | |
| Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter. | false |
service_config_suppression_smon_derived_configs_safety_valve
|
true | |
| Suppress Health Test: Schema Registry Server Health | 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. | false |
service_health_suppression_schemaregistry_schemaregistry_schema_registry_server_health
|
true |
