Skip to main content

Templates

Overview​

Templates in Celium are configuration blueprints that define how GPU-enabled Docker containers are created and deployed for renters. They provide a standardized way to specify all necessary parameters for container creation, ensuring consistent and reliable deployment of GPU environments across the platform.

Each template contains essential Docker configuration parameters that determine how the GPU environment will be set up, including the base image, environment variables, storage requirements, and network settings. Templates streamline the process of launching GPU environments by providing a reusable configuration that can be easily deployed by renters.

How It Works​

Template Structure​

A template in Celium consists of several required components:

  1. Docker Image Configuration

    • Docker image name
    • Image tag version
    • These determine the base environment for your GPU container

  2. Environment Variables

    • Custom environment variables needed for your applications
    • System configuration parameters
    • Runtime settings

  3. Volume Configuration

    • Storage volume specifications
    • Mount points for persistent data
    • Access permissions

  4. Network Settings

    • Port exposure configurations
    • Which ports should be accessible
    • Network interface settings

  5. Startup Commands

    • Container initialization commands
    • Service startup parameters
    • Runtime configurations

Template Types​

  • Official Templates: These are templates that are maintained by the Celium team. They are verified and trusted to be secure and functional.
  • Custom Templates: These are templates that are created by users.
    • Public Templates
    • Private Templates

Template Verification​

Why Verification Matters​

Custom templates in Celium are user-defined configurations for GPU environments. While this flexibility is powerful, it's crucial to ensure these templates work correctly before deployment. To maintain platform reliability, Celium implements a robust template verification system that validates all custom templates before they can be used in production.

Verification Process​

The verification process consists of four key steps:

  1. Test Deployment

    • Creates a container on dedicated verification servers
    • Uses exact template configurations
    • Simulates real deployment conditions

  2. Container Readiness Check

    • Monitors container startup process
    • Tracks initialization of required services
    • Handles different startup patterns

  3. SSH Connection Validation

    • Verifies SSH accessibility
    • Confirms proper credential handling
    • Tests connection stability

  4. Error Reporting

    • Provides detailed error logs if verification fails
    • Identifies specific configuration issues
    • Offers troubleshooting guidance

Verification Prequisities​

  • Your container must remain running continuously (no immediate exits)
  • Docker image should be publicly accessible.

To verify if your container can be passed:

Run docker container with your docker image.

docker run [-e <env-var>=<value>] -d <your-docker-image>:<image-tag> <your-startup-command>

Then, check if container keeps running in docker ps.