Docker Image Naming Convention

Calliope Integration: This component is integrated into the Calliope AI platform. Some features and configurations may differ from the upstream project.

This document describes the standardized Docker image naming convention for Chat Studio (formerly Calliope AI) components.

Standard Image Names

All Chat Studio Docker images follow the calliopeai/ namespace prefix:

Component	Image Name	Description
Agent Backend	`calliopeai/agentic-chat:latest`	The backend API service with LLM integrations
UI Frontend	`calliopeai/chat-studio-ui:latest`	The React-based web interface

Usage Examples

Docker Compose

services:
  agent:
    image: calliopeai/agentic-chat:latest
    # ... configuration ...
    
  ui:
    image: calliopeai/chat-studio-ui:latest
    # ... configuration ...

Docker Commands

# Pull images
docker pull calliopeai/agentic-chat:latest
docker pull calliopeai/chat-studio-ui:latest

# Run containers
docker run -d --name agent calliopeai/agentic-chat:latest
docker run -d --name ui calliopeai/chat-studio-ui:latest

Building and Tagging

When building images locally, use the provided script to tag them with the standard names:

# Build images with original names
docker build -t chat-studio-agent ./agent
docker build -t chat-studio-ui ./sql-agent-ui

# Tag with standard names
./scripts/tag-images.sh

# Tag with specific version
./scripts/tag-images.sh v1.2.3

# Tag and push to registry
./scripts/tag-images.sh v1.2.3 --push

Hub Integration

The same images are used for both standalone and Hub deployments. The containers automatically detect Hub environment through JUPYTERHUB_* environment variables.

Version Tags

Images support multiple version tags:

latest - The most recent stable version
vX.Y.Z - Specific semantic version
dev - Development/unstable version

Example:

calliopeai/agentic-chat:latest
calliopeai/agentic-chat:v1.2.3
calliopeai/agentic-chat:dev

CI/CD Integration

In CI/CD pipelines, always use the full image name with registry prefix:

# GitHub Actions example
- name: Build and push
  run: |
    docker build -t calliopeai/agentic-chat:${{ github.sha }} ./agent
    docker push calliopeai/agentic-chat:${{ github.sha }}
    docker tag calliopeai/agentic-chat:${{ github.sha }} calliopeai/agentic-chat:latest
    docker push calliopeai/agentic-chat:latest

Migration from Old Names

If you have existing deployments using old image names, update them:

Old Name	New Name
`chat-studio-agent`	`calliopeai/agentic-chat`
`chat-studio/agent-hub`	`calliopeai/agentic-chat`
`chat-studio-ui`	`calliopeai/chat-studio-ui`
`chat-studio/ui-hub`	`calliopeai/chat-studio-ui`

CodeAct Agent - Project Documentation Extending JupyterLab: Integrating External REST API Agents