The following table describes the ZooKeeper Properties for the Catalog microservice:
| S.NO | PROPERTY | DESCRIPTION |
|---|---|---|
| 1 | hystrix.command.user-key.circuitBreaker.requestVolumeThreshold | This property sets the minimum number of requests in a rolling window that will trip the circuit. |
| 2 | hystrix.command.user-key.circuitBreaker.sleepWindowInMilliseconds | This property sets the amount of time, after tripping the circuit, to reject requests before allowing attempts again to determine if the circuit should again be closed. |
| 3 | hystrix.command.user-key.execution.isolation.thread.timeoutInMilliseconds | This property sets instance-specific values dynamically which overrides the preceding three levels of defaults. |
| 4 | server.servlet.contextPath | This property holds the Spring Boot application's context path. |
| 5 | server.ssl.enabled | This property controls the SSL configuration of the Boot application. When it is set to true, the application is started in HTTPS protocol only and all HTTP request will be rejected. |
| 6 | server.ssl.enabled-protocols | This property holds the protocols enabled for this application. It takes comma separated values. |
| 7 | server.ssl.key-alias | This property holds the key store alias name set during the import using keytool utility. |
| 8 | server.ssl.key-store | This property holds the key store's PrivateKeyEntry which will be used as the SSL certificate for the microservice. |
| 9 | server.ssl.key-store-password | This property holds the key store password for accessing the key store as mentioned in the key-store property. |
| 10 | server.ssl.key-store-type | This property holds the key store type. |
| 11 | server.tomcat.accesslog.directory | This property holds the directory details for storing the access log. |
| 12 | server.tomcat.accesslog.enabled | This property controls the Tomcat logs for the Boot application. |
| 13 | server.tomcat.accesslog.max-days | The maximum number of days rotated access logs will be retained for before being deleted. If not specified, the default value is set to 10. |
| 14 | server.tomcat.accesslog.pattern | This property holds the pattern of the access logs to be printed. This will follow the Apache Tomcat parameters. |
| 15 | skava.auditlog.enabled | This property enables or disables the audit log component. |
| 16 | skava.auditlog.file-location | This property holds the path to store the audit logs. |
| 17 | skava.auditlog.layout-type | This property used to denote the layout type. |
| 18 | skava.auditlog.mongodb.enabled | This property enables the Mongo component for the audit log. |
| 19 | skava.auditlog.mongodb.uri | This property is used to connect to the MongoDB server. |
| 20 | skava.auditlog.password | This property is used to connect to the MySQL DB for audit logs. |
| 21 | skava.authorization.authExpiryTimeMins | This property holds the expiry time of authorization token generated using the getTestToken API call. The value is mentioned in minutes. |
| 22 | skava.authorization.authHeader | This property holds the HTTP request header name in which the authorization token (JWT) is passed by the caller. Since the functionality of validating token is inherited from the framework, this property's value is used for identifying the correct header and its value is considered for access/authorization checks. |
| 23 | skava.authorization.enabled | This property indicates whether the authorization component is enabled or disabled for the corresponding microservice. If the value is set as false, then all APIs are open to access without any authorization check and this is not recommended for the production or public APIs. For the production, production-like, or public environments, this property should be enabled (true). |
| 24 | skava.authorization.gettesttoken.enabled | This property indicates whether the authorization endpoint for test JWT tokens is enabled or not. If it is set to true, an API will be exposed to obtain test JWT tokens. |
| 25 | skava.authorization.superAdminRoleName | The property indicates the Super Admin role name for the corresponding microservice. |
| 26 | skava.authorization.tokenSecret | This property holds the secret which will be used to verify the signature of the JWT passed by the caller. Only if the JWT passed by the caller found valid with respect to signature, expiry and having necessary privileges, the request will be processed further. |
| 27 | skava.cache.cascadeCacheNames | This property enables cascade cache by its name. |
| 28 | skava.cache.enableCascade | This property enables cascade cache. |
| 29 | skava.cache.enabled | This property enables cache. |
| 30 | skava.cache.localCache.config.cache_collection.cacheSize | This property indicates the local cache entry size. |
| 31 | skava.cache.localCache.config.cache_collection.maxIdleInSeconds | This property enables the local cache maximum idle time in seconds. |
| 32 | skava.cache.localCache.config.cache_collection.timeToLiveInSeconds | This property enables the local cache expiry time in seconds. |
| 33 | skava.cache.localCache.config.cache_collection_attribute.cacheSize | This property indicates the local cache entry size. |
| 34 | skava.cache.localCache.config.cache_collection_attribute.maxIdleInSeconds | This property enables local cache maximum idle time in seconds. |
| 35 | skava.cache.localCache.config.cache_collection_attribute.timeToLiveInSeconds | This property enables the local cache expiry time in seconds. |
| 36 | skava.cache.localCache.config.Catalog_Version_Cache.cacheSize | This property indicates the local cache entry size. |
| 37 | skava.cache.localCache.config.Catalog_Version_Cache.maxIdleInSeconds | This property enables the local cache maximum idle time in seconds. |
| 38 | skava.cache.localCache.config.Catalog_Version_Cache.timeToLiveInSeconds | This property enables the local cache expiry time in seconds. |
| 39 | skava.cache.localCache.type | This property indicates the local cache type for L1 cache used in cascade cache. |
| 40 | skava.cache.maxCacheSize | This property holds the cache size in bytes. If the value is greater than 0, then the cache is restricted based on the value. Otherwise, no limitation for cache. |
| 41 | skava.cache.redis.cacheNames | This property holds the Redis cache names used by the application. |
| 42 | skava.cache.redis.cacheNamesWithTimeToLiveMap.cache_search_count | This property sets the fully qualified name of the custom implementation class. |
| 43 | skava.cache.redis.clearCacheEventName | This property sets the event name for cache clear operation. |
| 44 | skava.cache.redis.client | This property specifies the type of client for redis connection. |
| 45 | skava.cache.redis.cluster.maxRedirects | This property specifies the maximum number of redirects to follow when executing commands across the cluster. |
| 46 | skava.cache.redis.cluster.nodes | This property sets the comma-separated list of 'host:port' pairs to bootstrap from. This represents an 'initial' list of cluster nodes and is required to have at least one entry. |
| 47 | skava.cache.redis.clusterEnabled | This property indicates the Toggle cluster for Redis server. |
| 48 | skava.cache.redis.database | This property holds the Redis database index used by the connection factory. |
| 49 | skava.cache.redis.enabled | This property indicates whether the Redis component needs to be enabled or disabled for this application. It is recommended that it should be enabled (true) for the production and production-grade environments (like performance). |
| 50 | skava.cache.redis.expTimeTolive | This property holds the expiration time of the Redis entries. That is the maximum time the objects are requested to be held in the Redis server. Using this property you are requesting the Redis to hold the objects for the specified time but it is the LRU/LCU which will determine how long an entry survives in the cache. |
| 51 | skava.cache.redis.host | This property holds the Redis server's hostname/IP for caching objects. |
| 52 | skava.cache.redis.maxTimeTolive | This property sets the max time to live in minutes time for redis cache |
| 53 | skava.cache.redis.password | This property holds the password for connecting to the Redis server. This is required if the authentication is enabled for the Redis server. It is recommended that it should be enabled for the production environment. |
| 54 | skava.cache.redis.pool.maxActive | This property holds the maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. |
| 55 | skava.cache.redis.pool.maxIdle | This property holds the maximum number of idle connections in the pool. Use a negative value to indicate an unlimited number of idle connections. |
| 56 | skava.cache.redis.pool.minIdle | This property holds the minimum number of idle connections to maintain in the pool. This setting only has an effect if it is positive. |
| 57 | skava.cache.redis.port | This property holds the Redis server's port for the application to connect for both read and write cache operations. |
| 58 | skava.cache.redis.sentinel.master | This property indicates the name of the Redis server. |
| 59 | skava.cache.redis.sentinel.nodes | This property indicates the comma-separated list of 'host:port' pairs. |
| 60 | skava.cache.redis.ssl | This property enables or disables the redis server ssl |
| 61 | skava.cache.redis.timeout | This property holds the connection timeout value of all Redis connections for both read and write. |
| 62 | skava.cache.redis.url | This property indicates the redis server url |
| 63 | skava.cache.useOnlyL2Cache | This property enables L2 cache. |
| 64 | skava.catalog.liveEnvironment | This property indicates whether the deployed environment is live or staging (authoring) environment. When it is set to true, indicates the live environment. |
| 65 | skava.catalog.liveEnvironment | This property specifies whether the deployment environment is live or authoring/staging environment. The value can be:
false. |
| 66 | skava.core.releasedefinition.enabled | This property is used to enable the release definition endpoint. |
| 67 | skava.cors.allowedHeaders | This property contains the value of the allowed header. |
| 68 | skava.cors.allowedMethods | This property contains the allowed methods for Spring controller. |
| 69 | skava.cors.allowedOrigins | This property is sets the allowedOrigins for the cors request. |
| 70 | skava.cors.enabled | This property enables or disables the cors. |
| 71 | skava.cors.exposedHeaders | This property sets the exposedHeaders for the cors request. |
| 72 | skava.cors.maxAge | This property sets the maxAge for the cors request in seconds. |
| 73 | skava.cors.pathPattern | This property holds the pattern for the cors request. |
| 74 | skava.event.className | This property sets the fully qualified name of the custom implementation class. |
| 75 | skava.event.enabled | This property enables or disables the event component. |
| 76 | skava.event.enableExternalEvent | This property is used to enable/disable the external event component. |
| 77 | skava.event.enableFatEvent | This property is used to enable/disable the fat event. |
| 78 | skava.event.eventbridge.eventBusName | This property is used to set the fully qualified name of the custom implementation class. |
| 79 | skava.event.eventbridge.region | This property is used to set the fully qualified name of the custom implementation class. |
| 80 | skava.event.externalClassName | This property is used to set the fully qualified name of the custom implementation class. |
| 81 | skava.event.externalFatEventClass | This property is used to set the fully qualified name of the custom implementation class. |
| 82 | skava.event.rabbitmq.addresses | This property sets the addresses for the RabbitMQ server cluster. |
| 83 | skava.event.rabbitmq.cluster-enabled | This property enables or disables the cluster for the RabbitMQ server. |
| 84 | skava.event.rabbitmq.concurrentConsumers | This property holds the maximum allowed concurrent consumers. |
| 85 | skava.event.rabbitmq.deadLetterExchange | This property is used to set the dead letter exchange for the RabbitMQ server. |
| 86 | skava.event.rabbitmq.defaultMaxRetryCount | This property is used to set the default maximum retrival count for the RabbitMQ server. |
| 87 | skava.event.rabbitmq.enabled | This property enables or disables the Rabbitmq server for the event component. |
| 88 | skava.event.rabbitmq.host | This property holds the hostname of the RabbitMQ server. |
| 89 | skava.event.rabbitmq.password | This property holds the password of the RabbitMQ server. |
| 90 | skava.event.rabbitmq.port | This property tells the port of the RabbitMQ server. |
| 91 | skava.event.rabbitmq.ssl.algorithm | This property sets the SSL algorithm, which is used for the RabbitMQ server. |
| 92 | skava.event.rabbitmq.ssl.enabled | This property enables or disables the SSL support for RabbitMQ server. |
| 93 | skava.event.rabbitmq.topicExchange | This property sets the topic exchange for the RabbitMQ server. |
| 94 | skava.event.rabbitmq.userName | This property has the username of the RabbitMQ server. |
| 95 | skava.event.rabbitmq.virtualHost | This property sets the virtual host for the RabbitMQ server. |
| 96 | skava.localization.default-locale | This property holds the default locale to be used for all response messages if it has not been provided in the request. |
| 97 | skava.localization.enabled | This property indicates whether the localization component is enabled or not. The value true indicates it is enabled and false indicates it is disabled. |
| 98 | skava.localization.externalPath | This property holds the external path from where the localized messages are to be read from. |
| 99 | skava.localization.param-name | This property holds the parameter name in which the localization component is used. |
| 100 | skava.localization.resourceBundleBaseName | This property holds the resource bundle's base name. |
| 101 | skava.log.enabled | This property sets the resource bundle's base name. |
| 102 | skava.log.fileAppenderEnabled | This property indicates whether the log needs to be appended to a log file or not. If it is set to true the log is written to the log file as specified in log4j2.yml. |
| 103 | skava.log.fluentdAppenderEnabled | This property indicates whether the log file should be aggregated to Fluentd directly rather than to a file or not. |
| 104 | skava.log.fluentdHost | This property holds the hostname of Fluentd server instance where the log will be aggregated. |
| 105 | skava.log.fluentdPattern | This property holds the pattern for writing logs into the Fluentd server. |
| 106 | skava.log.fluentdPort | This property holds the port of Fluentd server instance where the log will be aggregated. |
| 107 | skava.log.fluentdTagName | This property holds the tag name to be added to the logs. |
| 108 | skava.mongo.database | This property denotes the name of the Mongo database for this service user by Hibernate to connect. |
| 109 | skava.mongo.enabled | This property indicates whether the Mongo database is enabled or not. It is based on the input true or false. |
| 110 | skava.mongo.uri | This property is used to connect to the MongoDB server. |
| 111 | skava.secretsmanager.className | This property is used to specify which class to be used for the secret management. |
| 112 | skava.swaggerglobalparams.enabled | This property indicates the Swagger global params. The default value is false. If this property value is set to true, the Swagger global params from the application .yml will be referred and added in the Swagger UI. |
| 113 | spring.application.name | This property holds the application name of the Spring Boot application. |
| 114 | spring.autoconfigure.exclude | This property holds the classes that are to be excluded from the Spring's autoconfiguration. |
| 115 | spring.cloud.zookeeper.config.enabled | This property is used to enable/disable the ZooKeeper base path. |
| 116 | spring.cloud.zookeeper.config.root | This property is used to enable/disable the zookeeper base path. |
| 117 | spring.cloud.zookeeper.config.watcher.enabled | This property is used to enable/disable the zookeeper watcher. |
| 118 | spring.cloud.zookeeper.connect-string | This property is used to located somewhere other than localhost:2181, the configuration is required to locate the server. |
| 119 | spring.cloud.zookeeper.enabled | This property enables or disables the ZooKeeper server. |
| 120 | spring.sleuth.trace-id128 | This property is used to enable/disable the sleuth 128 bit trace ID in the logs. |
| 121 | ZK_REDIS_SSL_ENABLED | This property enables or disables the Redis server SSL. The default value is FALSE. |
| 122 | skava.app.enabled | This property enables the app. The default value is TRUE. |
| 123 | skava.app.appClassName | This property holds the app component class name (GCP/Azure). The default value is com.skava.core.app.gcp.GCPAppComponent. |
| 124 | skava.app.host | This property holds the service endpoint URL of the App Marketplace service. The default value is ##ZK_SERVICE_END_POINT##. |
| 125 | skava.app.apiKey | This property holds the API key which is sent to the App for authentication. The default value is ##ZK_APP_API_KEY##. |
| 126 | ZK_REDIS_TIMEOUT | This property holds connection timeout value of Redis in milliseconds. The default value is 10000. |
| 127 | ZK_REDIS_USERNAME | This property holds the login username of the Redis server. The default value is empty. |
| 128 | ZK_PROTOCOLS | This property enables macro support for the TLS protocol version. |
| 129 | ZK_REDIS_PASSWORD | This property holds the Redis password. |
| 130 | contentrepository.defaultImplClass | This property is used for specifying the type of the storage. |
| 131 | contentrepository.enabled | This property is used to enable or disable the ZooKeeper server. |
| 132 | contentrepository.urlEncoded | This property is used to enable or disable the URL encoding. |
| 133 | contentrepository.properties.cloudFrontDomain | This property sets the cloud front domain of the content repository. It is used to fetch the object from the s3 bucket. |
| 134 | contentrepository.properties.s3Bucket | This property sets the S3 bucket of the content repository. |
| 135 | contentrepository.properties.s3Region | This property sets the S3 region of the content repository. |
| 136 | endpoints.loggers.enabled | This property is used to enable or disable the logger. |
| 137 | web.exposure.include | This property is used to expose the management endpoints. |
| 138 | server.max-http-header-size | To increase http header size we have externalize this property. |
| 139 | externalEventConfig.fileHost | This property is used to set the hosting events on external website. |
| 140 | externalEventConfig.tempStoragePath | This property is used to set the file path for the external events. |
| 141 | skava.event.rabbitmq.amqpEnabled | This property is used to enable AMQP (Advanced Message Queuing Protocol). When the value is
|
Revision History
2024-07-12 | SD – Updated ZK properties.
2024-06-19 | SD – Updated ZK properties for 8.17.0 to 8.16.0.
2023-10-22 | JP – Updated content for 8.15.4 release.
2023-01-04 | AN – Updated content for 8.13.0 release.
2022-04-10 | JP – Fixed link and http issues.
2021-12-27 | AN – Updated content for 8.11 release.
2020-12-09 | SW – Added missing properties.
2020-03-09 | AN – Updated content for April 2020 release.
2020-01-14 | AN – Updated content for February 2020 release.
2019-07-09 | AN – Updated ZK properties for July 2019 release.
2019-06-08 | PLK – Minor copyedits.
2019-05-16 | JP – Updated to a new table tool.
2019-04-16 | AN – Content updated for April 2019 release.
2019-01-21 | PLK – Page created and content uploaded.