Configuring Redis Properties
  • 07 Feb 2024
  • Dark
    Light
  • PDF

Configuring Redis Properties

  • Dark
    Light
  • PDF

Article summary

Core Redis Properties

The core Redis properties are configured by default to connect to a Redis process running on the same server as IAP. A password may be configured if the Redis server requires authentication.

The following properties are commonly applied to the core Redis configuration.

Property Description
host The host name or IP address of the Redis server. IPv6 and IPv4 addresses are supported.
port The port number for the Redis server. The default port is 6379.
password The password for the Redis server to secure access to the data. It can be provided in clear-text or in encrypted fashion, e.g., $ENCABC1234.
maxRetriesPerRequest The maximum number of connection retries on a lost Redis link. The default is 20.
maxHeartbeatWriteRetries The maximum number of write retries on the lost ability to write data in Redis. The default is 20.

Also see: Installing Redis as an IAP Dependency

Standalone Redis Configuration

{
    ...
    "redisProps": {
        "host": "127.0.0.1",
        "port": 6379,
        "password": "$ENC87eb897b507afc1796db49409dd02e1d848a208ca9d74593",
        "maxRetriesPerRequest": 20,
        "maxHeartbeatWriteRetries": 20
    },
    ...
}

Redis HA Configuration

{
    "id": "redis",
    "type": "Redis",
    "properties": {
        "name": "mymaster",
        "password": "$ENC87eb897b507afc1796db49409dd02e1d848a208ca9d74593",
        "sentinels": [
            {
                "host": "redis1",
                "port": 26379
            },
            {
                "host": "redis2",
                "port": 26379
            },
            {
                "host": "redis3",
                "port": 26379
            }
        ],
        "maxRetriesPerRequest": 20,
        "maxHeartbeatWriteRetries": 20
    }
}

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.