tyler.durden
/
compose
mirror of https://github.com/docker/compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
compose/docs/reference/docker_compose_port.yaml

45 lines
1.1 KiB
YAML
Raw Normal View History

Update compose docs Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2021-05-05 17:37:08 +02:00
command: docker compose port
short: Print the public port for a port binding.
update reference docs Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-06-08 09:39:49 +02:00
long: Prints the public port for a port binding.
update usage strings for consistency This updates the format of various usage strings to be more consistent with other parts of the CLI. - Use `[OPTIONS]` to indicate where command-specific options should be added - Use `[SERVICE...]` to indicate zero-or-more services - Remove some usage strings for specific options (e.g. `-e NAME=VAL`), as that option is part of the already mentioned `[OPTIONS]` and we don't provide usage for each possible option that can be passed. - Remove `[--]`, which (I think) was needed for the Python implementation, but is a general feature to stop processing flag-options. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-08-02 13:11:57 +02:00
usage: docker compose port [OPTIONS] SERVICE PRIVATE_PORT
Update compose docs Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2021-05-05 17:37:08 +02:00
pname: docker compose
plink: docker_compose.yaml
options:
update cli-doc-tool and update the doc with this new version Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
2022-07-26 14:58:08 +02:00
- option: index
value_type: int
default_value: "1"
description: index of the container if service has multiple replicas
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: protocol
value_type: string
default_value: tcp
description: tcp or udp
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
Update dry-run documentation Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
2023-05-05 12:43:27 +02:00
inherited_options:
- option: dry-run
value_type: bool
default_value: "false"
description: Execute command in dry run mode
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
Update compose docs Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2021-05-05 17:37:08 +02:00
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false