Lock Stores

​

InMemoryLockStore (default)

• Description InMemoryLockStore is the default lock store. It maintains conversation locks within a single process.

• Configuration To use the InMemoryTrackerStore no configuration is needed.

​

ConcurrentRedisLockStore

​

Description

​

High Availability Support

• Redis Cluster Mode: Provides horizontal scaling and is compatible with cloud-hosted Redis services.
• Redis Sentinel Mode: Offers high availability through automatic master/slave failover.
• Standard Mode: Maintains backward compatibility with existing single-instance deployments.

​

Configuration

1. Add required configuration to your endpoints.yml:

  lock_store:
      type: rasa_plus.components.concurrent_lock_store.ConcurrentRedisLockStore
      host: "host of the redis instance, e.g. localhost/"
      port: "port of your redis instance, usually 6379/"
      password: "password used for authentication"
      db: "number of your database within redis, e.g. 0. Not used in cluster mode"
      key_prefix: "alphanumeric value to prepend to lock store keys"
      # high availability parameters introduced in 3.14 below
      deployment_mode: "standard, cluster, or sentinel"
      endpoints: "list of redis cluster/sentinel node addresses in the format host:port"
      sentinel_service: "name of the redis sentinel service, only used in sentinel mode"

  lock_store:
      type: concurrent_redis
      host: "host of the redis instance, e.g. localhost"
      port: "port of your redis instance, usually 6379"
      password: "password used for authentication"
      db: "number of your database within redis, e.g. 0. Not used in cluster mode"
      key_prefix: "alphanumeric value to prepend to lock store keys"
      # high availability parameters introduced in 3.14 below
      deployment_mode: "standard, cluster, or sentinel"
      endpoints: "list of redis cluster/sentinel node addresses in the format host:port"
      sentinel_service: "name of the redis sentinel service, only used in sentinel mode"

2. To start the Rasa server using your Redis backend, add the --endpoints flag, e.g.:

rasa run -m models --endpoints endpoints.yml

​

Configuration Parameters

• url (default: localhost): The url of your redis instance
• port (default: 6379): The port which redis is running on
• db (default: 1): The number of your redis database. Ignored in cluster mode as Redis Cluster always uses database 0
• key_prefix (default: None): The prefix to prepend to lock store keys. Must be alphanumeric
• password (default: None): Password used for authentication (None equals no authentication)
• use_ssl (default: False): Whether the communication is encrypted
• socket_timeout (default: 10): Time in seconds after which an error is raised if Redis doesn’t answer
• deployment_mode (default: standard): Deployment mode of Redis. One of standard, cluster, or sentinel.
• endpoints (default: None): List of Redis cluster node addresses in the format host:port. Used for cluster and sentinel modes. For cluster mode, these are cluster node endpoints. For sentinel mode, these are sentinel instance endpoints.
• sentinel_service (default: mymaster): Name of the Redis sentinel service. Only used in sentinel mode.

​

Deployment Mode Details

• Standard Mode: Connects to a single Redis instance using url and port parameters.
• Cluster Mode: Connects to a Redis Cluster for horizontal scaling. If endpoints is not provided, falls back to auto-discovery using url and port.
• Sentinel Mode: Connects to Redis Sentinel for high availability with automatic master/slave failover.

​

Choosing a Deployment Mode

• Use standard mode for simple deployments with a single Redis instance.
• Use cluster mode for horizontal scaling and when using cloud Redis services that require cluster mode.
• Use sentinel mode for high availability with master/slave replication and automatic failover.

​

Using IAM roles to authenticate to AWS ElastiCache for Redis

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "elasticache:Connect"
            ],
            "Resource": "*"
        }
    ]
}

• IAM_CLOUD_PROVIDER: Set this to aws.
• AWS_DEFAULT_REGION: Set this to the AWS region where your ElastiCache cluster or replication group is located.
• AWS_ELASTICACHE_CLUSTER_NAME: Set this to the name of your ElastiCache cluster or replication group.
• ELASTICACHE_REDIS_AWS_IAM_ENABLED: Set this to true to enable IAM authentication for ElastiCache Redis connections.

lock_store:
    type: concurrent_redis
    host: "master redis host of your elasticache cluster or replication group"
    port: "6379"
    use_ssl: true
    username: your-iam-username
    ssl_ca_certs: "/path/to/your/ca-certificate.pem" # Optional, path to the root certificate from Amazon Trust Services

​

Migration Guide

