Skip to content
This repository was archived by the owner on Jul 18, 2025. It is now read-only.

Commit ff4ee1f

Browse files
author
Antony MECHIN
committed
Examples: Rename 'simple' to 'wordpress'.
Signed-off-by: Antony MECHIN <[email protected]>
1 parent 659b860 commit ff4ee1f

File tree

6 files changed

+33
-34
lines changed

6 files changed

+33
-34
lines changed

examples/simple/README.md renamed to examples/wordpress/README.md

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
### Visualize app configuration
44

55
```yaml
6-
# docker-app render simple
6+
# docker-app render wordpress
77
version: "3.6"
88
services:
99
mysql:
@@ -42,7 +42,7 @@ configs: {}
4242
**Merge with override Compose file**. This example replaces cleartext DB passwords to use secrets instead.
4343
4444
```yaml
45-
# docker-app render simple -c with-secrets.yml
45+
# docker-app render wordpress -c with-secrets.yml
4646
version: "3.6"
4747
services:
4848
mysql:
@@ -52,9 +52,9 @@ services:
5252
environment:
5353
MYSQL_DATABASE: wordpressdata
5454
MYSQL_PASSWORD: ""
55-
MYSQL_PASSWORD_FILE: /run/secrets/simple_app_userpass
55+
MYSQL_PASSWORD_FILE: /run/secrets/wordpress_app_userpass
5656
MYSQL_ROOT_PASSWORD: ""
57-
MYSQL_ROOT_PASSWORD_FILE: /run/secrets/simple_app_rootpass
57+
MYSQL_ROOT_PASSWORD_FILE: /run/secrets/wordpress_app_rootpass
5858
MYSQL_USER: wordpress
5959
image: mysql:8
6060
secrets:
@@ -84,18 +84,18 @@ volumes:
8484
name: db_data
8585
secrets:
8686
mysql_rootpass:
87-
name: simple_app_rootpass
87+
name: wordpress_app_rootpass
8888
external: true
8989
mysql_userpass:
90-
name: simple_app_userpass
90+
name: wordpress_app_userpass
9191
external: true
9292
configs: {}
9393
```
9494
9595
**Override default settings**. This example sets `debug` to false.
9696

9797
```yaml
98-
# docker-app render simple -s prod-settings.yml
98+
# docker-app render wordpress -s prod-settings.yml
9999
version: "3.6"
100100
[...]
101101
environment:
@@ -110,7 +110,7 @@ version: "3.6"
110110
**Override from the command line**. This example sets `debug` to false and the database user to a
111111
different value.
112112
```yaml
113-
# docker-app render simple -e debug=true -e mysql.user.name=mollydock
113+
# docker-app render wordpress -e debug=true -e mysql.user.name=mollydock
114114
version: "3.6"
115115
services:
116116
mysql:
@@ -135,8 +135,8 @@ services:
135135
### View app metadata
136136

137137
```yaml
138-
# docker-app inspect simple
139-
simple 0.1.0
138+
# docker-app inspect wordpress
139+
wordpress 0.1.0
140140
Maintained by: sakuya.izayoi <[email protected]>
141141
142142
@@ -156,18 +156,18 @@ wordpress.scale.replicas 0
156156

157157
### Generate helm package
158158

159-
`docker-app helm simple` will output a Helm package in the `./simple.helm` folder. `-c`, `-e` and `-s` flags apply the same way they do for the `render` subcommand.
159+
`docker-app helm wordpress` will output a Helm package in the `./wordpress.helm` folder. `-c`, `-e` and `-s` flags apply the same way they do for the `render` subcommand.
160160

