Missing 'external' source for secrets attribute

[man-gc]

Is this a docs issue?

• [X] My issue is about the documentation content or website

Type of issue

Information is incorrect

Description

In the description of the secrets top-level attribute, the external source is missing to indicate that the lifecycle of the secret can be managed outside Compose. Usage of this attribute can be seen here but is not properly described anywhere in the documentation.

Location

https://docs.docker.com/compose/compose-file/09-secrets/

Suggestion

No response

[aevesdocker]

Hi @man-gc, thanks for raising the issue. This is actually a mistake in the docs. external is not supported by Docker Compose. Apologies for the confusion, the docs will be updated shortly.

[thaJeztah]

I think external may have been part of the compose v3 specification (as used by docker stack), so we should check if it's correct to remove, or if it was missed when creating the compose-spec; https://docs.docker.com/compose/compose-file/compose-file-v3/#secrets

cc @glours

[glours]

external is still part of the Compose Specification but as mentioned by @aevesdocker it's not support by Docker Compose itself, that's why there isn't any reference to this attribut in the Docker Compose documentation.

When you read Compose in the spec it should interpreted this way:

From this point onwards, references made to 'Compose' can be interpreted as 'a Compose implementation'.

Which means that the external could be supported by other implementations of the Compose Specification.

[docker-robot[bot]]

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