Struct RedisSentinelTemplate 

pub struct RedisSentinelTemplate { /* private fields */ }

Redis Sentinel template for high availability setup

Implementations

impl RedisSentinelTemplate

pub fn new(name: impl Into<String>) -> Self

Create a new Redis Sentinel template

pub fn master_name(self, name: impl Into<String>) -> Self

Set the master name for Sentinel monitoring

pub fn num_replicas(self, num: usize) -> Self

Set the number of Redis replicas

pub fn num_sentinels(self, num: usize) -> Self

Set the number of Sentinel instances

pub fn quorum(self, quorum: usize) -> Self

Set the quorum for failover decisions

pub fn master_port(self, port: u16) -> Self

Set the Redis master port

pub fn replica_port_base(self, port: u16) -> Self

Set the base port for replicas (will increment for each replica)

pub fn sentinel_port_base(self, port: u16) -> Self

Set the base port for Sentinels (will increment for each Sentinel)

pub fn password(self, password: impl Into<String>) -> Self

Set Redis password for authentication

pub fn down_after_milliseconds(self, ms: u32) -> Self

Set the time in milliseconds before master is considered down

pub fn failover_timeout(self, ms: u32) -> Self

Set the failover timeout in milliseconds

pub fn parallel_syncs(self, num: u32) -> Self

Set the number of parallel syncs during failover

pub fn with_persistence(self) -> Self

Enable persistence for Redis instances

pub fn network(self, network: impl Into<String>) -> Self

Use a specific network

pub fn announce_ip(self, ip: impl Into<String>) -> Self

Set the IP address to announce to Sentinel-aware clients.

By default Sentinel monitors the master by its container hostname and reports replica/sentinel addresses using internal Docker addresses, which are unreachable from a host-side client. Setting an announce IP makes the topology reachable from outside the Docker network:

• the monitored master is registered at <announce_ip>:<master_port>, so SENTINEL get-master-addr-by-name returns a host-reachable address,
• each replica announces <announce_ip>:<replica_host_port>,
• each sentinel announces <announce_ip>:<sentinel_host_port>.

Use 127.0.0.1 (or the host’s LAN address) when connecting from the machine running Docker.

pub fn custom_redis_image( self, image: impl Into<String>, tag: impl Into<String>, ) -> Self

Use a custom Redis image and tag

pub fn platform(self, platform: impl Into<String>) -> Self

Set the platform for the containers (e.g., “linux/arm64”, “linux/amd64”)

pub async fn start(self) -> Result<SentinelConnectionInfo, Error>

Start the Redis Sentinel cluster

Errors

Returns an error if:

• Network creation fails
• Starting any container (master, replica, or sentinel) fails

Trait Implementations

impl Template for RedisSentinelTemplate

fn name(&self) -> &str

Get the template name

fn config(&self) -> &TemplateConfig

Get the template configuration

fn config_mut(&mut self) -> &mut TemplateConfig

Get a mutable reference to the configuration

fn start<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String, TemplateError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Start the container with this template

fn start_and_wait<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String, TemplateError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Start the container and wait for it to be ready

fn is_running<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<bool, TemplateError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Check if the container is running

fn wait_for_ready<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), TemplateError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Wait for the container to be ready

fn stop<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), TemplateError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Stop the container

fn remove<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), TemplateError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove the container

fn build_command(&self) -> RunCommand

Build the RunCommand for this template

fn logs<'life0, 'life1, 'async_trait>( &'life0 self, follow: bool, tail: Option<&'life1 str>, ) -> Pin<Box<dyn Future<Output = Result<CommandOutput>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get container logs

fn exec<'life0, 'life1, 'async_trait>( &'life0 self, command: Vec<&'life1 str>, ) -> Pin<Box<dyn Future<Output = Result<ExecOutput>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute a command in the running container