Wunder-Tools behavioural prototype

This project is a simple behavoural prototype, to see what we would want from a docker based tool.

Layout

*** note that our app folder is modeled on the drupal8 for composer

\app -------------------> everything to do with your application
  \drush ---------------> .drush folder for container user, which can hold aliases and cache
  \console -------------> .console folder for container user, which can hold everything from $/> drupal init

  \vendor --------------> folder that has elements managed by drupal composer
  \web -----------------> web server root

\wundertools -----------> everything to do with wundertools and docker
  (see the wundertools/docs/wundertools.md file for more information)

Documentation

There is extensive documentation on the wundertools approach in /wundertools/docs

Getting set up

The project comes completely un-built. Building may require docker steps as well as other steps related to Drupal architecture.

To start all of the pieces for docker use the compose command, which behaves similar to vagrant:

$/> wundertools/compose up -d 

Typically you will need to run composer:

$/> wundertools/composer update
$/> wundertools/composer install

Then you should be up and running. See "access my site"

For more commands See "Using the tools"

Using the tools

*** RIGHT NOW WE HAVE A SET OF BASH SCRIPTS TO PROTOTYPE BEHAVIOUR. THESE WILL BE REPLACED

The tools are implemented using a set of bash scripts located in the wundertools folder. These scripts are to be run directly. The scripts assume that the layout is respected.

Each of the commands should be run directly, from the project root and should try to pull in the configuration from config.inc automatically.

If you get sick of running relative path commands, consider copying ./wundertools/wundertools to any user bin path, to allow you to run "$/> wundertools {command}" instead of "$/> ./wundertools/{command}"

Get more information by looking in the wundertools/docs

Accessing my containers

Container IP

You can usually rely on a direct route to your container. To find the IP for any container:

$/> wundertools/tools/containerIP www

*** Note that on some docker setups, the host has not routed container traffic to the docker subnet (bad host) and so a manual route may be necessary. The OSX Beta client seems to have this issue, but no route seems avaialable.

Container shell

You can get a fast shell inside any of the actual containers using:

$/> wundertools/tools/execshell fpm

*** Note that this shell is not as usefull as the featured shell from "wundertools/shell" as most of the service images do not even have bash installed.