How to use docker drush with docker-compose

[JulienD]

Hi

This is a more a documentation issue than anything else.

I've downloaded the image and run drush as a standalone container like described on the Readme page and it worked well. In order to go deeper, I want to understand how to link a drush container with others containers but unfortunately I have not been able to make it working.

In my docker-compose.yml file I have defined the following containers:

nginx:
  build: nginx-fpm
  links:
    - phpfpm
  ports:
    - "8080:80"
  volumes_from:
    - data

phpfpm:
  build: php-5.6-fpm-custom
  volumes_from:
    - data
    - db

db:
  image: mariadb
  volumes:
    - /var/run/mysqld
    - ./databases/active:/var/lib/mysql
  environment:
    MYSQL_ROOT_PASSWORD: password
    MYSQL_DATABASE: application

data:
  image: busybox
  stdin_open: true
  volumes:
    - ./htdocs:/var/www/html

drush:
  image: drush/drush
  volumes_from:
    - data
    - db
  links:
    - phpfpm
    - db

When starting all the containers, I can see Drush's container working, displaying the list of commands and them exiting.

....
drush_1   |  (wd-list)            prompt will ask for a choice to show watchdog messages.
drush_1   |  watchdog-show        Show watchdog messages.
drush_1   |  (wd-show, ws)
dockerlemp_drush_1 exited with code 0

I though the container would live as a normal container and would allow me to manage Drupal.

Maybe I did not understand the purpose of this repo or maybe this is due to my short experience with docker and docker-compose but I have not found how to use the repo with several containers. Could you give me a hint on how to achieve it ?

Thanks

[theodorosploumis]

1. You don't need to have a container running, you only need the executable (drush) to be available to the www files where drupal exists. Saying that you can use your local drush executable if you like (if it is a phar file) and avoid drush/drush image at all. Here is an example:

version: '2'
services:
  drupal:
    image: drupal:8.1.1-apache
    container_name: drupal_apache
    volumes:
      # Mount local drush to your container.
      - /usr/local/bin/drush:/drush/drush

then you can run:

# drush status on the created container
docker exec drupal_apache /drush/drush status

2. Normally you could volume the drush executable from drush/drush image but you can't do this since mount is not allowed for files. To do so you can create your own image based on drush/drush. Here is a simple Dockerfile:

FROM drush/drush:8

# Move drush to a more generic path so it can be used with any image
RUN mkdir -p /drush && \
    mv -f /usr/local/bin/drush /drush/drush

# Volume the drush path so we can use it with other containers
VOLUME /drush

# Change the entrypoint to match the new drush path
ENTRYPOINT ["/drush/drush", "status"]

Create the new drush image:

docker build -t drush-volumed:8 .

and here is the docker-compose.yml file using volumes from the new drush-volumed:8 image:

version: '2'
services:
  drupal:
    image: drupal:8.1.1-apache
    container_name: drupal_8081
    volumes:
      - /var/www/html
    volumes_from:
      - drush_volumed
    ports:
      - '8081:80'
    links:
      - mysql
  mysql:
    image: mysql:5.5
    container_name: mysql
    environment:
      - MYSQL_ROOT_PASSWORD=root
      - MYSQL_DATABASE=drupal
      - MYSQL_USER=drupal
      - MYSQL_PASSWORD=drupal
  drush_volumed:
    image: drush-volumed:8
    container_name: drush_volumed

I am about to create a pull request for this as it is major and I think a lot of drupal developers will come to the same issue when they start using docker.

[peperoni60]

If you do so, you could also install Drush in your drupal container. It shares the PHP and all other stuff. That's not, what is wanted when you use Docker.

[opdavies]

and here is the docker-compose.yml file using volumes from the new drush-volumed:8 image

Where does the drush-volumed:8 image come from?

[theodorosploumis]

It does not exist (not a public image). But here is a simple Dockerfile to create it.

[sgarciafer]

Your last Dockerfile link has gone 404. Could you re-link it?

[sgarciafer]

I'm checking your repo Theodorosploumis, but I see you deleted the separate drush docker container and have drush installed on the same drupal container. Should I guess the option you explain in here didn't work so well after all ?

[jubalm]

I managed to make this work by exposing the the application container's volume to drush/drush and use docker-compose to run drush commands. Here's my docker-compose.yml file.

version: '2'
services:
  app:
    image: drupal:7.53
    container_name: drupal.app
    ports:
      - "8000:80"
    volumes:
      - /var/www/html 
  db:
    image: mariadb
    container_name: drupal.db
    ports:
      - "3306:3306"
    environment:
      MYSQL_ROOT_PASSWORD: drupal
      MYSQL_DATABASE: drupal
      MYSQL_USER: drupal
      MYSQL_PASSWORD: drupal
  drush:
    image: drush/drush:8
    container_name: drupal.drush
    volumes_from:
      - app

