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

[DOCUMENTATION] Why name field of secret is not documented? #12504

Open
YuryHrytsuk opened this issue Jan 28, 2025 · 3 comments
Open

[DOCUMENTATION] Why name field of secret is not documented? #12504

YuryHrytsuk opened this issue Jan 28, 2025 · 3 comments

Comments

@YuryHrytsuk
Copy link

YuryHrytsuk commented Jan 28, 2025

Problem

I would expect to see the examples of using name field for docker secrets below:

Related PRs

Why does it matter

I am currently trying to workaround the "immutability" of docker configs / secrets by using version-pinned name. Read more below:

@YuryHrytsuk YuryHrytsuk changed the title [DOCUMENTATION] Why name field of secret is not documented docker compose specs? [DOCUMENTATION] Why name field of secret is not documented? Jan 28, 2025
@ndeloof
Copy link
Contributor

ndeloof commented Jan 29, 2025

This is well documented in the compose-spec : https://github.com/compose-spec/compose-spec/blob/main/09-secrets.md
I'm not sure why docs isn't aligned with this reference. cc @aevesdocker

@YuryHrytsuk
Copy link
Author

YuryHrytsuk commented Jan 29, 2025

This is well documented in the compose-spec : https://github.com/compose-spec/compose-spec/blob/main/09-secrets.md I'm not sure why docs isn't aligned with this reference. cc @aevesdocker

@ndeloof as far as I understand, the change of name attribute will trigger automatic update of service relying on it. This can be used to update secrets (also configs) on running services which otherwise does not work "out of the box" (e.g. on docker stack deploy) (the official documentation on how to update docker configs with some manual actions)

Do you think it is worth documenting this behavior?

Please, read more about this below:

@ndeloof
Copy link
Contributor

ndeloof commented Jan 29, 2025

unfortunately change to name attribute will not update containers using docker compose
I can't tell about docker swarm, as this repo is about compose, and swarm is 100% a different codebase

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants