Skip to main content

ARL Infrastructure - Python SDK for Kubernetes-based Agent Runtime Layer

Project description

ARL Wrapper

High-level Python wrapper for the ARL (Agent Runtime Layer) client providing simplified sandbox session management.

Features

  • Context Manager Support: Automatic sandbox lifecycle management
  • Type-Safe API: Full type hints with Pydantic models
  • Kubernetes Integration: Direct CRD interaction
  • Error Handling: Comprehensive error reporting and retry logic

Installation

uv add arl-wrapper

Quick Start

Prerequisites

Ensure you have a WarmPool created. You can create one programmatically:

from arl import WarmPoolManager

# Create WarmPool (one-time setup)
warmpool_mgr = WarmPoolManager(namespace="default")
warmpool_mgr.create_warmpool(
    name="python-39-std",
    image="python:3.9-slim",
    replicas=2  # Number of pre-warmed pods
)
warmpool_mgr.wait_for_warmpool_ready("python-39-std")
print("✓ WarmPool ready!")

Basic Usage

from arl import SandboxSession

# Using context manager (recommended)
with SandboxSession(pool_ref="python-39-std", namespace="default") as session:
    result = session.execute([
        {
            "name": "hello",
            "type": "Command",
            "command": ["echo", "Hello, World!"],
        }
    ])
    
    # Access results
    status = result["status"]
    print(f"Task State: {status.get('state')}")
    print(f"Output: {status.get('stdout')}")

Manual Lifecycle Management

For long-running operations or sandbox reuse:

from arl import SandboxSession

session = SandboxSession(pool_ref="python-39-std", namespace="default", keep_alive=True)

try:
    session.create_sandbox()
    print("✓ Sandbox allocated")
    
    # Task 1: Initialize workspace
    result1 = session.execute([
        {"name": "init", "type": "Command", "command": ["mkdir", "-p", "/workspace"]}
    ])
    
    # Task 2: Reuses same sandbox (fast!)
    result2 = session.execute([
        {"name": "work", "type": "Command", "command": ["ls", "/workspace"]}
    ])
    
finally:
    session.delete_sandbox()
    print("✓ Sandbox cleaned up")

WarmPool Management

WarmPools pre-create pods to eliminate cold-start delays:

from arl import WarmPoolManager

warmpool_mgr = WarmPoolManager(namespace="default")

# Create a new pool
warmpool_mgr.create_warmpool(
    name="python-39-std",
    image="python:3.9-slim",
    sidecar_image="your-registry/arl-sidecar:latest",  # Optional
    replicas=3,
    resources={  # Optional
        "requests": {"cpu": "500m", "memory": "512Mi"},
        "limits": {"cpu": "1", "memory": "1Gi"}
    }
)

# Wait for readiness
warmpool_mgr.wait_for_warmpool_ready("python-39-std", timeout=300)

# List all pools
pools = warmpool_mgr.list_warmpools()
for pool in pools:
    print(f"Pool: {pool['metadata']['name']}, Status: {pool['status']['phase']}")

# Delete a pool
warmpool_mgr.delete_warmpool("python-39-std")

Task Step Types

Command Step

{
    "name": "run_script",
    "type": "Command",
    "command": ["python", "script.py"],
    "env": {"DEBUG": "1"},  # optional
    "workDir": "/workspace",  # optional
}

FilePatch Step

{
    "name": "create_config",
    "type": "FilePatch",
    "path": "/workspace/config.yaml",
    "content": "key: value",
}

Architecture

  • SandboxSession: High-level API using Kubernetes CRDs for task execution
  • Task CRD: Operator watches and executes tasks via sidecar
  • Auto-generated client: arl-client package (CRD models)

Task execution flow:

  1. Client creates Task CRD via Kubernetes API
  2. Operator watches for new tasks
  3. Operator communicates with sidecar to execute steps
  4. Client polls Task status for results

This architecture ensures tasks can be executed from anywhere with cluster access.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arl_env-0.12.1.tar.gz (20.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arl_env-0.12.1-py3-none-any.whl (23.8 kB view details)

Uploaded Python 3

File details

Details for the file arl_env-0.12.1.tar.gz.

File metadata

  • Download URL: arl_env-0.12.1.tar.gz
  • Upload date:
  • Size: 20.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for arl_env-0.12.1.tar.gz
Algorithm Hash digest
SHA256 db69efefed6a07970a257576b232f1e0e4d0a3ab45962036902d9bde6578feef
MD5 26df688b530f9220da9b0be74bf258f6
BLAKE2b-256 ee2a370bae70e22c3f20255219d1d4dac2c9853259d942ed500a8e3cdb3db386

See more details on using hashes here.

File details

Details for the file arl_env-0.12.1-py3-none-any.whl.

File metadata

  • Download URL: arl_env-0.12.1-py3-none-any.whl
  • Upload date:
  • Size: 23.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for arl_env-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ac1e22227f12a945a48a433bd27cc3ef9b72cf5aeb3435d6f5d47f8f3200bc47
MD5 1449729a48569a4a09830dba2880be29
BLAKE2b-256 87eae12771783dff856578ad4aedcfd2efa3e1e4914d4a1d9fb6988c885f78e5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page