https://github.com/globocom/container-broker
Run any Docker-based task in a simple and distributed way
https://github.com/globocom/container-broker
docker docker-api hacktoberfest task-manager task-runner
Last synced: 10 days ago
JSON representation
Run any Docker-based task in a simple and distributed way
- Host: GitHub
- URL: https://github.com/globocom/container-broker
- Owner: globocom
- License: mit
- Created: 2020-10-07T13:22:55.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-09-27T10:25:10.000Z (over 2 years ago)
- Last Synced: 2026-03-03T19:37:42.368Z (24 days ago)
- Topics: docker, docker-api, hacktoberfest, task-manager, task-runner
- Language: Ruby
- Homepage:
- Size: 637 KB
- Stars: 9
- Watchers: 9
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Container Broker
## Key Features
- Run any Docker based task
- A Node only needs Docker HTTP API
- Separate Tasks by execution type
- Easily get Task logs
- Automatically retry jobs
- Enqueue tasks if no slots available
- Distribute load between Nodes
- If a node dies, tasks are automatically moved to another healthy Node (Failover)
- Support external volume mounts
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'container-broker'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install container-broker
## Usage
### Routes
#### Nodes
##### List
- `GET /nodes`
##### Add
- `POST /nodes`
- Parameters: `{ "hostname": "", "slots_execution_types": {"cpu": 2, "network": 10} }`
##### Update
- `PATCH /nodes/:uuid`
- Parameters: `{ "slots_execution_types": {"cpu": 2, "network": 10} }`
##### Remove
- `DELETE /nodes/:uuid`
- Parameters: `{ "slots_execution_types": {"cpu": 2, "network": 10} }`
#### Tasks
##### Create
- `POST /tasks`
- Parameters: `{ "name": "", "image": "", "cmd": "", "storage_mounts": "{}", "tags": {"type": "video"} }`
- Response:
```json
{
"status": "ok|error",
"uuid": "2d272b5c-953c-44e9-ad15-6c31187903c9"
}
```
##### Task Details
- Show information about some job
- Parameters (query string): `id`
- Response:
```json
{
"uuid": "2d272b5c-953c-44e9-ad15-6c31187903c9",
"status": "waiting|running|completed|error"
}
```
#### GET /status
- Show pool informations
- Response:
```json
{
"nodes": [
{
"hostname": "",
"cores": 10,
"memory": 4096,
"jobs": [
{
"uuid": "2d272b5c-953c-44e9-ad15-6c31187903c9",
"status": "waiting|running|completed|error"
}
]
}
]
}
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
### Expose Docker HTTP API on MacOSX:
```shell
socat TCP-LISTEN:2376,reuseaddr,fork UNIX-CONNECT:/var/run/docker.sock
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/globocom/container-broker.