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

Update compose reference for name fields (#5755) 

Signed-off-by: Daniel Nephin <dnephin@gmail.com>
This commit is contained in:
Daniel Nephin 2018-01-16 17:15:05 -05:00 committed by Misty Stanley-Jones
parent 4626e6ed23
commit a83592ddaf
1 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
compose/compose-file/index.md
View File

@ -1905,6 +1905,9 @@ called `data` and mount it into the `db` service's containers.
data: data:
external: true external: true
> [external.name was deprecated in version 3.4 file format](compose-versioning.md#version-34)
> use `name` instead.
You can also specify the name of the volume separately from the name used to You can also specify the name of the volume separately from the name used to
refer to it within the Compose file: refer to it within the Compose file:
@ -1947,7 +1950,9 @@ conflicting with those used by other software.
> [Added in version 3.4 file format](compose-versioning.md#version-34) > [Added in version 3.4 file format](compose-versioning.md#version-34)
Set a custom name for this volume. Set a custom name for this volume. The name field can be used to reference
networks which contain special characters. The name is used as is
and will **not** be scoped with the stack name.
version: '3.4' version: '3.4'
volumes: volumes:
@ -2157,6 +2162,10 @@ service's containers to it.
outside: outside:
external: true external: true
> [external.name was deprecated in version 3.5 file format](compose-versioning.md#version-35)
> use `name` instead.
You can also specify the name of the network separately from the name used to You can also specify the name of the network separately from the name used to
refer to it within the Compose file: refer to it within the Compose file:
@ -2169,7 +2178,9 @@ refer to it within the Compose file:
> [Added in version 3.5 file format](compose-versioning.md#version-35) > [Added in version 3.5 file format](compose-versioning.md#version-35)
Set a custom name for this network. Set a custom name for this network. The name field can be used to reference
networks which contain special characters. The name is used as is
and will **not** be scoped with the stack name.
version: '3.5' version: '3.5'
networks: networks:
@ -2195,8 +2206,10 @@ stack. The source of the config is either `file` or `external`.
- `external`: If set to true, specifies that this config has already been - `external`: If set to true, specifies that this config has already been
created. Docker will not attempt to create it, and if it does not exist, a created. Docker will not attempt to create it, and if it does not exist, a
`config not found` error occurs. `config not found` error occurs.
- `name`: The actual name of the config object in Docker. Introduced with the - `name`: The name of the config object in Docker. This field can be used to
3.5 file format. reference configs which contain special characters. The name is used as is
and will **not** be scoped with the stack name. Introduced in version 3.5
file format.
In this example, `my_first_config` will be created (as In this example, `my_first_config` will be created (as
`<stack_name>_my_first_config)`when the stack is deployed, `<stack_name>_my_first_config)`when the stack is deployed,
@ -2240,8 +2253,10 @@ stack. The source of the secret is either `file` or `external`.
- `external`: If set to true, specifies that this secret has already been - `external`: If set to true, specifies that this secret has already been
created. Docker will not attempt to create it, and if it does not exist, a created. Docker will not attempt to create it, and if it does not exist, a
`secret not found` error occurs. `secret not found` error occurs.
- `name`: The actual name of the config object in Docker. Introduced with the - `name`: The name of the secret object in Docker. This field can be used to
3.5 file format. reference secrets which contain special characters. The name is used as is
and will **not** be scoped with the stack name. Introduced in version 3.5
file format.
In this example, `my_first_secret` will be created (as In this example, `my_first_secret` will be created (as
`<stack_name>_my_first_secret)`when the stack is deployed, `<stack_name>_my_first_secret)`when the stack is deployed,