Skip to main content

A Docker Compose alternative with enhanced features

Project description

Orca

Orca is a lightweight alternative to Docker Compose, focusing on simplicity and efficient container orchestration. It provides seamless service management and load balancing capabilities through an intuitive YAML configuration.

Features

  • Simple Service Management: Define and manage multiple Docker services
  • Load Balancing: Built-in Nginx-based load balancing
  • Service Scaling: Scale services with automatic load balancer reconfiguration
  • Progress Tracking: Visual feedback during service operations
  • Health Monitoring: Passive health checks and automatic failover

Quick Start

  1. Clone the repository:

    git clone https://github.com/yourusername/orca.git
    cd orca
    
  2. Install dependencies:

    pip install -r requirements.txt
    
  3. Create a basic configuration:

    # orca.yml
    services:
      web:
        image: nginx:latest
        volumes:
          - ./html:/usr/share/nginx/html
    
    load_balancers:
      web_lb:
        services:
          - name: web
        port: 8080
    
  4. Start your services:

    ./orca.py up
    

Documentation

For detailed documentation, visit our GitHub Pages site:

Documentation Development

The documentation is built using Jekyll and hosted on GitHub Pages. To develop the documentation locally:

  1. Install Ruby and Bundler
  2. Navigate to the docs directory:
    cd docs
    
  3. Install dependencies:
    bundle install
    
  4. Start the local server:
    bundle exec jekyll serve
    
  5. Visit http://localhost:4000

The documentation will be automatically built and deployed to GitHub Pages when you push to the main branch.

Publishing to GitHub Pages

  1. Fork this repository
  2. Go to your fork's Settings > Pages
  3. Under "Source", select "GitHub Actions"
  4. Push your changes to the main branch
  5. GitHub Actions will automatically build and deploy the documentation
  6. Your documentation will be available at https://yourusername.github.io/orca

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

License

MIT License - see LICENSE file for details

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

orca_docker-0.1.0.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

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

orca_docker-0.1.0-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file orca_docker-0.1.0.tar.gz.

File metadata

  • Download URL: orca_docker-0.1.0.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for orca_docker-0.1.0.tar.gz
Algorithm Hash digest
SHA256 643433b2e127d7e730e62c1fa7e48a79715717119305b7eb1ae23d2a564eb965
MD5 ce746ed46c6cdefeeafcac944f3da6b5
BLAKE2b-256 18c6df0ceba1b7d42d69122c130c0d4b3166e1e6b31e3b585f1db7bf0e6c70cb

See more details on using hashes here.

File details

Details for the file orca_docker-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: orca_docker-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for orca_docker-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79e60e4b01618c805544b26cd9ba0624783f1142559c360489e7a5805c37e61a
MD5 fdebee2f3701d16c8f742b51563f1985
BLAKE2b-256 a0a92465bc45a0bea244b580df29e55bf9f329cbf7ba8b7f848357014ca5dbc6

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