Stop Docker Compose Task

A task that stops a running Docker Compose service identified by brick name and unique name.

Overview

This task allows you to stop and tear down Docker containers that were previously started using Docker Compose. It validates the existence of the specified brick and stops the Docker Compose deployment through the Docker service.

Exceptions

• BadRequestException: Raised if the specified brick does not exist
• Docker service exceptions: May be raised during compose stop operation

Usage Notes

• The brick_name and unique_name must match those used when starting the compose
• This task only stops the compose; it does not remove volumes or networks
• Use this task to gracefully shut down Docker services before cleanup or redeployment

Example

To stop a compose that was started with brick_name="my_brick" and unique_name="web_service_1", use the same parameters in this task to stop it.