Skip to content

Commit f2ad1f6

Browse files
alexanderkjeldaasAlexander Kjeldaas
authored andcommitted
Clarify documentation wrt i.c.entrypoints in #2832
Document how the `entrypoints` work wrt which docker images are created. Fixes #2832
1 parent 871e60f commit f2ad1f6

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

doc/yaml_configuration.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,29 @@ You can also specify `entrypoints`. By default all your executables are placed
224224
in `/usr/local/bin`, but you can specify a list using `executables` to only add
225225
some.
226226

227+
When you specify `entrypoints`, multiple containers will be built: a project
228+
container, and one container for each entrypoint.
229+
230+
For example the following configuration:
231+
232+
```yaml
233+
image:
234+
containers:
235+
- name: myproject
236+
base: fpco/stack-run
237+
add:
238+
production/app-backend/conf/: /etc/app-backend
239+
entrypoints:
240+
- app-backend
241+
```
242+
243+
will build one container tagged `myproject:latest` which contains the project
244+
including the `/etc/app-backend` configuration data.
245+
246+
Another container tagged `myproject-app-backend:latest` based on the `myproject:latest`
247+
will additionally contain the logic for starting the `app-backend` entrypoint.
248+
249+
227250
### user-message
228251

229252
A user-message is inserted by `stack init` when it omits packages or adds

0 commit comments

Comments
 (0)