Start Docker Compose Task

A task that starts a Docker Compose service from YAML configuration.

Overview

This task allows you to deploy and start Docker containers using Docker Compose configuration. It validates the existence of the specified brick, processes the YAML configuration, and initiates the Docker Compose deployment through the Docker service.

Input/Output

• Inputs:
  • yaml_file (optional): File resource containing Docker Compose YAML configuration
• Output: JSONDict resource containing the Docker Compose operation response

Configuration Parameters

Behavior

1. Input Priority: If a file input is provided, it takes precedence over the config parameter
2. Validation: Checks that either file input or config parameter contains YAML configuration
3. Brick Validation: Verifies that the specified brick exists in the system
4. Deployment: Starts the Docker Compose using the YAML configuration
5. Response: Returns a structured JSON response with deployment status and output

Output Format

The output JSONDict contains:

• message: Status message from the Docker service
• output: Detailed output from the Docker Compose operation
• brick_name: The brick name used for deployment
• unique_name: The unique name assigned to this compose instance

Exceptions

• BadRequestException: Raised if:
  • Neither file input nor config parameter is provided
  • The specified brick does not exist
• Docker service exceptions: May be raised during compose deployment

Usage Options

Option 1: Using File Input

Connect a File resource containing your docker-compose.yml to the yaml_file input. The config yaml_config parameter can be left empty.

Option 2: Using Config Parameter

Leave the yaml_file input unconnected and provide the YAML configuration directly in the yaml_config parameter using the YAML code editor.

Example YAML Configuration

## Example Docker Compose YAML configuration
version: '3.8'
services:
  web:
    image: nginx:latest
    ports:
      - "80:80"
    environment:
      - ENV_VAR=value