Skip to content
This repository was archived by the owner on Mar 15, 2019. It is now read-only.

Commit ce1f4a8

Browse files
author
Julien Neuhart
authored
updating templates & commands for Orbit v2.0.0 + adding health check of modules + updating some services versions (#45)
1 parent e20cf11 commit ce1f4a8

23 files changed

+190
-271
lines changed

‎.travis.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ before_install:
1414
- curl -L https://github.com/docker/compose/releases/download/1.14.0/docker-compose-`uname -s`-`uname -m` > docker-compose
1515
- chmod +x docker-compose
1616
- sudo mv docker-compose /usr/local/bin
17-
- wget https://github.com/gulien/orbit/releases/download/v1.0.0/orbit_Linux_x86_64.tar.gz && tar -xzf orbit*.tar.gz orbit && rm -f orbit*.tar.gz
17+
- 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
1818
- sudo mv ./orbit /usr/local/bin && chmod +x /usr/local/bin/orbit
1919

2020
script:

‎README.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<h3 align="center">kickoff-docker-php</h3>
55
<p align="center">A complete stack for your PHP project powered by Docker</p>
66
<p align="center">
7-
<a href="https://github.com/thecodingmachine/kickoff-docker-php/tree/v2.0.3"><img src="https://img.shields.io/badge/stable-v2.0.3-green.svg" alt="Stable release: v2.0.3"></a>
7+
<a href="https://github.com/thecodingmachine/kickoff-docker-php/tree/v2.1.0"><img src="https://img.shields.io/badge/stable-v2.1.0-green.svg" alt="Stable release: v2.1.0"></a>
88
<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>
99
<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>
1010
</p>
@@ -58,7 +58,7 @@ On Linux, you also have to install [Docker compose](https://docs.docker.com/comp
5858
come with by default. Also add your current user to the `docker` group and don't forget to logout/login from your current
5959
session.
6060

61-
Then download and install [Orbit](https://github.com/gulien/orbit) (**1.0.0**), a tool for generating files from templates and
61+
Then download and install [Orbit](https://github.com/gulien/orbit) (**>= 2.0.0**), a tool for generating files from templates and
6262
running commands.
6363

6464
You may now fork this project and clone it or download the latest release from the [releases page](../../releases).
@@ -121,8 +121,9 @@ and check if everything is OK!
121121

122122
## Orbit commands
123123

124-
| Command | description |
124+
| Command | Description |
125125
|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
126+
| `orbit run` | Displays available Orbit commands. |
126127
| `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. |
127128
| `orbit run shutdown` | Stops all containers. It's a combo of `down` and `proxy-down` commands. |
128129
| `orbit run build` | Generates all configuration files and builds the NGINX and PHP-FPM images. |
@@ -133,6 +134,8 @@ and check if everything is OK!
133134
| `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`. |
134135
| `orbit run mysql-cli` | Opens the MySQL cli as `root`. On environments <> `local`, it will ask you the MySQL `root` password. |
135136

137+
**Note:** You can use the `-d` flag to have a more detailed output.
138+
136139
## Project structure
137140

138141
```

‎config/orbit/orbit-build.yml‎

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ commands:
1717
# | Generates Docker Sync configuration file.
1818
# |
1919

20-
- use: "docker-sync-build"
20+
- use: docker-sync-build
2121
run:
2222
{{ if eq "true" .EnvFiles.Config.ENABLE_DOCKER_SYNC }}
23-
- orbit generate -t docker-sync.blueprint.yml -o docker-sync.yml -v Project,config/project.yml -e Config,config/.env
24-
- 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
25-
{{ else if eq "windows" .Os }}
23+
- orbit generate -t docker-sync.blueprint.yml -o docker-sync.yml -v Project,config/project.yml -e Config,config/.env {{ if debug }}-d{{ end }}
24+
- 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 }}
25+
{{ else if eq "windows" os }}
2626
- cmd.exe /c echo Skipping Docker Sync configuration file generation ...
2727
{{ else }}
2828
- echo Skipping Docker Sync configuration file generation ...
@@ -35,9 +35,9 @@ commands:
3535
# | Generates Toolbox configuration files.
3636
# |
3737

38-
- use: "toolbox-build"
38+
- use: toolbox-build
3939
run:
40-
- 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
40+
- 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 }}
4141

4242
# |--------------------------------------------------------------------------
4343
# | orbit run traefik-build
@@ -46,12 +46,12 @@ commands:
4646
# | Generates Traefik configuration files.
4747
# |
4848

49-
- use: "traefik-build"
49+
- use: traefik-build
5050
run:
51-
- 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
52-
- orbit run script-traefik-htdigest -c config/orbit/orbit-scripts.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env
53-
- orbit generate -t modules/traefik/traefik.blueprint.toml -o modules/traefik/traefik.toml -v Project,config/project.yml -e Config,config/.env
54-
- 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
51+
- 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 }}
52+
- 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 }}
53+
- 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 }}
54+
- 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 }}
5555

5656
# |--------------------------------------------------------------------------
5757
# | orbit run graylog-build
@@ -60,13 +60,13 @@ commands:
6060
# | Generates Graylog configuration files.
6161
# |
6262

