idmtools_platform_local.infrastructure.redis module

idmtools redis service.

Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.

class idmtools_platform_local.infrastructure.redis.RedisContainer(container_name: str = 'idmtools_redis', image: str = 'redis:5.0.4-alpine', client: Optional[docker.client.DockerClient] = None, config_prefix: str = 'redis_', network: Optional[str] = None, host_data_directory: Optional[str] = None, mem_limit: str = '256m', mem_reservation: str = '64m', run_as: Optional[str] = None, port: int = 6379, data_volume_name: Optional[str] = None)

Bases: idmtools_platform_local.infrastructure.base_service_container.BaseServiceContainer

Provides the redis container for local platform.

host_data_directory: str = None

mem_limit: str = '256m'

mem_reservation: str = '64m'

run_as: str = None

port: int = 6379

image: str = 'redis:5.0.4-alpine'

data_volume_name: str = None

container_name: str = 'idmtools_redis'

config_prefix: str = 'redis_'

get_configuration() → dict

Get our configuration to run redis.

Returns:

Redis config.

__init__(container_name: str = 'idmtools_redis', image: str = 'redis:5.0.4-alpine', client: Optional[docker.client.DockerClient] = None, config_prefix: str = 'redis_', network: Optional[str] = None, host_data_directory: Optional[str] = None, mem_limit: str = '256m', mem_reservation: str = '64m', run_as: Optional[str] = None, port: int = 6379, data_volume_name: Optional[str] = None) → None