docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify the source name of secrets and configs 

The current wording of "name of the config as it exists in Docker" suggests that the real generated name is used, instead the "key" of `configs` object in the docker-compose file is used.

```yml
version: "3.5"

services:
  app:
    image: alpine
    configs:
      # documentation currently suggests this (the "name as in Docker")
      # this causes an error- undefined config "name-as-in-docker"
      - source: name-as-in-docker
        target: /config-with-name-as-in-docker.json

      # the correct source to use is the name (key) from this docker-compose file
      - source: name-as-in-file
        target: /config-with-name-as-in-file.json

configs:
  name-as-in-file:
    name: name-as-in-docker
    file: ./cfg.json
```
This commit is contained in:
Edgars Baduns 2021-04-13 19:28:07 +03:00 committed by GitHub
parent 31a78afbdd
commit 7b6f2d918a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
compose/compose-file/compose-file-v3.md
View File

@ -501,7 +501,7 @@ configs:
The long syntax provides more granularity in how the config is created within
the service's task containers.
- `source`: The name of the config as it exists in Docker.
- `source`: The identifier of the config as it is defined in this configuration.
- `target`: The path and name of the file to be mounted in the service's
task containers. Defaults to `/<source>` if not specified.
- `uid` and `gid`: The numeric UID or GID that owns the mounted config file
@ -1778,7 +1778,7 @@ secrets:
The long syntax provides more granularity in how the secret is created within
the service's task containers.
- `source`: The name of the secret as it exists in Docker.
- `source`: The identifier of the secret as it is defined in this configuration.
- `target`: The name of the file to be mounted in `/run/secrets/` in the
service's task containers. Defaults to `source` if not specified.
- `uid` and `gid`: The numeric UID or GID that owns the file within