https://github.com/kcmerrill/yoda
A dev environment docker orchestration tool.
https://github.com/kcmerrill/yoda
Last synced: 2 months ago
JSON representation
A dev environment docker orchestration tool.
- Host: GitHub
- URL: https://github.com/kcmerrill/yoda
- Owner: kcmerrill
- License: gpl-3.0
- Created: 2015-01-26T00:53:35.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-10-17T01:09:06.000Z (over 8 years ago)
- Last Synced: 2025-03-28T12:03:03.425Z (3 months ago)
- Language: PHP
- Homepage: http://yoda.kcmerrill.com
- Size: 4.55 MB
- Stars: 14
- Watchers: 2
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Yoda
[](https://gitter.im/kcmerrill/yoda?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Let the little green guy do the tedious docker work for you!
## No longer maintained
I am no longer maintaining yoda. It will continue to work, and all public repos will continue to exist but I've since focused my efforts on [Alfred](https://github.com/kcmerrill/alfred). While alfred is _not_ a drop in replacement for yoda, it is a much much more robust solution and can offer all(and much more) of the same benifits yoda currently has.
Having said that, yoda still works and will continue to work for a really long time. If for no other reason, it takes advantage of command line so any new features docker introduces, you'll get automagically with yoda.
## What is it?
With all of the amazing tools the docker community has created, one of which is incredibly lacking, which is where yoda aims to help fix. That area? The dev enviornment. There are orchestration tools that are amazing for prod, but what if you just want a tool that will volume mount and setup your dev enviornment lickety split? That's where yoda comes in.
## Features
- Ability to pull, build and run containers and _all_ of their dependencies.
- A repository of .yoda files that yoda can grab(and contribute to too!) to get you up and running even quicker!
- Wraps the CLI interface and relies more heavily on shell, thus making it more customizable.
- Functionality for different environments built in(no need for additional config files based on env)
- A few more!!!
## Experimental Installation ##
Instead of downloading and installing a php application, yoda is now in a container(and seems to be working?! Need help testing!)
Create an alias and you should be up and running:
```bash
alias yoda='docker run --rm -ti -v $HOME/.docker:/root/.docker -v $HOME/.yoda:/yoda/.config -e containerized=true -h=$HOSTNAME -v /var/run/docker.sock:/var/run/docker.sock -v $(if [ $(dirname $PWD) == "/" ]; then echo $PWD; else dirname $PWD; fi):$(if [ $(dirname $PWD) == "/" ]; then echo $PWD; else dirname $PWD; fi) -v $HOME/.ssh:/root/.ssh -v $HOME/.yoda/shares:/yoda/www/share -w $PWD -u=$(id -u $USER) kcmerrill/yoda'
```
## Installation ##
1. Clone the yoda project from github
2. Run composer to install the php dependencies
3. Add yoda to your $PATH
```bash
git clone [email protected]:kcmerrill/yoda.git
cd yoda/ && docker run --rm -v $(pwd):/app composer/composer install
sudo ln -s $PWD/yoda /usr/bin/yoda
```
Yoda should now be ready to go. Give it a try
```bash
yoda
```
## Screencast (Video) ##
I suppose it's a little long for a "brief" overview, but a brief overview of what Yoda is. How you might be able to leverage it in certain ways and going over a few of it's key features.
[](https://www.youtube.com/watch?v=xY65f2gOTJs)
## Screenshots ##
#### Example of a `$ yoda lift`
Use `yoda lift` to build and run a yoda project and all its dependencies.
Compare the command output to that project's `.yoda` config file.
#### Example of a `$ yoda kill`
If you're looking for a clean start, use `yoda kill` to stop all running docker containers.
#### Example of a `$ yoda control`
Once Yoda has lifted a project's docker container you can use `yoda control` to shell into that container.
The functionality of `yoda control` can be extended by adding a `control:` section to the `.yoda` file.
