updating kickoff-docker-php for Orbit v3.0.0 (#53)

Author: Julien Neuhart

.travis.yml

@@ -14,7 +14,7 @@ before_install:
   - curl -L https://github.com/docker/compose/releases/download/1.14.0/docker-compose-`uname -s`-`uname -m` > docker-compose
   - chmod +x docker-compose
   - sudo mv docker-compose /usr/local/bin
-  - wget https://github.com/gulien/orbit/releases/download/v2.0.0/orbit_Linux_x86_64.tar.gz && tar -xzf orbit*.tar.gz orbit && rm -f orbit*.tar.gz
+  - wget https://github.com/gulien/orbit/releases/download/v3.0.0/orbit_Linux_x86_64.tar.gz && tar -xzf orbit*.tar.gz orbit && rm -f orbit*.tar.gz
   - sudo mv ./orbit /usr/local/bin && chmod +x /usr/local/bin/orbit
 
 script:

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Julien Neuhart
+Copyright (c) 2018 Julien Neuhart
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,7 +4,7 @@
 <h3 align="center">kickoff-docker-php</h3>
 <p align="center">A complete stack for your PHP project powered by Docker</p>
 <p align="center">
-    <a href="https://github.com/thecodingmachine/kickoff-docker-php/tree/v2.4.0"><img src="https://img.shields.io/badge/stable-v2.4.0-green.svg" alt="Stable release: v2.4.0"></a>
+    <a href="https://github.com/thecodingmachine/kickoff-docker-php/tree/v2.5.0"><img src="https://img.shields.io/badge/stable-v2.5.0-green.svg" alt="Stable release: v2.5.0"></a>
     <a href="https://github.com/thecodingmachine/kickoff-docker-php/tree/master"><img src="https://img.shields.io/badge/unstable-master-orange.svg" alt="Unstable release: master"></a>
     <a href="https://travis-ci.org/thecodingmachine/kickoff-docker-php"><img src="https://img.shields.io/travis/thecodingmachine/kickoff-docker-php.svg?label=Travis+CI" alt="Travis CI"></a>
 </p>
@@ -27,7 +27,7 @@ following goals in mind:
 * [Features](#features)
 * [Install](#install)
 * [Quick start](#quick-start)
-* [Orbit commands](#orbit-commands)
+* [Orbit tasks](#orbit-tasks)
 * [Project structure](#project-structure)
 * [Configuration](#configuration)
 * [Modules](#modules)
@@ -60,7 +60,7 @@ On Linux, you also have to install [Docker compose](https://docs.docker.com/comp
 come with by default. Also add your current user to the `docker` group and don't forget to logout/login from your current 
 session.
 
-Then download and install [Orbit](https://github.com/gulien/orbit) (**>= 2.0.0**), a tool for generating files from templates and 
+Then download and install [Orbit](https://github.com/gulien/orbit) (**>= 3.0.0**), a tool for generating files from templates and 
 running commands.
 
 You may now fork this project and clone it or download the latest release from the [releases page](../../releases).
@@ -121,21 +121,21 @@ The installation might take some time, so go for a coffee break! :coffee:
 Once everything has been installed, open your favorite web browser and copy / paste https://www.your-virtualhost.local 
 and check if everything is OK!
 
-## Orbit commands
+## Orbit tasks
 
 **Note:** You can use the `-d` flag to have a more detailed output.
 
-### Main commands
+### Main tasks
 
 | Command                | Description                                                                                                                                              |
 |------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `orbit run`            | Displays available Orbit commands.                                                                                                                       |
+| `orbit run`            | Displays available tasks.                                                                                                                       |
 | `orbit run kickoff`    | Generates all configuration files, builds the NGINX and PHP-FPM images and starts the containers. It's a combo of `build`, `proxy-up` and `up` commands. |
 | `orbit run shutdown`   | Stops all containers. It's a combo of  `down` and `proxy-down` commands.                                                                                 |
 | `orbit run workspace`  | Connects through ash to the PHP-FPM container. This is where you're able to run useful commands like `composer` and `yarn`.                              |
 | `orbit run mysql-cli`  | Opens the MySQL cli as `root`. On environments <> `local`, it will ask you the MySQL `root` password.                                                    |
 
-### Others commands
+### Others tasks
 
 **Note:** you should not use them, unless you know what you're doing!
 

config/orbit/messages.yml

@@ -1,14 +1,14 @@
 # |--------------------------------------------------------------------------
-# | Orbit build commands
+# | Build tasks
 # |--------------------------------------------------------------------------
 # |
-# | This file describes the build commands of your project.
-# | Feel free to add your own commands!
+# | This file describes the build tasks of your project.
+# | Feel free to add your own tasks!
 # |
 # | https://github.com/gulien/orbit/
 # |
 
-commands:
+tasks:
 
   # |--------------------------------------------------------------------------
   # | orbit run docker-sync-build
@@ -19,11 +19,9 @@ commands:
 
   - use: docker-sync-build
     run:
-      {{ if eq "true" .EnvFiles.Config.ENABLE_DOCKER_SYNC }}
-      - orbit generate -t docker-sync.blueprint.yml -o docker-sync.yml -v Project,config/project.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit run script-fix-permissions-docker-sync -c config/orbit/orbit-scripts.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      {{ else if eq "windows" os }}
-      - cmd.exe /c echo Skipping Docker Sync configuration file generation ...
+      {{ if eq "true" .Orbit.EnvFile.ENABLE_DOCKER_SYNC }}
+      - orbit generate -f docker-sync.blueprint.yml -o docker-sync.yml {{ if debug }}-d{{ end }}
+      - orbit run script-fix-permissions-docker-sync -f config/orbit/orbit-scripts.yml {{ if debug }}-d{{ end }}
       {{ else }}
       - echo Skipping Docker Sync configuration file generation ...
       {{ end }}
@@ -37,7 +35,7 @@ commands:
 
   - use: toolbox-build
     run:
-      - orbit generate -t modules/toolbox/docker-compose.blueprint.yml -o modules/toolbox/docker-compose.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
+      - orbit generate -f modules/toolbox/docker-compose.blueprint.yml -o modules/toolbox/docker-compose.yml {{ if debug }}-d{{ end }}
 
   # |--------------------------------------------------------------------------
   # | orbit run traefik-build
@@ -48,10 +46,10 @@ commands:
 
   - use: traefik-build
     run:
-      - orbit run script-traefik-self-signed-certificate -c config/orbit/orbit-scripts.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit run script-traefik-htdigest -c config/orbit/orbit-scripts.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit generate -t modules/traefik/traefik.blueprint.toml -o modules/traefik/traefik.toml -v Project,config/project.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit generate -t modules/traefik/docker-compose.blueprint.yml -o modules/traefik/docker-compose.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
+      - orbit run script-traefik-self-signed-certificate -f config/orbit/orbit-scripts.yml {{ if debug }}-d{{ end }}
+      - orbit run script-traefik-htdigest -f config/orbit/orbit-scripts.yml {{ if debug }}-d{{ end }}
+      - orbit generate -f modules/traefik/traefik.blueprint.toml -o modules/traefik/traefik.toml {{ if debug }}-d{{ end }}
+      - orbit generate -f modules/traefik/docker-compose.blueprint.yml -o modules/traefik/docker-compose.yml {{ if debug }}-d{{ end }}
 
   # |--------------------------------------------------------------------------
   # | orbit run graylog-build
@@ -62,12 +60,10 @@ commands:
 
   - use: graylog-build
     run:
-      {{ if eq true .Values.Modules.graylog.enable }}
-      - orbit generate -t modules/graylog/docker-compose.blueprint.yml -o modules/graylog/docker-compose.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit generate -t modules/graylog/udp-input.blueprint.json -o modules/graylog/udp-input.json -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit run script-graylog-secrets -c config/orbit/orbit-scripts.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      {{ else if eq "windows" os }}
-      - cmd.exe /c echo Skipping Graylog configuration files generation ...
+      {{ if eq true .Orbit.Modules.graylog.enable }}
+      - orbit generate -f modules/graylog/docker-compose.blueprint.yml -o modules/graylog/docker-compose.yml {{ if debug }}-d{{ end }}
+      - orbit generate -f modules/graylog/udp-input.blueprint.json -o modules/graylog/udp-input.json {{ if debug }}-d{{ end }}
+      - orbit run script-graylog-secrets -f config/orbit/orbit-scripts.yml {{ if debug }}-d{{ end }}
       {{ else }}
       - echo Skipping Graylog configuration files generation ...
       {{ end }}
@@ -76,16 +72,16 @@ commands:
   # | orbit run php-fpm-build
   # |--------------------------------------------------------------------------
   # |
-  # | Generates PHP-FPM configuration files and builds the image.
+  # | Generates PHP-FPM configuration files.
   # |
 
   - use: php-fpm-build
     run:
-      - orbit generate -t modules/php-fpm/docker-compose.blueprint.yml -o modules/php-fpm/docker-compose.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit run script-fix-permissions-php-fpm -c config/orbit/orbit-scripts.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit generate -t modules/php-fpm/conf.d/memory-limit.blueprint.ini -o modules/php-fpm/conf.d/memory-limit.ini -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit generate -t modules/php-fpm/php-fpm.d/memory-limit.blueprint.conf -o modules/php-fpm/php-fpm.d/memory-limit.conf -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit generate -t modules/php-fpm/php-fpm.d/security.blueprint.conf -o modules/php-fpm/php-fpm.d/security.conf -e Config,config/.env {{ if debug }}-d{{ end }}
+      - orbit generate -f modules/php-fpm/docker-compose.blueprint.yml -o modules/php-fpm/docker-compose.yml {{ if debug }}-d{{ end }}
+      - orbit run script-fix-permissions-php-fpm -f config/orbit/orbit-scripts.yml {{ if debug }}-d{{ end }}
+      - orbit generate -f modules/php-fpm/conf.d/memory-limit.blueprint.ini -o modules/php-fpm/conf.d/memory-limit.ini {{ if debug }}-d{{ end }}
+      - orbit generate -f modules/php-fpm/php-fpm.d/memory-limit.blueprint.conf -o modules/php-fpm/php-fpm.d/memory-limit.conf {{ if debug }}-d{{ end }}
+      - orbit generate -f modules/php-fpm/php-fpm.d/security.blueprint.conf -o modules/php-fpm/php-fpm.d/security.conf {{ if debug }}-d{{ end }}
 
   # |--------------------------------------------------------------------------
   # | orbit run nginx-build
@@ -96,9 +92,9 @@ commands:
 
   - use: nginx-build
     run:
-      - orbit generate -t modules/nginx/docker-compose.blueprint.yml -o modules/nginx/docker-compose.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit run script-fix-permissions-nginx -c config/orbit/orbit-scripts.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      - docker-compose -p {{ .EnvFiles.Config.ENV }}{{ .Values.Project.name }} -f modules/nginx/docker-compose.yml build
+      - orbit generate -f modules/nginx/docker-compose.blueprint.yml -o modules/nginx/docker-compose.yml {{ if debug }}-d{{ end }}
+      - orbit run script-fix-permissions-nginx -f config/orbit/orbit-scripts.yml {{ if debug }}-d{{ end }}
+      - docker-compose -p {{ .Orbit.EnvFile.ENV }}{{ .Orbit.Project.name }} -f modules/nginx/docker-compose.yml build
 
   # |--------------------------------------------------------------------------
   # | orbit run mysql-build
@@ -109,13 +105,11 @@ commands:
 
   - use: mysql-build
     run:
-      {{ if eq true .Values.Modules.mysql.enable }}
-      - orbit generate -t modules/mysql/docker-compose.blueprint.yml -o modules/mysql/docker-compose.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit generate -t modules/mysql/docker-entrypoint-initdb.d/databases.blueprint.sql -o modules/mysql/docker-entrypoint-initdb.d/databases.sql -v Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit generate -t modules/mysql/secrets/mysql_password.blueprint.txt -o modules/mysql/secrets/mysql_password.txt -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit generate -t modules/mysql/secrets/mysql_root_password.blueprint.txt -o modules/mysql/secrets/mysql_root_password.txt -e Config,config/.env {{ if debug }}-d{{ end }}
-      {{ else if eq "windows" os }}
-      - cmd.exe /c echo Skipping MySQL configuration files generation ...
+      {{ if eq true .Orbit.Modules.mysql.enable }}
+      - orbit generate -f modules/mysql/docker-compose.blueprint.yml -o modules/mysql/docker-compose.yml {{ if debug }}-d{{ end }}
+      - orbit generate -f modules/mysql/docker-entrypoint-initdb.d/databases.blueprint.sql -o modules/mysql/docker-entrypoint-initdb.d/databases.sql {{ if debug }}-d{{ end }}
+      - orbit generate -f modules/mysql/secrets/mysql_password.blueprint.txt -o modules/mysql/secrets/mysql_password.txt {{ if debug }}-d{{ end }}
+      - orbit generate -f modules/mysql/secrets/mysql_root_password.blueprint.txt -o modules/mysql/secrets/mysql_root_password.txt {{ if debug }}-d{{ end }}
       {{ else }}
       - echo Skipping MySQL configuration files generation ...
       {{ end }}
@@ -129,10 +123,8 @@ commands:
 
   - use: redis-build
     run:
-      {{ if eq true .Values.Modules.redis.enable }}
-      - orbit generate -t modules/redis/docker-compose.blueprint.yml -o modules/redis/docker-compose.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      {{ else if eq "windows" os }}
-      - cmd.exe /c echo Skipping Redis configuration files generation ...
+      {{ if eq true .Orbit.Modules.redis.enable }}
+      - orbit generate -f modules/redis/docker-compose.blueprint.yml -o modules/redis/docker-compose.yml {{ if debug }}-d{{ end }}
       {{ else }}
       - echo Skipping Redis configuration files generation ...
       {{ end }}
@@ -146,10 +138,8 @@ commands:
 
   - use: rabbitmq-build
     run:
-      {{ if eq true .Values.Modules.rabbitmq.enable }}
-      - orbit generate -t modules/rabbitmq/docker-compose.blueprint.yml -o modules/rabbitmq/docker-compose.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
-      {{ else if eq "windows" os }}
-      - cmd.exe /c echo Skipping RabbitMQ configuration files generation ...
+      {{ if eq true .Orbit.Modules.rabbitmq.enable }}
+      - orbit generate -f modules/rabbitmq/docker-compose.blueprint.yml -o modules/rabbitmq/docker-compose.yml {{ if debug }}-d{{ end }}
       {{ else }}
       - echo Skipping RabbitMQ configuration files generation ...
       {{ end }}

config/orbit/orbit-build.yml

@@ -1,14 +1,14 @@
 # |--------------------------------------------------------------------------
-# | Orbit commands
+# | Tasks for commands
 # |--------------------------------------------------------------------------
 # |
 # | This file describes the commands from the containers of your project.
-# | Feel free to add your own commands!
+# | Feel free to add your own tasks!
 # |
 # | https://github.com/gulien/orbit/
 # |
 
-commands:
+tasks:
 
   # |--------------------------------------------------------------------------
   # | orbit run command-workspace
@@ -19,7 +19,7 @@ commands:
 
   - use: command-workspace
     run:
-      - docker exec --user www-data -ti {{ .EnvFiles.Config.ENV }}-{{ .Values.Project.name }}-php-fpm ash
+      - docker exec --user www-data -ti {{ .Orbit.EnvFile.ENV }}-{{ .Orbit.Project.name }}-php-fpm ash
 
   # |--------------------------------------------------------------------------
   # | orbit run command-mysql-cli
@@ -32,10 +32,8 @@ commands:
 
   - use: command-mysql-cli
     run:
-      {{ if eq true .Values.Modules.mysql.enable }}
-      - docker exec -ti {{ .EnvFiles.Config.ENV }}-{{ .Values.Project.name }}-mysql mysql -uroot -p{{ if eq "local" .EnvFiles.Config.ENV }}{{ .EnvFiles.Config.MYSQL_ROOT_PASSWORD }}{{ end }}
-      {{ else if eq "windows" os }}
-      - cmd.exe /c echo MySQL is not enable!
+      {{ if eq true .Orbit.Modules.mysql.enable }}
+      - docker exec -ti {{ .Orbit.EnvFile.ENV }}-{{ .Orbit.Project.name }}-mysql mysql -uroot -p{{ if eq "local" .Orbit.EnvFile.ENV }}{{ .Orbit.EnvFile.MYSQL_ROOT_PASSWORD }}{{ end }}
       {{ else }}
       - echo MySQL is not enable!
       {{ end }}