Name | orca-docker JSON |
Version |
0.1.0
JSON |
| download |
home_page | None |
Summary | A Docker Compose alternative with enhanced features |
upload_time | 2025-02-10 02:57:43 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.8 |
license | MIT |
keywords |
docker
container
orchestration
compose
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# 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:
```bash
git clone https://github.com/yourusername/orca.git
cd orca
```
2. Install dependencies:
```bash
pip install -r requirements.txt
```
3. Create a basic configuration:
```yaml
# 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:
```bash
./orca.py up
```
## Documentation
For detailed documentation, visit our [GitHub Pages site](https://yourusername.github.io/orca):
- [Getting Started](https://yourusername.github.io/orca/getting-started)
- [Configuration Guide](https://yourusername.github.io/orca/configuration)
- [Load Balancing](https://yourusername.github.io/orca/load-balancing)
- [Examples](https://yourusername.github.io/orca/examples)
## 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:
```bash
cd docs
```
3. Install dependencies:
```bash
bundle install
```
4. Start the local server:
```bash
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](LICENSE) file for details
Raw data
{
"_id": null,
"home_page": null,
"name": "orca-docker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "docker, container, orchestration, compose",
"author": null,
"author_email": "Orca Team <orca@example.com>",
"download_url": "https://files.pythonhosted.org/packages/18/c6/df0ceba1b7d42d69122c130c0d4b3166e1e6b31e3b585f1db7bf0e6c70cb/orca_docker-0.1.0.tar.gz",
"platform": null,
"description": "# Orca\n\nOrca 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.\n\n## Features\n\n- **Simple Service Management**: Define and manage multiple Docker services\n- **Load Balancing**: Built-in Nginx-based load balancing\n- **Service Scaling**: Scale services with automatic load balancer reconfiguration\n- **Progress Tracking**: Visual feedback during service operations\n- **Health Monitoring**: Passive health checks and automatic failover\n\n## Quick Start\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/yourusername/orca.git\n cd orca\n ```\n\n2. Install dependencies:\n ```bash\n pip install -r requirements.txt\n ```\n\n3. Create a basic configuration:\n ```yaml\n # orca.yml\n services:\n web:\n image: nginx:latest\n volumes:\n - ./html:/usr/share/nginx/html\n\n load_balancers:\n web_lb:\n services:\n - name: web\n port: 8080\n ```\n\n4. Start your services:\n ```bash\n ./orca.py up\n ```\n\n## Documentation\n\nFor detailed documentation, visit our [GitHub Pages site](https://yourusername.github.io/orca):\n\n- [Getting Started](https://yourusername.github.io/orca/getting-started)\n- [Configuration Guide](https://yourusername.github.io/orca/configuration)\n- [Load Balancing](https://yourusername.github.io/orca/load-balancing)\n- [Examples](https://yourusername.github.io/orca/examples)\n\n## Documentation Development\n\nThe documentation is built using Jekyll and hosted on GitHub Pages. To develop the documentation locally:\n\n1. Install Ruby and Bundler\n2. Navigate to the docs directory:\n ```bash\n cd docs\n ```\n3. Install dependencies:\n ```bash\n bundle install\n ```\n4. Start the local server:\n ```bash\n bundle exec jekyll serve\n ```\n5. Visit `http://localhost:4000`\n\nThe documentation will be automatically built and deployed to GitHub Pages when you push to the main branch.\n\n### Publishing to GitHub Pages\n\n1. Fork this repository\n2. Go to your fork's Settings > Pages\n3. Under \"Source\", select \"GitHub Actions\"\n4. Push your changes to the main branch\n5. GitHub Actions will automatically build and deploy the documentation\n6. Your documentation will be available at `https://yourusername.github.io/orca`\n\n## Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Submit a pull request\n\n## License\n\nMIT License - see [LICENSE](LICENSE) file for details\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Docker Compose alternative with enhanced features",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://orca-docker.readthedocs.io",
"Homepage": "https://github.com/yourusername/orca",
"Repository": "https://github.com/yourusername/orca.git"
},
"split_keywords": [
"docker",
" container",
" orchestration",
" compose"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a0a92465bc45a0bea244b580df29e55bf9f329cbf7ba8b7f848357014ca5dbc6",
"md5": "fdebee2f3701d16c8f742b51563f1985",
"sha256": "79e60e4b01618c805544b26cd9ba0624783f1142559c360489e7a5805c37e61a"
},
"downloads": -1,
"filename": "orca_docker-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fdebee2f3701d16c8f742b51563f1985",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10121,
"upload_time": "2025-02-10T02:57:42",
"upload_time_iso_8601": "2025-02-10T02:57:42.047331Z",
"url": "https://files.pythonhosted.org/packages/a0/a9/2465bc45a0bea244b580df29e55bf9f329cbf7ba8b7f848357014ca5dbc6/orca_docker-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "18c6df0ceba1b7d42d69122c130c0d4b3166e1e6b31e3b585f1db7bf0e6c70cb",
"md5": "ce746ed46c6cdefeeafcac944f3da6b5",
"sha256": "643433b2e127d7e730e62c1fa7e48a79715717119305b7eb1ae23d2a564eb965"
},
"downloads": -1,
"filename": "orca_docker-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ce746ed46c6cdefeeafcac944f3da6b5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10686,
"upload_time": "2025-02-10T02:57:43",
"upload_time_iso_8601": "2025-02-10T02:57:43.320207Z",
"url": "https://files.pythonhosted.org/packages/18/c6/df0ceba1b7d42d69122c130c0d4b3166e1e6b31e3b585f1db7bf0e6c70cb/orca_docker-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-10 02:57:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "orca",
"github_not_found": true,
"lcname": "orca-docker"
}