Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

References to long syntax for --publish are incorrect #5370

Closed
lachlancooper opened this issue Nov 22, 2017 · 1 comment
Closed

References to long syntax for --publish are incorrect #5370

lachlancooper opened this issue Nov 22, 2017 · 1 comment
Labels
area/engine Issue affects Docker engine/daemon lifecycle/locked

Comments

@lachlancooper
Copy link
Contributor

Problem description

A number of locations throughout the docs give examples using the long syntax for --publish. A typical example is docker-for-aws/load-balancer.md:

docker service create --name nginx --publish target=80,port=80 nginx

However, port= is invalid syntax. Running the above command on a new Docker CE 17.09.0 cluster reports:

invalid argument "target=80,port=80" for --publish: invalid field key port
See 'docker service create --help'.

Rather than target and port, the relevant parameters are published and target. I base this on the port handling code: https://github.com/docker/cli/blob/d7f6563efc059dcc59b21f30f68e9e8282481af9/opts/port.go#L14

Corrected, the above example would be:

docker service create --name nginx --publish published=80,target=80 nginx

Problem location

docker-for-aws/deploy.md
docker-for-aws/load-balancer.md
docker-for-azure/deploy.md
engine/admin/prometheus.md
engine/swarm/configs.md
engine/swarm/ingress.md
engine/swarm/secrets.md
engine/swarm/services.md
engine/swarm/stack-deploy.md
registry/deploying.md

Project version(s) affected

All.

Suggestions for a fix

It appears the issue was introduced in #5323. The examples need to be updated on all referenced pages. Some care will be needed to update engine/swarm/ingress.md as the documentation is more detailed and refers to a mix of parameters: <PUBLISHED-PORT>, <CONTAINER-PORT>, and <TARGET-PORT>.

The related issue docker/cli#695 will also need a fix.

@gbarr01 gbarr01 added the area/engine Issue affects Docker engine/daemon label Nov 22, 2017
docker-jenkins pushed a commit to docker/docker-ce that referenced this issue Dec 13, 2017
This is the same issue as described at docker/docs#5370

Signed-off-by: Lachlan Cooper <lachlancooper@gmail.com>
Upstream-commit: 90f44e564bda77ba3237ccbbc31d7f4e5232c2c0
Component: cli
thaJeztah pushed a commit to thaJeztah/docker-ce that referenced this issue Dec 13, 2017
This is the same issue as described at docker/docs#5370

Signed-off-by: Lachlan Cooper <lachlancooper@gmail.com>
(cherry picked from commit 90f44e564bda77ba3237ccbbc31d7f4e5232c2c0)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
silvin-lubecki pushed a commit to silvin-lubecki/docker-ce that referenced this issue Jan 24, 2020
This is the same issue as described at docker/docs#5370

Signed-off-by: Lachlan Cooper <lachlancooper@gmail.com>
(cherry picked from commit 90f44e564bda77ba3237ccbbc31d7f4e5232c2c0)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
silvin-lubecki pushed a commit to silvin-lubecki/docker-ce that referenced this issue Jan 27, 2020
This is the same issue as described at docker/docs#5370

Signed-off-by: Lachlan Cooper <lachlancooper@gmail.com>
(cherry picked from commit 90f44e564bda77ba3237ccbbc31d7f4e5232c2c0)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
silvin-lubecki pushed a commit to silvin-lubecki/cli-extract that referenced this issue Jan 27, 2020
This is the same issue as described at docker/docs#5370

Signed-off-by: Lachlan Cooper <lachlancooper@gmail.com>
(cherry picked from commit 90f44e5)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
silvin-lubecki pushed a commit to silvin-lubecki/cli-extract that referenced this issue Jan 30, 2020
This is the same issue as described at docker/docs#5370

Signed-off-by: Lachlan Cooper <lachlancooper@gmail.com>
(cherry picked from commit 90f44e5)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
silvin-lubecki pushed a commit to silvin-lubecki/cli-extract that referenced this issue Mar 17, 2020
This is the same issue as described at docker/docs#5370

Signed-off-by: Lachlan Cooper <lachlancooper@gmail.com>
(cherry picked from commit 90f44e5)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
silvin-lubecki pushed a commit to silvin-lubecki/cli-extract that referenced this issue Mar 23, 2020
This is the same issue as described at docker/docs#5370

Signed-off-by: Lachlan Cooper <lachlancooper@gmail.com>
(cherry picked from commit 90f44e5)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@docker-robott
Copy link
Collaborator

Closed issues are locked after 30 days of inactivity.
This helps our team focus on active issues.

If you have found a problem that seems similar to this, please open a new issue.

/lifecycle locked

@docker docker locked and limited conversation to collaborators Mar 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/engine Issue affects Docker engine/daemon lifecycle/locked
Projects
None yet
Development

No branches or pull requests

3 participants