Configuring Redis

Redis is supported only for the Order and Catalog services. A relational database is used for the Admin, Archival, and Jeopardy services.

To start the services in Redis, perform the following steps:

    Procedure
  1. In the $OM_HOME/externalLib/seed-data/app-properties/ConfigValues_common.JSON file, update the cmPluggableCache and omPluggableCache properties to redis.

  2. In the $OM_HOME/externalLib/seeddata/app-properties/ConfigValues_CatalogService.JSON file under the Redis Data Source Configuration category, update the following catalog Redis-related properties:

    Property Name Description
    catalogRedisClientName Redis server ClientName for Catalog datasource
    catalogRedisClusterEnabled Whether Redis is running in cluster mode
    catalogRedisDatabase Redis server database name for Catalog datasource
    catalogRedisHost Redis server host for storing Catalog models
    catalogRedisPassword Password to connect to Redis cluster/node
    catalogRedisPort Redis server port for storing Catalog models
    catalogRedisSslEnabled Connect to Redis cluster or node via SSL
    catalogRedisUsername User name to connect to Redis cluster/node
    redisBlockedWhenExhausted Enable connection blocking when the connection pool is exhausted
    redisJmxEnabled Enable JMX for connections
    redisKeyStoreAbsoluteFileName Redis SSL KeyStore absolute file name
    redisKeyStorePassword Redis SSL KeyStore password
    redisKeyStoreType Redis SSL KeyStore type
    redisLifo Enable LIFO behavior for idle objects, always returning the most recently used object from the pool
    redisMaxIdle Maximum number of idle connections in the pool
    redisMaxTotal Maximum number of connections that can be allocated by the pool at a given time
    redisMinEvictableIdleTimeMillis Minimum amount of time an object might sit idle in the pool, in milliseconds
    redisMinIdle Minimum number of idle connections to maintain in the pool
    redisNumTestsPerEvictionRun Maximum number of connections to examine during each eviction run
    redisSoftMinEvictableIdleTimeMillis Minimum amount of time an object might sit idle in the pool if minIdle instances are available, in milliseconds
    redisTestOnBorrow Enable connection validation before being borrowed from the pool
    redisTestOnReturn Enable connection validation before being returned to the pool
    redisTestWhileIdle Enable connection validation when idle in the connection pool
    redisTimeBetweenEvictionRunsMillis Number of milliseconds to sleep between runs of the idle object evictor thread
    redisTrustStoreAbsoluteFileName Redis SSL TrustStore absolute file name
    redisTrustStorePassword Redis SSL TrustStore password
    redisTrustStoreType Redis SSL TrustStore type
  3. In the $OM_HOME/externalLib/seed-data/app-properties/ConfigValues_AopdService.JSON file under the Redis Data Source Configuration category, update the catalog Redis-related properties.

    Property Name Description
    catalogRedisClientName Redis server ClientName for Catalog datasource
    catalogRedisClusterEnabled Checks whether Redis is running in cluster mode
    catalogRedisDatabase Redis server database name for Catalog datasource
    catalogRedisHost Redis server host for storing Catalog models
    catalogRedisPassword Password to connect to Redis cluster/node
    catalogRedisPort Redis server port for storing Catalog models
    catalogRedisSslEnabled Connect to Redis cluster/node via SSL
    catalogRedisUsername User name to connect to Redis cluster/node
    redisBlockedWhenExhausted Enable connection blocking when the connection pool is exhausted
    redisJmxEnabled Enable JMX for connections
    redisKeyStoreAbsoluteFileName Redis SSL KeyStore absolute file name
    redisKeyStorePassword Redis SSL KeyStore password
    redisKeyStoreType Redis SSL KeyStore type
    redisLifo Enable LIFO behavior for idle objects, always returning the most recently used object from the pool
    redisMaxIdle Maximum number of idle connections in the pool
    redisMaxTotal Maximum number of connections that can be allocated by the pool at a given time
    redisMinEvictableIdleTimeMillis Minimum amount of time an object might sit idle in the pool, in milliseconds
    redisMinIdle Minimum number of idle connections to maintain in the pool
    redisNumTestsPerEvictionRun Maximum number of connections to examine during each eviction run
    redisSoftMinEvictableIdleTimeMillis Minimum amount of time an object might sit idle in the pool if minIdle instances are available, in milliseconds
    redisTestOnBorrow Enable connection validation before being borrowed from the pool
    redisTestOnReturn Enable connection validation before being returned to the pool
    redisTestWhileIdle Enable connection validation when idle in the connection pool
    redisTimeBetweenEvictionRunsMillis Number of milliseconds to sleep between runs of the idle object evictor thread
    redisTrustStoreAbsoluteFileName Redis SSL TrustStore absolute file name
    redisTrustStorePassword Redis SSL TrustStore password
    redisTrustStoreType Redis SSL TrustStore type
  4. In the $OM_HOME/externalLib/seed-data/app-properties/ConfigValues_OrchService.JSON file under the Redis Data Source Configuration category, update the catalog and order Redis-related properties .

    Property Name Description
    orderRedisHost

    Redis server host for storing order data

    orderRedisPort Port number of the Redis server for storing order models
    orderRedisUsername User name required to connect to the Redis cluster/node
    orderRedisPassword Password for connecting to the Redis cluster/node
    orderRedisDatabase Name of the Redis database for the order data source
    orderRedisClientName Name of the Redis client for the order data source
    orderRedisSslEnabled Enables SSL connection to the Redis cluster/node
    orderRedisKeyStoreType Type of the SSL KeyStore for Redis connections
    orderRedisKeyStorePassword Password for the SSL KeyStore
    orderRedisTrustStoreType Type of the SSL TrustStore for Redis connections
    orderRedisTrustStorePassword Password for the SSL TrustStore
    orderRedisKeyStoreAbsoluteFileName Absolute file name of the SSL KeyStore
    orderRedisTrustStoreAbsoluteFileName Absolute file name of the SSL TrustStore
    redisStatsHost Host address of the Redis server for storing order statistics
    redisStatsPort Port number of the Redis server for storing order statistics
    redisStatsUsername User name required to connect to the Redis cluster/node for statistics
    redisStatsPassword Password for connecting to the Redis cluster/node for statistics
    redisStatsDatabase Name of the Redis database for storing order statistics
    redisStatsClientName Name of the Redis client for storing order statistics
    redisStatsSslEnabled Enables SSL connection to the Redis cluster/node for statistics
    redisStatsKeyStoreType Type of the SSL KeyStore for Redis connections for statistics
    redisStatsKeyStorePassword Password for the SSL KeyStore for statistics
    redisStatsTrustStoreType Type of the SSL TrustStore for Redis connections for statistics.
    redisStatsTrustStorePassword Password for the SSL TrustStore for statistics
    redisStatsKeyStoreAbsoluteFileName Absolute file name of the SSL KeyStore for statistics
    redisStatsTrustStoreAbsoluteFileName Absolute file name of the SSL TrustStore for statistics
    catalogRedisClientName Redis server ClientName for Catalog datasource
    catalogRedisClusterEnabled Whether Redis is running in cluster mode
    catalogRedisDatabase Redis server database name for Catalog datasource
    catalogRedisHost Redis server host for storing Catalog models
    catalogRedisPassword Password to connect to Redis cluster/node
    catalogRedisPort Redis server port for storing Catalog models
    catalogRedisSslEnabled Connect to Redis cluster/node via SSL
    catalogRedisUsername User name to connect to Redis cluster/node
    redisBlockedWhenExhausted Enable connection blocking when the connection pool is exhausted
    redisJmxEnabled Enable JMX for connections
    catalogRedisKeyStoreAbsoluteFileName Redis SSL KeyStore absolute file name
    catalogRedisTrustStorePassword Redis SSL KeyStore password
    catalogRedisKeyStoreType Redis SSL KeyStore type
    redisLifo Enable LIFO behavior for idle objects, always returning the most recently used object from the pool
    redisMaxIdle Maximum number of idle connections in the pool
    redisMaxTotal Maximum number of connections that can be allocated by the pool at a given time
    redisMinEvictableIdleTimeMillis Minimum amount of time an object might sit idle in the pool, in milliseconds
    redisMinIdle Minimum number of idle connections to maintain in the pool
    redisNumTestsPerEvictionRun Maximum number of connections to examine during each eviction run
    redisSoftMinEvictableIdleTimeMillis Minimum amount of time an object might sit idle in the pool if minIdle instances are available, in milliseconds
    redisTestOnBorrow Enable connection validation before being borrowed from the pool
    redisTestOnReturn Enable connection validation before being returned to the pool
    redisTestWhileIdle Enable connection validation when idle in the connection pool
    redisTimeBetweenEvictionRunsMillis Number of milliseconds to sleep between runs of the idle object evictor thread
    catalogRedisTrustStoreAbsoluteFileName Redis SSL TrustStore absolute file name
    catalogRedisTrustStorePassword Redis SSL TrustStore password
    catalogRedisTrustStoreType Redis SSL TrustStore type
  5. In the $OM_HOME/externalLib/seed-data/app-properties/ConfigValues_DataService.JSON file under the Redis Data Source Configuration category, update the order Redis-related properties.

    Property Name Description
    orderRedisHost

    Host address of the Redis server for storing order data

    orderRedisClusterEnabled Indicates whether Redis is running in cluster mode
    orderRedisPort Port number of the Redis server for storing order models
    orderRedisUsername User name required to connect to the Redis cluster/node
    orderRedisPassword Password for connecting to the Redis cluster/node
    orderRedisDatabase Name of the Redis database for storing order-related information
    orderRedisClientName Name of the Redis client for storing order-related information
    redisTestOnBorrow Enables connection validation before being borrowed from the pool
    redisTestOnReturn Enables connection validation before being returned to the pool
    redisTestWhileIdle Enables connection validation when idle in the connection pool
    redisBlockedWhenExhausted Enables blocking of new connection requests when the connection pool is exhausted
    redisJmxEnabled Enables Java Management Extensions (JMX) for monitoring connections
    redisLifo Enables Last In, First Out (LIFO) behavior for managing idle objects in the pool
    redisMaxIdle Sets the maximum number of idle connections in the pool
    redisMinIdle Sets the minimum number of idle connections to maintain in the pool
    redisMaxTotal Sets the maximum number of connections that can be allocated by the pool at any time
    redisNumTestsPerEvictionRun Sets the maximum number of connections to examine during each eviction run
    redisSoftMinEvictableIdleTimeMillis Sets the minimum amount of time, in milliseconds, an object might sit idle in the pool if `minIdle` instances are available
    redisMinEvictableIdleTimeMillis Sets the minimum evictable idle time, in milliseconds, for objects in the pool
    redisTimeBetweenEvictionRunsMillis Sets the time, in milliseconds, between eviction runs for idle objects in the pool
    orderRedisSslEnabled Enables SSL connection to the Redis cluster/node
    redisKeyStoreType Specifies the type of the SSL KeyStore for Redis connections
    redisKeyStorePassword Password for the SSL KeyStore
    redisTrustStoreType Specifies the type of the SSL TrustStore for Redis connections
    redisTrustStorePassword Password for the SSL TrustStore
    redisKeyStoreAbsoluteFileName Absolute file name of the SSL KeyStore
    redisTrustStoreAbsoluteFileName Absolute file name of the SSL TrustStore