Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jesusgautamah/lucy_dockerunner
This gem is a tool to run docker containers with rake commands, good for CI/CD and Rails projects
https://github.com/jesusgautamah/lucy_dockerunner
containers docker docker-compose docker-container gem rails rake ruby ruby-on-rails tasks wrapper
Last synced: 2 days ago
JSON representation
This gem is a tool to run docker containers with rake commands, good for CI/CD and Rails projects
- Host: GitHub
- URL: https://github.com/jesusgautamah/lucy_dockerunner
- Owner: JesusGautamah
- License: mit
- Created: 2023-02-12T01:36:39.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-18T15:33:08.000Z (over 1 year ago)
- Last Synced: 2024-11-15T05:51:56.572Z (2 days ago)
- Topics: containers, docker, docker-compose, docker-container, gem, rails, rake, ruby, ruby-on-rails, tasks, wrapper
- Language: Ruby
- Homepage: https://rubygems.org/gems/lucy_dockerunner/
- Size: 61.5 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Lucy Dockerunner
Lucy Dockerunner is a Ruby gem that provides a simple wrapper around the Docker Compose CLI to make it easier to run Docker Compose commands from ruby projects.
[](https://badge.fury.io/rb/lucy_dockerunner)
[](https://opensource.org/licenses/MIT)
[](https://www.ruby-lang.org/en/)
Ruby version: >= 2.6.0
This gem version: 0.2.0
## Dependencies
* [Docker](https://www.docker.com/)
* [Docker Compose](https://docs.docker.com/compose/)
## Files
The default file is set to `docker-compose.yml`, but you can change it setting the `LUCY_FILE` environment variable.
## Services
Check services in `compose.rake` file.
## Installation
You can install the gem by executing:
$ gem install lucy_dockerunner
Or add it to your Gemfile:
gem 'lucy_dockerunner'
## Usage
If you want to use superuser privileges, you can set the `LUCY_SU` with your superuser command, for example:
$ export LUCY_SU="sudo"
Or in `.env` `LUCY_SU=sudo`
### Add the following code to your Rakefile to load the tasks
````ruby
require 'lucy_dockerunner'
require "dotenv/load"
LucyDockerunner.load_tasks
````
## Docker actions(more services in compose.rake file)
* `rake compose:install` - build docker compose and migrate the database
* `rake compose:build` - build docker compose services
* `rake compose:up` - start the docker compose services
* `rake compose:down` - stop the docker compose services
* `rake compose:status` - show the status of the docker compose services
* `rake compose:shell` - open a shell in the web service
* `rake compose:db_detach` - detach the database from the docker compose services
* `rake compose:redis_detach` - detach the redis from the docker compose services
* `rake compose:back_detach` - detach the backend(redis, sidekiq, db) from the docker compose services
* `rake compose:restart` - restart the docker compose services
* `rake compose:clean_all` - clean all docker compose services
* `rake compose:clean_images` - clean all docker compose images
* `rake compose:clean_volumes` - clean all docker compose volumes
* `rake compose:clean_orphans` - clean all docker compose orphans
* `rake compose:clean_containers` - clean all docker compose containers
## Database actions
* `rake compose_db:migrate` - migrate the database
* `rake compose_db:reset` - reset the database
* `rake compose_db:drop` - drop the database
* `rake compose_db:create` - create the database
* `rake compose_db:seed` - seed the database
* `rake compose_db:rollback` - rollback the database
* `rake compose_db:setup` - setup the database
* `rake compose_db:complete_setup` - complete setup the database
* `rake compose_db:reset_setup` - drop and setup the database
* `rake compose_db:reset` - reset the database
## Tests actions
* `rake compose_test:all` - run all tests
* `rake compose_test:clean_all` - run all tests after cleaning docker compose services
* `rake compose_test:controllers` - run controllers tests
* `rake compose_test:models` - run models tests
* `rake compose_test:requests` - run requests tests
* `rake compose_test:helpers` - run helpers tests
* `rake compose_test:mailers` - run mailers tests
* `rake compose_test:routing` - run routing tests
* `rake compose_test:views` - run views tests
## LOGS actions
* `rake compose_logs:web` - show web logs
* `rake compose_logs:db` - show db logs
* `rake compose_logs:redis` - show redis logs
* `rake compose_logs:sidekiq` - show sidekiq logs
* `rake compose_logs:all` - show all logs
* `rake compose_logs:tail_web` - tail web logs
* `rake compose_logs:tail_db` - tail db logs
* `rake compose_logs:tail_redis` - tail redis logs
* `rake compose_logs:tail_sidekiq` - tail sidekiq logs
* `rake compose_logs:tail_all` - tail all logs
## Assets actions
* `rake compose_assets:precompile` - precompile assets
* `rake compose_assets:clean` - clean assets
* `rake compose_assets:clobber` - clobber assets
## Start the docker compose services
````bash
$ rake compose:up
````
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/JesusGautamah/lucy_dockerunner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/JesusGautamah/lucy_dockerunner/blob/master/CODE_OF_CONDUCT.md).
## [](https://repography.com) / Recent activity [](https://repography.com)
[](https://github.com/JesusGautamah/lucy_dockerunner/commits)
[](https://github.com/JesusGautamah/lucy_dockerunner/issues)
[](https://github.com/JesusGautamah/lucy_dockerunner/pulls)
[](https://github.com/JesusGautamah/lucy_dockerunner/graphs/contributors)
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the LucyDockerunner project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/JesusGautamah/lucy_dockerunner/blob/master/CODE_OF_CONDUCT.md).