Skip to main content

Configure for Redis

Redis is an in-memory datastore, which can be used as a high-performance database, cache, and message broker. Redis is available for on-premises and cloud deployments. For more information, see https://redis.io/.

Uses:

The Designer Cloud Powered by Trifacta platform can be configured to use an accessible Redis server in your enterprise infrastructure. Uses include the following:

  • sending emails and webhook requests

  • caching authorization service requests

  • Managing concurrency issues and file locking while running conversion jobs

Prerequisites

  • Redis 6.2 or higher

  • Redis server must be accessible to the Trifacta node.

Install Redis server

Please install Redis server on an accessible node in your enterprise infrastructure. For more information, see https://redis.io/download.

Configure Designer Cloud Powered by Trifacta platform

Enable

Please complete the following steps to enable use of Redis in the Designer Cloud Powered by Trifacta platform.

Steps:

  1. You can apply this change through the Admin Settings Page (recommended) or trifacta-conf.json. For more information, see Platform Configuration Methods.

  2. Locate the following settings and set them to true:

    Setting

    Description

    "redis.enabled"

    Set to true to enable use of the specified Redis server as a distributed queue.

    "feature.enableRedisLocking"

    Set totrueto enable use of the specified Redis server for file locking during job execution.

  3. Configure the host and port number of the Redis server:

    Setting

    Description

    "redis.host"

    Hostname of the Redis server. If the server is hosted on the Trifacta node, enter the following:

    127.0.0.1
    "redis.port"

    Port number for the Redis server. Default value is 6379.

    "redis.password"

    Password to use for the Designer Cloud Powered by Trifacta platform to access the Redis server.

  4. Save your changes and restart the platform.

Configure for TLS

You can configure the Designer Cloud Powered by Trifacta platform to use TLS (SSL) when communicating with the Redis server.

Prerequisites:

  • You must install an SSL certificate on the Trifacta node. For more information, see Enable SSL for Databases.

    Note

    If you have already configured SSL for use with the Alteryx databases, then you have already installed the SSL certificate and configured its use. In this case, you only need to set the enable flag below for use of SSL with the Redis flag and provide any additional NodeJS options. The other settings are shared between these two features.

Steps:

  1. You can apply this change through the Admin Settings Page (recommended) or trifacta-conf.json. For more information, see Platform Configuration Methods.

  2. To enable TLS for Redis, locate the following setting and set it to true:

    "redis.tls.enabled": true,

  3. If you have not configured TLS for the Alteryx databases, please complete the following configuration:

    Setting

    Description

    "redis.tls.serverCertificateAuthorityFile"

    (optional) Path on the Trifacta node to the certificate authority verification file, which is used to verify the presented server certificate.

    "redis.tls.clientKeyFile"

    (optional) Path on the Trifacta node to the client key file, which is used for client authentication.

    "redis.tls.clientCertificateFile"

    (optional) Path on the Trifacta node to the SSL certificate to use for client authentication.

    "redis.tls.additionalOptions"

    JSON string of additional TLS properties. Properties should be the same ones accepted by NodeJS's tls.connect() method. For more information, see https://nodejs.org/api/tls.html#tls_tls_connect_options_callback.

  4. Save your changes and restart the platform.

Configure for high availability

If you have deployed the Designer Cloud Powered by Trifacta platform in a high availability environment, you can configure the platform to work with Redis Sentinel to manage master and failover Redis instances. Please complete the following configuration steps.

Note

These settings must be applied on each instance of the Trifacta node.

Steps:

  1. You can apply this change through the Admin Settings Page (recommended) or trifacta-conf.json. For more information, see Platform Configuration Methods.

  2. If you have not done so already, enable the Redis parameters.

    Note

    When Redis sentinel is enabled for use by the Designer Cloud Powered by Trifacta platform, the host and port options for Redis are ignored. Please enable the service and complete the following configuration.

  3. Configure the following to use Sentinel:

    Setting

    Description

    redis.useSentinel

    Set this value to true to enable Redis Sentinel.

    redis.SentinelOpts.sentinels

    Enter a comma-separated list of available sentinels to which the Trifacta node can connect.

    redis.sentinelOpts.name

    Enter a comma-separated list of Redis hosts to which you can connection.

  4. Save your changes and restart the platform.

In this section: