Struct RedisClusterTemplate 

pub struct RedisClusterTemplate { /* private fields */ }

Redis Cluster template for automatic multi-node cluster setup

Implementations

impl RedisClusterTemplate

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

Create a new Redis Cluster template with default settings

pub fn num_masters(self, masters: usize) -> Self

Set the number of master nodes (minimum 3)

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

Set the number of replicas per master

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

Set the base port for Redis nodes

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

Set cluster password

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

Set the IP to announce to other cluster nodes

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

Enable persistence with volume prefix

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

Set memory limit per node

pub fn cluster_node_timeout(self, timeout: u32) -> Self

Set cluster node timeout in milliseconds

pub fn auto_remove(self) -> Self

Enable auto-remove when stopped

pub fn with_redis_stack(self) -> Self

Use Redis Stack instead of standard Redis (includes modules like JSON, Search, Graph, TimeSeries, Bloom)

pub fn with_redis_insight(self) -> Self

Enable RedisInsight GUI for cluster visualization and management

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

Set the port for RedisInsight UI (default: 8001)

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 cluster_info(&self) -> Result<ClusterInfo, TemplateError>

Check cluster status

Trait Implementations

impl Template for RedisClusterTemplate

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 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 is_running<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

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

Check if the container is running

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