161161
```
162-
$ docker-app helm simple -c with-secrets.yml -s prod-settings.yml -e mysql.user.name=mollydock
163-
$ tree simple.helm
164-
simple.helm/
162+
$ docker-app helm wordpress -c with-secrets.yml -s prod-settings.yml -e mysql.user.name=mollydock
163+
$ tree wordpress.helm
164+
wordpress.helm/
165165
├── Chart.yaml
166166
└── templates
167167
└── stack.yaml
168168

169169
1 directory, 2 files
170-
$ cat simple.helm/templates/stack.yaml
170+
$ cat wordpress.helm/templates/stack.yaml
171171
typemeta:
172172
kind: stacks.compose.docker.com
173173
apiversion: v1beta2
@@ -177,28 +177,28 @@ objectmeta:
177177
178178
### Generate distributable app package
179179
180-
`docker-app save simple` creates a Docker image packaging the relevant configuration files:
180+
`docker-app save wordpress` creates a Docker image packaging the relevant configuration files:
181181
182182
```
183-
$ docker-app save simple
184-
$ docker images simple.dockerapp
183+
$ docker-app save wordpress
184+
$ docker images wordpress.dockerapp
185185
REPOSITORY TAG IMAGE ID CREATED SIZE
186-
simple.dockerapp latest 61f8cafb7762 4 minutes ago 1.2kB
186+
wordpress.dockerapp latest 61f8cafb7762 4 minutes ago 1.2kB
187187
```
188188
189189
The package can later be retrieved using `docker-app load`:
190190
191191
```
192-
$ rm -rf simple.dockerapp
193-
$ docker-app load simple.dockerapp
194-
$ tar -tf simple.dockerapp # TODO: should unpack automatically?
192+
$ rm -rf wordpress.dockerapp
193+
$ docker-app load wordpress.dockerapp
194+
$ tar -tf wordpress.dockerapp # TODO: should unpack automatically?
195195
metadata.yml
196196
docker-compose.yml
197197
settings.yml
198-
$ mv simple.dockerapp simple # TODO: fix UX
199-
$ docker-app unpack simple
200-
$ tree simple.dockerapp
201-
./simple.dockerapp/
198+
$ mv wordpress.dockerapp wordpress # TODO: fix UX
199+
$ docker-app unpack wordpress
200+
$ tree wordpress.dockerapp
201+
./wordpress.dockerapp/
202202
├── metadata.yml
203203
├── docker-compose.yml
204204
└── settings.yml
@@ -208,13 +208,12 @@ $ tree simple.dockerapp
208208
209209
### Archive app package
210210
211-
`docker-app pack simple` creates a tar archive containing the relevant configuration files:
211+
`docker-app pack wordpress` creates a tar archive containing the relevant configuration files:
212212
213213
```
214-
$ docker-app pack simple -o myapp.tar
214+
$ docker-app pack wordpress -o myapp.tar
215215
$ tar -tf myapp.tar
216216
metadata.yml
217217
docker-compose.yml
218218
settings.yml
219219
```
220-

examples/simple/with-secrets.yml renamed to examples/wordpress/with-secrets.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@ version: '3.6'
22
secrets:
33
mysql_rootpass:
44
external: true
5-
name: simple_app_rootpass
5+
name: wordpress_app_rootpass
66
mysql_userpass:
77
external: true
8-
name: simple_app_userpass
8+
name: wordpress_app_userpass
99

1010
services:
1111
mysql:
1212
environment:
13-
MYSQL_ROOT_PASSWORD_FILE: /run/secrets/simple_app_rootpass
14-
MYSQL_PASSWORD_FILE: /run/secrets/simple_app_userpass
13+
MYSQL_ROOT_PASSWORD_FILE: /run/secrets/wordpress_app_rootpass
14+
MYSQL_PASSWORD_FILE: /run/secrets/wordpress_app_userpass
1515
MYSQL_PASSWORD: ""
1616
MYSQL_ROOT_PASSWORD: ""
1717
secrets:

examples/simple/simple.dockerapp/metadata.yml renamed to examples/wordpress/wordpress.dockerapp/metadata.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
version: 0.1.0
2-
name: simple
2+
name: wordpress
33
description: ""
44
maintainers:
55
- name: sakuya.izayoi

0 commit comments

Comments
 (0)