lock_store:
    type: rasa_plus.components.concurrent_lock_store.ConcurrentRedisLockStore
    host: "host of the redis instance, e.g. localhost"
    port: "port of your redis instance, usually 6379"
    password: "password used for authentication"
    db: "number of your database within redis, e.g. 0. Not used in cluster mode"
    key_prefix: "alphanumeric value to prepend to lock store keys"
    # high availability parameters introduced in 3.14 below
    deployment_mode: <standard, cluster, or sentinel>
    endpoints: <list of redis cluster/sentinel node addresses in the format host:port>
    sentinel_service: <name of the redis sentinel service, only used in sentinel mode>

lock_store:
    type: concurrent_redis
    host: "host of the redis instance, e.g.localhost"
    port: "port of your redis instance, usually 6379"
    password: "password used for authentication"
    db: "number of your database within redis, e.g. 0. Not used in cluster mode"
    key_prefix: "alphanumeric value to prepend to lock store keys"
    # high availability parameters introduced in 3.14 below
    deployment_mode: <standard, cluster, or sentinel>
    endpoints: <list of redis cluster/sentinel node addresses in the format host:port>
    sentinel_service: <name of the redis sentinel service, only used in sentinel mode>

​

RedisLockStore

​

Description

​

High Availability Support

• Redis Cluster Mode: Provides horizontal scaling and is compatible with cloud-hosted Redis services.
• Redis Sentinel Mode: Offers high availability through automatic master/slave failover.
• Standard Mode: Maintains backward compatibility with existing single-instance deployments.

​

Configuration

1. Add required configuration to your endpoints.yml

lock_store:
    type: "redis"
    url: <url of the redis instance, e.g. localhost>
    port: <port of your redis instance, usually 6379>
    password: <password used for authentication>
    db: <number of your database within redis, e.g. 0. Not used in cluster mode>
    key_prefix: <alphanumeric value to prepend to lock store keys>
    # high availability parameters introduced in 3.14 below
    deployment_mode: <standard, cluster, or sentinel>
    endpoints: <list of redis cluster/sentinel node addresses in the format host:port>
    sentinel_service: <name of the redis sentinel service, only used in sentinel mode>

2. To start the Rasa server using your Redis backend, add the --endpoints flag, e.g.:

rasa run -m models --endpoints endpoints.yml

​

Configuration Parameters

• url (default: localhost): The url of your redis instance
• port (default: 6379): The port which redis is running on
• db (default: 1): The number of your redis database. Ignored in cluster mode as Redis Cluster always uses database 0
• key_prefix (default: None): The prefix to prepend to lock store keys. Must be alphanumeric
• username (default: None): Username used for authentication
• password (default: None): Password used for authentication (None equals no authentication)
• use_ssl (default: False): Whether or not the communication is encrypted
• ssl_keyfile (default: None): Path to an ssl private key
• ssl_certfile (default: None): Path to an ssl certificate
• ssl_ca_certs (default: None): The path to a file of concatenated CA certificates in PEM format
• socket_timeout (default: 10): Time in seconds after which an error is raised if Redis doesn’t answer
• deployment_mode (default: standard): Deployment mode of Redis. One of standard, cluster, or sentinel.
• endpoints (default: None): List of Redis cluster node addresses in the format host:port. Used for cluster and sentinel modes. For cluster mode, these are cluster node endpoints. For sentinel mode, these are sentinel instance endpoints.
• sentinel_service (default: mymaster): Name of the Redis sentinel service. Only used in sentinel mode.

​

Deployment Mode Details

• Standard Mode: Connects to a single Redis instance using url and port parameters.
• Cluster Mode: Connects to a Redis Cluster for horizontal scaling. If endpoints is not provided, falls back to auto-discovery using url and port.
• Sentinel Mode: Connects to Redis Sentinel for high availability with automatic master/slave failover.

​

Choosing a Deployment Mode

• Use standard mode for simple deployments with a single Redis instance.
• Use cluster mode for horizontal scaling and when using cloud Redis services that require cluster mode.
• Use sentinel mode for high availability with master/slave replication and automatic failover.

​

Using IAM roles to authenticate to AWS ElastiCache (for Redis)

​

Custom Lock Store

• get_lock: fetches lock for conversation_id from storage; requires conversation_id text parameter and returns TicketLock instance. (source code - see for signature).
• save_lock: commit lock object to storage; requires lock parameter which is of type TicketLockand returns None. (source code - see for signature).
• delete_lock: deletes lock for conversation_id from storage; requires conversation_id text parameter and returns None. (source code - see for signature).

​

Configuration

lock_store:
  type: path.to.your.module.Class
  url: localhost
  a_parameter: a value
  another_parameter: another value