netresearch/ofelia v0.11.0

v0.11.0 - Critical Fixes & Performance Improvements

on GitHub

Critical Fixes

• Command Parsing in Swarm Services (#254)

  • Fixed critical bug where strings.Split broke quoted arguments in Docker Swarm service commands
  • Now uses args.GetArgs() to properly handle commands like sh -c "echo hello world"
  • Prevents command execution failures in complex shell commands

• LocalJob Empty Command Panic (#254)

  • Fixed documented bug where empty commands caused runtime panic
  • Now returns proper error instead of crashing
  • Prevents service crashes from malformed job configurations

Security

• API Security Validation (#254)

  • Added validation for LocalJob and ComposeJob API endpoints
  • Prevents command injection attacks via API
  • Validates file paths, service names, and command arguments

• Privilege Escalation Logging (#244)

  • Enhanced logging for security monitoring
  • Better detection of privilege escalation attempts

• Dependency Updates

  • Updated golang.org/x/crypto to v0.45.0 for CVE fixes

Performance

• Enhanced Buffer Pool (#245)

  • Multi-tier adaptive pooling system
  • 99.97% memory usage reduction (2000 MB → 0.5 MB for 100 executions)
  • Automatic size adjustment and pool warmup

• Optimized Docker Client (#245)

  • Connection pooling for reduced overhead
  • Thread-safe concurrent operations
  • Health monitoring and automatic recovery

• Reduced Polling (#254)

  • Increased legacy polling interval from 500ms to 2s
  • 75% reduction in Docker API calls (200/min → 50/min per job)
  • Significant CPU and network usage improvement

• Performance Metrics Framework (#245)

  • Comprehensive metrics for Docker operations
  • Memory, latency, and throughput tracking
  • Real-time performance monitoring

Added

• Container Annotations

  • Support for custom annotations on RunJob and RunServiceJob
  • Default Ofelia annotations for job tracking
  • User-defined metadata for containers and services

• WorkingDir for ExecJob

  • Support for setting working directory in exec jobs
  • Backward compatible with existing configurations

• Opt-in Validation

  • New enable-strict-validation flag
  • Allows gradual migration to strict validation
  • Prevents breaking changes for existing users

• Git Hooks with Lefthook

  • Go-native git hooks for better portability
  • Pre-commit, commit-msg, pre-push, post-checkout, post-merge hooks
  • Automated code quality checks and security scans

Documentation

• Architecture Diagrams (#252)

  • System architecture overview
  • Component interaction diagrams
  • Data flow visualization

• Complete Package Documentation (#247)

  • Comprehensive package-level documentation
  • Security guides and best practices
  • Practical usage guides

• Docker Requirements

  • Documented minimum Docker version requirements
  • API compatibility notes

• Exit Code Documentation (#254)

  • Clear documentation of Ofelia-specific exit codes
  • Swarm service error codes (-999, -998)

Fixed

• Go Version Check (#251)
  • Corrected inverted logic in .envrc Go version check
  • Ensures correct Go version enforcement

Changed

• Updated go-dockerclient to v1.12.2
• Migrated from Husky to Lefthook for git hooks
• Improved CI/CD pipeline with comprehensive security scanning

Internal

• Removed AI assistant artifacts and outdated documentation (#246, #253)
• Enhanced test suite with comprehensive integration tests
• Improved code organization and maintainability

Migration Guide v0.10.x → v0.11.0

Breaking Changes

None - This release is backward compatible with v0.10.x

Recommended Actions

1. Review API Usage: If you create jobs via API, ensure commands are properly validated
2. Check Swarm Commands: Verify complex shell commands in service jobs work correctly
3. Monitor Performance: Observe improved memory usage and reduced API calls
4. Enable Metrics: Consider enabling the new metrics framework for monitoring

New Configuration Options

# Optional: Enable strict validation (default: false)
[global]
enable-strict-validation = true

# New: Container annotations
[job-run "example"]
annotations = com.example.key=value, app.version=1.0

Deprecations

None in this release.

For more information, see:

• Documentation
• Security Guide
• Configuration Guide

Included in this release

View all PRs and Issues included in this release