📦 torero container

Container image for torero, built using vendor-neutral Containerfile specifications and packaged in a ready-to-use container with optional OpenTofu installation. The image is hosted on GitHub Container Registry (GHCR). For more details about torero, visit the official docs.

Note

For questions or real-time feedback, you can connect with us directly in the Network Automation Forum (NAF) Slack Workspace in the #tools-torero channel.

✨ Features

• Built with vendor-neutral Containerfile for maximum compatibility
• Multi-architecture support (AMD64 and ARM64)
• Based on debian-slim for minimal footprint
• Hosted on GitHub Container Registry (GHCR) for reliable distribution
• Includes torero installed and ready to go
• Optional OpenTofu installation at runtime
• Optional SSH administration for testing convenience + labs
• Optional torero-api launcher for API access
• Optional torero-mcp launcher for Model Context Protocol server

Inspiration

Managing and automating a hybrid, multi-vendor infrastrcuture that encompasses on-premises systems, private and public clouds, edge computing, and colocation environments poses significant challenges. How can you experiment to learn without breaking things? How can you test new and innovative products like torero on the test bench without friction to help in your evaluation? How do you test the behavior of changes in lower level environments before making changes to production? I use containerlab for all of the above! This project makes it easy to insert torero in your containerlab topology file, connect to the container, and run your experiments -- the sky is the limit!

Getting Started

To get started you can use any OCI-compatible container runtime (Docker, Podman, etc.) with CLI or compose.

docker cli

docker run -d -p 2222:22 ghcr.io/torerodev/torero-container:latest

docker compose (with latest OpenTofu version)

---
services:
  torero:
    image: ghcr.io/torerodev/torero-container:latest
    container_name: torero
    ports:
      - "22:22"                # use when ENABLE_SSH_ADMIN=true
      - "8000:8000"            # use when ENABLE_API=true
      - "8080:8080"            # use when ENABLE_MCP=true
    volumes:
      - ./data:/home/admin/data
    environment:
      - ENABLE_API=true        # enable and run torero api
      - API_PORT=8000          # api port
      - ENABLE_MCP=true        # enable torero-mcp server
      - ENABLE_SSH_ADMIN=true  # enable ssh admin at runtime
      - INSTALL_OPENTOFU=true  # enable OpenTofu installation at runtime
      - OPENTOFU_VERSION=1.9.0
      - PYTHON_VERSION=3.13.0
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "torero", "version"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 5s
...

Connecting to the container

You can connect to the container with 'admin' when ENABLE_SSH_ADMIN=true is set during runtime.

ssh admin@localhost -p 2222  # default password: admin

Environment Variables

The following environment variables can be set at runtime:

Variable	Default	Description
ENABLE_API	false	Enable torero API
API_PORT	8000	Set API port
ENABLE_MCP	false	Enable torero MCP server
ENABLE_SSH_ADMIN	false	Enable SSH admin user
INSTALL_OPENTOFU	true	Install OpenTofu
OPENTOFU_VERSION	1.9.0	Set OpenTofu version
PYTHON_VERSION	3.13.0	Set Python version

MCP Server Environment Variables

When ENABLE_MCP=true, the following additional environment variables are available:

Variable	Default	Description
TORERO_MCP_TRANSPORT_TYPE	sse	MCP transport type
TORERO_MCP_TRANSPORT_HOST	0.0.0.0	MCP server host
TORERO_MCP_TRANSPORT_PORT	8080	MCP server port
TORERO_MCP_TRANSPORT_PATH	/sse	SSE endpoint path
TORERO_API_BASE_URL	http://localhost:8000	torero API base URL
TORERO_API_TIMEOUT	30	API request timeout in seconds
TORERO_LOG_LEVEL	INFO	Logging level
TORERO_MCP_PID_FILE	/tmp/torero-mcp.pid	PID file location
TORERO_MCP_LOG_FILE	/home/admin/.torero-mcp.log	Log file path

CLI runner script

The cli-runner.sh script provides a convenient way to run, test, and do house cleaning locally when running on your workstation. I use it for quick and dirty testing 🚀

# build + run
./cli-runner.sh --build --run

# run and immediately ssh into container
./cli-runner.sh --run --ssh

# run with torero-api enabled on default port 8000
./cli-runner.sh --run --enable-api

# run with torero-api on custom port
./cli-runner.sh --run --enable-api --api-port 8001

# run with torero-mcp enabled on default port 8080
./cli-runner.sh --run --enable-mcp

# run with torero-mcp on custom port
./cli-runner.sh --run --enable-mcp --mcp-port 9080

# check status
./cli-runner.sh --status

# stop container
./cli-runner.sh --stop

# start a stopped container
./cli-runner.sh --start

# view logs
./cli-runner.sh --logs

# clean up everything (will prompt before deleting local data)
./cli-runner.sh --clean

Container Architecture

This project uses vendor-neutral Containerfile specifications for maximum compatibility across container runtimes. The image is built and distributed through GitHub Container Registry (GHCR) for reliable access and version management.

Multi-Architecture Support

The container images support both AMD64 and ARM64 architectures. The appropriate architecture will be selected automatically based on your host system when pulling the image.

For building multi-architecture images locally:

# build for multiple platforms
make build-multi PLATFORMS=linux/amd64,linux/arm64

# build for local platform only
make build

Software Licenses

This project incorporates the following software with their respective licenses:

• torero: refer to the torero license
• opentofu: mozilla public license 2.0
• debian: multiple licenses

All modifications and original code in this project are licensed under the apache license 2.0.