Docker Interaction Process
Command line utility that gives the "native" interaction with applications configured with Docker Compose. It is for the local development only. In practice, it creates the feeling that you work without containers.
- Local development with Docker containers
- Dockerized Ruby on Rails application
- Dockerized Node.js application
- Dockerized Ruby gem
Dip can be injected into current shell (ZSH or Bash).
eval "$(dip console)"
After that we can type commands without dip
prefix. For example:
<run-command> *any-args
compose *any-compose-arg
up <service>
down
provision
When we change the current directory, all shell aliases will be automatically removed. But when we will enter back to a directory with a dip.yml file, then shell aliases will be renewed.
Also, in shell mode Dip is trying to determine passed manually environment variables. For example:
VERSION=20180515103400 rails db:migrate:down
You could add this eval
at the end of your ~/.zshrc
, or ~/.bashrc
, or ~/.bash_profile
.
After that, it will be automatically applied when you open your preferred terminal.
You have two ways.
Install like a typical Ruby gem:
gem install dip
If you don't have installed Ruby then you could copy a precompiled binary to your system. It can be found at releases page or type bellow into your terminal:
curl -L https://github.com/bibendi/dip/releases/download/3.8.3/dip-`uname -s`-`uname -m` > /usr/local/bin/dip
chmod +x /usr/local/bin/dip
dip --help
dip SUBCOMMAND --help
The configuration file dip.yml
should be placed in a project root directory.
Also, in some cases, you may want to change the default config path by providing an environment variable DIP_FILE
.
If nearby places dip.override.yml
file it would be merged into the main config.
Below is an example of real config.
dip.yml
reference will be written soon.
Also, you can check out examples in the top.
version: '2'
environment:
COMPOSE_EXT: development
compose:
files:
- docker/docker-compose.yml
- docker/docker-compose.$COMPOSE_EXT.yml
- docker/docker-compose.$DIP_OS.yml
project_name: bear
interaction:
bash:
service: app
compose_run_options: [no-deps]
bundle:
service: app
command: bundle
rake:
service: app
command: bundle exec rake
rspec:
service: app
environment:
RAILS_ENV: test
command: bundle exec rspec
rails:
service: app
command: bundle exec rails
subcommands:
s:
service: web
compose_run_options: [service-ports]
psql:
service: app
command: psql -h pg -U postgres
provision:
- dip compose down --volumes
- dip compose up -d pg redis
- dip bash -c ./bin/setup
Run commands defined within interaction
section of dip.yml
dip run rails c
dip run rake db:migrate
run
argument can be ommited
dip rake db:migrate
dip VERSION=12352452 rake db:rollback
Run commands each by each from provision
section of dip.yml
Run docker-compose commands that are configured according with application dip.yml
dip compose COMMAND [OPTIONS]
dip compose up -d redis
Runs ssh-agent container based on https://github.com/whilp/ssh-agent with your ~/.ssh/id_rsa.
It creates a named volume ssh_data
with ssh socket.
An application's docker-compose.yml should contains environment variable SSH_AUTH_SOCK=/ssh/auth/sock
and connects to external volume ssh_data
.
dip ssh up
docker-compose.yml
services:
web:
environment:
- SSH_AUTH_SOCK=/ssh/auth/sock
volumes:
- ssh-data:/ssh:ro
volumes:
ssh-data:
external:
name: ssh_data
Runs Nginx server container based on bibendi/nginx-proxy image. An application's docker-compose.yml should contains environment variable VIRTUAL_HOST
and VIRTUAL_PATH
and connects to external network frontend
.
foo-project/docker-compose.yml
version: '2'
services:
foo-web:
image: company/foo_image
environment:
- VIRTUAL_HOST=*.bar-app.docker
- VIRTUAL_PATH=/
networks:
- default
- frontend
dns: $DIP_DNS
networks:
frontend:
external:
name: frontend
baz-project/docker-compose.yml
version: '2'
services:
baz-web:
image: company/baz_image
environment:
- VIRTUAL_HOST=*.bar-app.docker
- VIRTUAL_PATH=/api/v1/baz_service,/api/v2/baz_service
networks:
- default
- frontend
dns: $DIP_DNS
networks:
frontend:
external:
name: frontend
dip nginx up
cd foo-project && dip compose up
cd baz-project && dip compose up
curl www.bar-app.docker/api/v1/quz
curl www.bar-app.docker/api/v1/baz_service/qzz
Runs DNS server container based on https://github.com/aacebedo/dnsdock It used for container to container requests through nginx. An application's docker-compose.yml should define dns
configuration with environment variable $DIP_DNS
and connect to external network frontend
. $DIP_DNS
will be automatically assigned by dip.
dip dns up
cd foo-project
dip compose exec foo-web curl http://www.bar-app.docker/api/v1/baz_service