Skip to content

docs: Add external property back to compose and add swarm secrets example using compose#25522

Open
deahtstroke wants to merge 1 commit into
docker:mainfrom
deahtstroke:docs-update-defining-secrets-for-swarm-compose-files
Open

docs: Add external property back to compose and add swarm secrets example using compose#25522
deahtstroke wants to merge 1 commit into
docker:mainfrom
deahtstroke:docs-update-defining-secrets-for-swarm-compose-files

Conversation

@deahtstroke

@deahtstroke deahtstroke commented Jul 9, 2026

Copy link
Copy Markdown

Description

Added back the attribute external in the /reference/compose/secrets section with a warning that this attribute is only available for Docker Swarm. Additionally, I added a small toy reference example to the section "Defining and using Secrets in compose files" and moved the section outside of the "Examples" section. The reason why I did this is because I noticed the Examples are all runnable steps that showcase concrete usage of secrets, the example I added is just a skeleton/reference to how they should be used in conjunction with docker secret create..., not a true able-to-run example like the ones below. I also changed the hyperlink from /reference/compose-file/legacy-versions.md to /reference/compose-file/secrets.md.

A few caveats that I wasn't sure about when writing this:

  • I'm not sure if using the "[!NOTE]" in the attributes list is the approach maintainers and writers might favor and I can change it accordingly
  • I'd love to hear feedback on moving "Defining and using secrets in compose files" outside of "Examples" due to my reasoning above

Edit:
I'm also not opposed to making a fully working example using compose, stack and secrets and putting the section back under Examples

Related issues or tickets

#25491

Reviews

  • Technical review
  • Editorial review
  • Product review

@deahtstroke deahtstroke requested a review from dvdksn as a code owner July 9, 2026 01:47
@netlify

netlify Bot commented Jul 9, 2026

Copy link
Copy Markdown

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 55470bc
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/6a4efdbab6455a00087573cf
😎 Deploy Preview https://deploy-preview-25522--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions Bot added area/engine Issue affects Docker engine/daemon area/compose Relates to docker-compose.yml spec or docker-compose binary area/swarm Issue affects swarm and clustering functionality of docker labels Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/compose Relates to docker-compose.yml spec or docker-compose binary area/engine Issue affects Docker engine/daemon area/swarm Issue affects swarm and clustering functionality of docker

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant