mlox.services.kafka

Kafka service package.

@dataclass

class KafkaDockerService(mlox.service.AbstractService):

Docker based deployment for a single-node Kafka broker.

KafkaDockerService( name: str, service_config_id: str, template: str, target_path: str, ssl_password: str, ssl_port: str | int)

ssl_password: str

ssl_port: str | int

service_url: str = ''

container_name: str = 'kafka'

compose_service_names: Dict[str, str]

cluster_id: str

def setup(self, conn) -> None:

def teardown(self, conn) -> None:

def spin_up(self, conn) -> bool:

Start the service.

Concrete services should override this method to perform any provisioning logic required to run the service. The default implementation exists solely to satisfy type checkers and unit tests that rely on instantiating AbstractService subclasses without providing spin control behavior.

def spin_down(self, conn) -> bool:

Stop the service.

def check(self, conn) -> Dict:

def get_secrets(self) -> Dict[str, Dict]:

Return a mapping of secret identifiers to structured secret payloads.

Inherited Members

mlox.service.AbstractService: name; service_config_id; template; target_path; uuid; target_docker_script; target_docker_env; service_urls; service_ports; state; certificate; exec; set_task_executor; compose_up; compose_down; compose_service_status; compose_service_log_tail; get_dependent_service; dump_state