79c9e527a3
Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
62 lines
2.2 KiB
Markdown
62 lines
2.2 KiB
Markdown
# stack config
|
|
|
|
<!---MARKER_GEN_START-->
|
|
Outputs the final config file, after doing merges and interpolations
|
|
|
|
### Options
|
|
|
|
| Name | Type | Default | Description |
|
|
|:-----------------------|:--------------|:--------|:--------------------------------------------------|
|
|
| `-c`, `--compose-file` | `stringSlice` | | Path to a Compose file, or `-` to read from stdin |
|
|
| `--skip-interpolation` | | | Skip interpolation and output only merged config |
|
|
|
|
|
|
<!---MARKER_GEN_END-->
|
|
|
|
## Description
|
|
|
|
Outputs the final Compose file, after doing the merges and interpolations of the input Compose files.
|
|
|
|
## Examples
|
|
|
|
The following command outputs the result of the merge and interpolation of two Compose files.
|
|
|
|
```bash
|
|
$ docker stack config --compose-file docker-compose.yml --compose-file docker-compose.prod.yml
|
|
```
|
|
|
|
The Compose file can also be provided as standard input with `--compose-file -`:
|
|
|
|
```bash
|
|
$ cat docker-compose.yml | docker stack config --compose-file -
|
|
```
|
|
|
|
### Skipping interpolation
|
|
|
|
In some cases, it might be useful to skip interpolation of environment variables.
|
|
For example, when you want to pipe the output of this command back to `stack deploy`.
|
|
|
|
If you have a regex for a redirect route in an environment variable for your webserver you would use two `$` signs to prevent `stack deploy` from interpolating `${1}`.
|
|
|
|
```bash
|
|
service: webserver
|
|
environment:
|
|
REDIRECT_REGEX=http://host/redirect/$${1}
|
|
```
|
|
|
|
With interpolation, the `stack config` command will replace the environment variable in the Compose file
|
|
with `REDIRECT_REGEX=http://host/redirect/${1}`, but then when piping it back to the `stack deploy`
|
|
command it will be interpolated again and result in undefined behavior.
|
|
That is why, when piping the output back to `stack deploy` one should always prefer the `--skip-interpolation` option.
|
|
|
|
```
|
|
$ docker stack config --compose-file web.yml --compose-file web.prod.yml --skip-interpolation | docker stack deploy --compose-file -
|
|
```
|
|
|
|
## Related commands
|
|
|
|
* [stack deploy](stack_deploy.md)
|
|
* [stack ps](stack_ps.md)
|
|
* [stack rm](stack_rm.md)
|
|
* [stack services](stack_services.md)
|