and running the command

$ docker-compose run drush site-install --uri=http://drupal.app --root=/var/www/html

parameters and their corresponding values in docker-compose.yml

• --uri = http:// + app ▸container_name
• --root = app ▸volumes (exposed)

This is a awesome presentation about it
https://socketwench.github.io/rideTheWhale

[james-nesbitt]

it is actually poor form to install drush in your runtime container. It is also considered poor form to use docker exec

Technically drush needs only 2 things:

1. access to files (including assets)
2. access to DB

consider running drush as a new disposable container, linking to your db container, and taking source from local or from your drupal container. You can get source from your drupal container by volumizing the source path and using --sources-from=drupal or --volume drupal:/path/to/source

[theodorosploumis]

@sgarciafer No it works fine. But I am planning to create a complete different repo for Drupal + Docker + "Friends" containers management to cover more cases, OS and versions of software. So I deleted the code from this repo.

On the same repo see https://github.com/theodorosploumis/drupal-docker/blob/master/docker-compose.yml#L41. There are still volumes from MySQL so drush (and drupalconsole) play well.

#32 (comment) is still valid as also as an updated answer at http://stackoverflow.com/a/40855933/1365264.

[theodorosploumis]

On a presentation about Docker + Drupal I tried to "separate" the Drupal components and investigate how someone can use them within Docker: https://theodorosploumis.github.io/drupalcamp2016/#/28.

[leolandotan]

@jubalm thanks for that! I'm just wondering, is there a way or configuration that would let run Drush commands without specifying --uri and --root ?

[dixhuit]

@leolandotan Assuming you're not running multisite, many drush commands don't rely on the uri option being set or even accurate. drush user-login needs it to return an accurate path but it's in the minority.

Either way, according to the drush docs you can set the uri option in a drushrc.php file next to your site's settings.php:

$options['uri'] = "http://drupal.app";

Now you only have to worry about setting the root option for each drush command.

---

OR

You could use drush aliases so long as they're not defined within your site's codebase. A drush alias can define both root and uri options so you'd only need worry about specifying the correct alias in your command and you're golden :)

https://raw.githubusercontent.com/drush-ops/drush/master/examples/example.aliases.drushrc.php

[leolandotan]

@danbohea Thank you very much for these option in details! I'm still starting in Drush and like so I only understand the basics but I will definitely base my additional research and implementation from this! When I'm successful or have any progress I'll try to post them here. :)

[leolandotan]

@danbohea I tried to create a Drush aliases file but the Drush container doesn't seem to detect it.

docker-compose.yml

version: '2'
services:
  web:
    build: docker/php
    volumes:
      - ./www:/var/www/html/mydrupalsite
      - ./www/drush:/etc/drush/site-aliases
    ports:
      - 80
  db:
    image: mysql:5.7
    volumes:
      - ./data/mysql:/var/lib/mysql
    environment:
      MYSQL_USER: default
      MYSQL_PASSWORD: default
      MYSQL_DATABASE: default
      MYSQL_ROOT_PASSWORD: root
  drush:
    image: drush/drush:7
    volumes_from:
      - web
    links:
      - db:mysql

mydrupalsite.aliases.drushrc.php

<?php
$aliases['local'] = array(
  'root' => '/var/www/html/mydrupalsite',
);

Then I ran:

$ docker-compose up -d
Recreating mydrupalsite_web_1
mydrupalsite_db_1 is up-to-date
Recreating mydrupalsite_drush_1
$ docker-compose run --rm drush cc drush
'drush' cache was cleared.
$ docker-compose run --rm drush sa 
@none

I can't figure out what I'm missing.

UPDATE

Instead of using Drush aliases, I used Docker's entrypoint configuration option in the drush service as follows:

  drush:
    image: drush/drush:7
    volumes_from:
      - web
    links:
      - db:mysql
    entrypoint:
      - drush
      - "--root=/var/www/html/mydrupalsite"

So when I issue the docker-compose run --rm drush st command, it runs the first item as the command and the successive items as its parameters including my st command.

I hope this is an acceptable solution. What do you think guys?

Entrypoint Reference: https://docs.docker.com/engine/reference/builder/#entrypoint

[elalemanyo]

@leolandotan I am using your way to use drush... but how do you run drush make project.make?
I try like this: docker-compose run --rm drush, but I get this error: file_get_contents(project.make): failed to open stream: No such file

Thanks!