Merge pull request #10 from jet-dev-team/develop

Initial open release!

Author: danylevskyi

.gitignore

@@ -0,0 +1 @@
+config.yml

README.md

@@ -1,3 +1,179 @@
 # Drupal Dockerizer
 
-Dockerized Drupal.
+## Requirements
+
+- Python >= 3.5
+- Docker
+- Docker Compose
+- Ansible >= 2.8
+- Git
+
+## Quickstart
+
+### Prepare project structure
+
+- `db`: create this directory and download database dump here if exists.
+- `code`: clone your project files into this directory.
+- `drupal-dockerizer`: clone drupal-dockerizer project in this directory.
+- `files`: create the directory and pull Drupal assets here
+
+### Prepare your config for Drupal Dockerizer
+
+```bash
+cd drupal-dockerizer
+cp default.config.yml config.yml
+```
+
+### Start new local environment
+
+```bash
+cd drupal-dockerizer
+sudo ansible-playbook -vvv main.yml --connection=local --extra-vars=init_project=true
+```
+
+### Start local environment for existing project
+
+```bash
+cd drupal-dockerizer
+sudo ansible-playbook -vvv main.yml --connection=local
+sudo ansible-playbook -vvv run-drush-commands.yml --connection=local
+```
+
+### Import database from dump
+
+```bash
+cd drupal-dockerizer
+sudo ansible-playbook -vvv db.yml --connection=local
+```
+
+### Xdebug setup
+
+For advanced network setup set in `config.yml` variable `xdebug_enviroment` like this
+
+```bash
+remote_enable=1 remote_connect_back=1 remote_port=9008 remote_host=192.168.{network_id}.1 show_error_trace=0 show_local_vars=1 remote_autostart=1 show_exception_trace=0 idekey=VSCODE
+```
+
+For work Xdebug with advanced networking in vscode add to your launcher.json file in project next lines:
+
+```json
+    {
+      "name": "XDebug Docker",
+      "type": "php",
+      "request": "launch",
+      "hostname" : "192.168.{network_id}.1",
+      "port": 9008,
+      "pathMappings": {
+        "/var/www": "${workspaceRoot}/<path_to_drupal_project>"
+      },
+      "xdebugSettings": {
+        "show_hidden": 1,
+        "max_data": -1,
+        "max_depth": 2,
+        "max_children": 100,
+      }
+    },
+```
+
+#### For MacOs the next config should be used
+
+Make sure your `config.yml` contains the next config:
+
+```bash
+# Enviroment variable for php xdebug extensions
+xdebug_enviroment: remote_enable=1 remote_connect_back=0 remote_port=9000 remote_host=10.254.254.254 show_error_trace=0 show_local_vars=1 remote_autostart=1 show_exception_trace=0 idekey=VSCODE
+```
+
+Make sure you've created Host address alias on MacOS:
+
+```bash
+sudo ifconfig lo0 alias 10.254.254.254
+```
+
+Your `launch.json` should look like the next config:
+
+```json
+    {
+      "name": "XDebug Docker",
+      "type": "php",
+      "request": "launch",
+      "port": 9000,
+      "pathMappings": {
+        "/var/www": "${workspaceRoot}/<path_to_drupal_project>"
+      },
+      "xdebugSettings": {
+        "show_hidden": 1,
+        "max_data": -1,
+        "max_depth": 2,
+        "max_children": 100,
+      }
+    
+```
+
+How to use debugger with Drush commands?
+
+1. Get the name of web server container using command: `docker ps | grep webserver`
+2. SSH into the container by name. Example: `docker exec -it yourproject-php72-develop bash`
+3. Set your breakpoint and run Drush command as usual
+
+### Advanced Networking
+
+You can use an advanced docker network to be able to conveniently host multiple Drupal projects on one computer.
+
+Set in config.yml `advanced_networking: true`.
+
+You can change the ip address of the project using the variable `network_id` in `config.yml` file
+
+You can change doamin name by variable `domain_name` in `config.yml` file
+
+#### Advanced Networking Limitation
+
+The advanced network only works on a machine with a Linux distribution.
+
+#### Advanced Networking project structure
+
+- `Adminer` placed on domain name and on 8080 port.
+- Solr 4 placed on domain name and on 8983 port and /solr path. `http://drupal.devel:8983/solr` for examle.
+- Data Base placed on 192.168.<<network_id>>.13 and on 3306 port. You can connect to DB by vscode [extension](https://marketplace.visualstudio.com/items?itemName=formulahendry.vscode-mysql) or from `Adminer`
+
+### Drush usage
+
+Run in terminal: `docker exec my-project-php74 drush <drush-command>` for run drush command.
+If you change compose project name or php version in config replace `my-project-php74` to `<compose_project_name>-<phpversion>`.
+
+Use the next command in order to ran multiple Drush commands.
+
+```bash
+sudo ansible-playbook -vvv run-drush-commands.yml --connection=local
+````
+
+Change `drush_commands` variable in your `config.yml` file like this:
+
+```yaml
+drush_commands:
+  - 'updb'
+  - '-v sapi-r'
+  - '-v sapi-i'
+  - ...
+```
+
+## FAQ
+
+### How to reset everything and start from scratch?
+
+```bash
+cd <project>/docker
+sudo ansible-playbook -vvv reset.yml --connection=local
+```
+
+### How to clear Docker cache?
+
+```bash
+docker system prune -a
+```
+
+### How to enhance MacOS performance?
+
+- make sure your `config.yml` contains `docker_cached_volume: true`
+- make sure you add more resources to Docker via Preferences -> Recources
+- make sure you set `debug` to `false` in Docker Engine preferences

ansible.cfg

@@ -0,0 +1,9 @@
+[defaults]
+roles_path = ./roles
+nocows = 1
+retry_files_enabled = False
+inventory = inventory
+
+[ssh_connection]
+pipelining = True
+control_path = /tmp/ansible-ssh-%%h-%%p-%%r

db.yml

@@ -0,0 +1,33 @@
+---
+
+- hosts: server
+  become: yes
+
+  vars_files:
+    - default.config.yml
+
+  pre_tasks:
+    - name: Include config override file, if it exists.
+      include_vars: "{{ item }}"
+      with_fileglob:
+        - config.yml
+
+  roles: []
+
+  tasks:
+
+    - name: Remove database.
+      ignore_errors: yes
+      when: database == "mysql"
+      shell: |
+        docker exec -i {{ compose_project_name }}-database sh -c 'exec mysql -uroot -p{{ mysql_root_password }} -e "DROP DATABASE {{ mysql_database }}"'
+
+    - name: Create new database.
+      when: database == "mysql"
+      shell: |
+        docker exec -i {{ compose_project_name }}-database sh -c 'exec mysql -uroot -p{{ mysql_root_password }} -e "CREATE DATABASE {{ mysql_database }} CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci"'
+
+    - name: Import database.
+      when: database == "mysql"
+      shell: |
+        docker exec -i {{ compose_project_name }}-database sh -c 'exec mysql -uroot -p{{ mysql_root_password }} {{ mysql_database }}' < {{ db_dump_path }}

default.config.yml

@@ -0,0 +1,72 @@
+---
+
+compose_project_name: my-project
+docker_runtime_dir: my-project
+docker_cached_volume: true
+
+host_machine_user: myusername
+
+# Absolute Path to Drupal dir (`vendor` forlder should be there).
+drupal_root_dir: /var/data/drupal
+# Name of "web" folder inside `drupal_root_dir`.
+drupal_web_root: web
+# Absolute Path to Drupal files dir.
+drupal_files_dir: /var/data/drupal_files
+drupal_hash_salt: demo_site
+
+apache_port: 80
+apache_port_ssl: 443
+
+# Look at available options here: https://github.com/jet-dev-team/docker-compose-lamp/tree/drupal/bin
+phpversion: php74
+
+# Enviroment variable for php xdebug extensions
+xdebug_enviroment: remote_enable=1 remote_connect_back=1 remote_port=9008 remote_host=192.168.105.1 show_error_trace=0 show_local_vars=1 remote_autostart=1 show_exception_trace=0 idekey=VSCODE
+
+# Setup additional networking.
+advanced_networking: false
+network_id: 105
+domain_name: drupal.devel
+
+init_project: false
+composer_project: drupal/recommended-project
+comoser_extras:
+  - drush/drush
+  - drupal/admin_toolbar
+
+drush_install: true
+# Availible options: 8, 9, 10
+drush_version: 10
+
+# Drush commands to run (will be run by `run-drush-commands.yml` playbook or if init_project is true).
+drush_commands:
+  - 'cc drush'
+  - 'site:install minimal --account-pass=admin --site-name="Drupal Dockerizer"'
+  - 'theme:enable bartik claro'
+  - 'en datetime toolbar rest jsonapi views views_ui ban automated_cron action admin_toolbar'
+  - 'config-set system.theme default bartik'
+  - 'config-set system.theme admin claro'
+  - 'cron'
+
+solr: false
+solr_core_name: drupal
+
+# Tom make `memcache` working `memcache` module should be enabled: `en memcache`.
+memcache: false
+
+# Path to Drupal DB dump (will be imported by `db.yml` playbook).
+db_dump_path: /var/data/db/db.sql
+
+database: mysql
+mysql_root_password: root
+mysql_user: docker
+mysql_password: docker
+mysql_database: docker
+
+install_adminer: false
+adminer_port: 8080
+
+custom_drupal_settings: |
+  if (file_exists($app_root . '/' . $site_path . '/settings.local.php')) {
+    include $app_root . '/' . $site_path . '/settings.local.php';
+  }

inventory

@@ -0,0 +1,7 @@
+[server]
+127.0.0.1 ansible_python_interpreter=/usr/bin/python3
+
+# Comment the default localhost line above, and uncomment the line below
+# (replacing the IP with your Pi's IP address) if running the playbook from a
+# separate workstation.
+#10.0.100.20 ansible_user=server ansible_python_interpreter=/usr/bin/python3

main.yml

@@ -0,0 +1,52 @@
+---
+
+- hosts: server
+
+  vars_files:
+    - default.config.yml
+
+  pre_tasks:
+    - name: Include config override file, if it exists.
+      include_vars: "{{ item }}"
+      with_fileglob:
+        - config.yml
+
+  roles: []
+
+  tasks:
+    - name: include project setup tasks.
+      when: init_project
+      include: tasks/project-setup.yml
+
+    - name: Include lamp setup tasks
+      include: tasks/lamp-setup.yml
+
+    - name: Include solr setup tasks.
+      when: solr
+      include: tasks/solr-setup.yml
+
+    - name: Include Advanced Networking setup tasks
+      when: advanced_networking
+      include: tasks/advanced-networking-setup.yml
+
+    - name: Include Drush setup tasks
+      when: drush_install
+      include: tasks/drush-setup.yml
+
+    - name: Include Settings setup tasks
+      include: tasks/settings-setup.yml
+
+    - name: Include Docker up tasks
+      include: tasks/docker-up.yml
+
+    - name: Wait docker containers (MySQL) to up.
+      pause:
+        seconds: 30
+
+    - name: Setup drupal task
+      when: drush_install and init_project
+      include: tasks/drush-command.yml
+
+    - name: Include Memcache setup tasks
+      when: memcache
+      include: tasks/memcache-setup.yml

requirements.yml

@@ -0,0 +1 @@
+---