Install

Install#

Building Docker from Source#

If you prefer to build the image from source instead of using the pre-built image:

Build Process#

# Build the Docker image
docker build -t orchestrator:local .

Environment Setup#

The following sections describe how to set up a local development environment.

Linux Environment Setup#

Prerequisites#

Before starting, ensure you have the following system requirements:

  • Ubuntu 20.04 or compatible Linux distribution

  • Internet connection for downloading packages

Step 1: Install Protocol Buffers Compiler#

Download and install protoc for protocol buffer compilation:

# Create protoc directory
mkdir -p protoc
cd protoc

# Download protoc
curl -LjO https://github.com/protocolbuffers/protobuf/releases/download/v31.1/protoc-31.1-linux-x86_64.zip

# Extract and set permissions
unzip protoc-31.1-linux-x86_64.zip
rm -f protoc-31.1-linux-x86_64.zip
chmod +x bin/protoc

# Verify installation
bin/protoc --version

# Go back to the root directory
cd ..

Step 2: Set Up Python#

You need Python 3.10 or higher to run this project. This document provides one method using conda for Python installation as a reference.

Install Python using Miniconda:

# Download Miniconda installer
wget -q https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh

# Install Miniconda
bash Miniconda3-latest-Linux-x86_64.sh

# Clean up installer
rm -f Miniconda3-latest-Linux-x86_64.sh

# Configure conda channels
conda config --add channels conda-forge
conda tos accept

# Create orchestrator environment with Python 3.10
conda create -n orchestrator python=3.10 -y

# Activate the environment
conda activate orchestrator

Step 3: Install the Project#

Install the orchestrator package:

# Ensure you're in the project root directory
cd /path/to/orchestrator

# Activate conda environment
conda activate orchestrator

# Install the package
pip install .

Step 4: Verify Installation#

Test that everything is working correctly:

# Activate the environment
conda activate orchestrator

# Check if orchestrator.service can be imported
python -c "import orchestrator.service; print('orchestrator.service imported successfully')"

# Check if the main application runs
python main.py --help

Environment Activation#

To work with the orchestrator backend project, always activate the conda environment first:

# Activate the environment
conda activate orchestrator

# Your terminal prompt should now show (orchestrator)
# You can now run Python scripts and use the orchestrator package

Windows Environment Setup#

Prerequisites#

Before starting, ensure you have the following system requirements:

  • Windows 10/11 or compatible Windows distribution

  • Internet connection for downloading packages

Step 1: Install Protocol Buffers Compiler#

Download and install protoc for protocol buffer compilation:

  1. Download protoc:

  2. Extract the files:

    • Create a protoc folder in your project root directory

    • Extract the downloaded protoc-31.1-win64.zip file into the protoc folder

    • Ensure the executable file is located at: protoc\bin\protoc.exe

  3. Verify installation:

    # Open Command Prompt in your project directory
protoc\bin\protoc.exe --version

Step 2: Set Up Python#

You need Python 3.10 or higher to run this project. This document provides one method using conda for Python installation as a reference.

Install Python using Miniconda:

  1. Download and Install Miniconda:

    • Visit Miniconda Installation Guide

    • Download the Windows installer from the Anaconda website

    • Follow the official installation instructions to install Miniconda

    • Important: During installation, make sure to check “Add Miniconda3 to my PATH environment variable” or add the Miniconda3/Scripts directory to the PATH environment variable manually to enable conda commands from any terminal

  2. Create and Activate Environment:

    # Create orchestrator environment with Python 3.10
conda create -n orchestrator python=3.10 -y

# Activate the environment
conda activate orchestrator

Step 3: Install the Project#

Install the orchestrator backend package:

# Ensure you're in the project root directory
cd /path/to/orchestrator

# Activate conda environment
conda activate orchestrator

# Temporarily add protoc to PATH for this session
set PATH=%PATH%;%CD%\protoc\bin

# Install the package
pip install .

Step 4: Verify Installation#

Test that everything is working correctly:

# Activate the environment
conda activate orchestrator

# Check if orchestrator.service can be imported
python -c "import orchestrator.service; print('orchestrator.service imported successfully')"

# Check if the main application runs
python main.py --help

Environment Activation#

To work with the orchestrator project, always activate the conda environment first:

# Activate the environment
conda activate orchestrator

# Your terminal prompt should now show (orchestrator)
# You can now run Python scripts and use the orchestrator package

Local Development#

After completing the environment setup, you can start the service locally:

# Activate the conda environment
conda activate orchestrator

# Start the service
python main.py --config_path configs/local.py
Contents