63-
- use: "graylog-build"
63+
- use: graylog-build
6464
run:
6565
{{ if eq true .Values.Modules.graylog.enable }}
66-
- 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
67-
- orbit generate -t modules/graylog/udp-input.blueprint.json -o modules/graylog/udp-input.json -e Config,config/.env
68-
- orbit run script-graylog-secrets -c config/orbit/orbit-scripts.yml -v Project,config/project.yml;Modules,config/modules.yml -e Config,config/.env
69-
{{ else if eq "windows" .Os }}
66+
- 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 }}
67+
- orbit generate -t modules/graylog/udp-input.blueprint.json -o modules/graylog/udp-input.json -e Config,config/.env {{ if debug }}-d{{ end }}
68+
- 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 }}
69+
{{ else if eq "windows" os }}
7070
- cmd.exe /c echo Skipping Graylog configuration files generation ...
7171
{{ else }}
7272
- echo Skipping Graylog configuration files generation ...
@@ -79,14 +79,14 @@ commands:
7979
# | Generates PHP-FPM configuration files and builds the image.
8080
# |
8181

82-
- use: "php-fpm-build"
82+
- use: php-fpm-build
8383
run:
84-
- 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
85-
- 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
86-
- 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
87-
- 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
88-
- 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
89-
- orbit generate -t modules/php-fpm/Dockerfile.blueprint -o modules/php-fpm/Dockerfile -v Modules,config/modules.yml -e Config,config/.env
84+
- 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 }}
85+
- 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 }}
86+
- 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 }}
87+
- 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 }}
88+
- 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 }}
89+
- orbit generate -t modules/php-fpm/Dockerfile.blueprint -o modules/php-fpm/Dockerfile -v Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
9090
- docker-compose -p {{ .EnvFiles.Config.ENV }}{{ .Values.Project.name }} -f modules/php-fpm/docker-compose.yml build
9191

9292
# |--------------------------------------------------------------------------
@@ -96,10 +96,10 @@ commands:
9696
# | Generates NGINX configuration files and builds the image.
9797
# |
9898

99-
- use: "nginx-build"
99+
- use: nginx-build
100100
run:
101-
- 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
102-
- 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
101+
- 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 }}
102+
- 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 }}
103103
- docker-compose -p {{ .EnvFiles.Config.ENV }}{{ .Values.Project.name }} -f modules/nginx/docker-compose.yml build
104104

105105
# |--------------------------------------------------------------------------
@@ -109,14 +109,14 @@ commands:
109109
# | Generates MySQL configuration files.
110110
# |
111111

112-
- use: "mysql-build"
112+
- use: mysql-build
113113
run:
114114
{{ if eq true .Values.Modules.mysql.enable }}
115-
- 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
116-
- 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
117-
- orbit generate -t modules/mysql/secrets/mysql_password.blueprint.txt -o modules/mysql/secrets/mysql_password.txt -e Config,config/.env
118-
- orbit generate -t modules/mysql/secrets/mysql_root_password.blueprint.txt -o modules/mysql/secrets/mysql_root_password.txt -e Config,config/.env
119-
{{ else if eq "windows" .Os }}
115+
- 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 }}
116+
- 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 }}
117+
- 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 }}
118+
- 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 }}
119+
{{ else if eq "windows" os }}
120120
- cmd.exe /c echo Skipping MySQL configuration files generation ...
121121
{{ else }}
122122
- echo Skipping MySQL configuration files generation ...
@@ -129,11 +129,11 @@ commands:
129129
# | Generates Redis configuration files.
130130
# |
131131

132-
- use: "redis-build"
132+
- use: redis-build
133133
run:
134134
{{ if eq true .Values.Modules.redis.enable }}
135-
- 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
136-
{{ else if eq "windows" .Os }}
135+
- 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 }}
136+
{{ else if eq "windows" os }}
137137
- cmd.exe /c echo Skipping Redis configuration files generation ...
138138
{{ else }}
139139
- echo Skipping Redis configuration files generation ...
@@ -146,11 +146,11 @@ commands:
146146
# | Generates RabbitMQ configuration files.
147147
# |
148148

149-
- use: "rabbitmq-build"
149+
- use: rabbitmq-build
150150
run:
151151
{{ if eq true .Values.Modules.rabbitmq.enable }}
152-
- 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
153-
{{ else if eq "windows" .Os }}
152+
- 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 }}
153+
{{ else if eq "windows" os }}
154154
- cmd.exe /c echo Skipping RabbitMQ configuration files generation ...
155155
{{ else }}
156156
- echo Skipping RabbitMQ configuration files generation ...

‎config/orbit/orbit-commands.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,24 @@ commands:
1717
# | Connects through ash to the PHP-FPM container.
1818
# |
1919

20-
- use: "command-workspace"
20+
- use: command-workspace
2121
run:
2222
- docker exec --user www-data -ti {{ .EnvFiles.Config.ENV }}-{{ .Values.Project.name }}-php-fpm ash
2323

2424
# |--------------------------------------------------------------------------
2525
# | orbit run command-mysql-cli
2626
# |--------------------------------------------------------------------------
2727
# |
28-
# | Opens the MySQL cli as root.
28+
# | Opens the MySQL CLI as root.
2929
# |
3030
# | On environments <> "local", it will ask you the MySQL root password.
3131
# |
3232

33-
- use: "command-mysql-cli"
33+
- use: command-mysql-cli
3434
run:
3535
{{ if eq true .Values.Modules.mysql.enable }}
3636
- 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 }}
37-
{{ else if eq "windows" .Os }}
37+
{{ else if eq "windows" os }}
3838
- cmd.exe /c echo MySQL is not enable!
3939
{{ else }}
4040
- echo MySQL is not enable!

0 commit comments

Comments
 (0)