Skip to content

docs: live secret updates for dictionary directory mounts - #373

Merged
enk21 merged 3 commits into
mainfrom
docs/secret-live-update
Oct 27, 2026
Merged

enk21 merged 3 commits into
mainfrom
docs/secret-live-update

Conversation

@igorchyts

Copy link
Copy Markdown
Collaborator

Summary

Documents how to mount a secret so a running workload picks up a new value without a redeployment.

  • reference/workload/volumes: new Live Secret Updates section. A dictionary secret mounted as a directory (uri: cpln://secret/NAME, no .KEY) is refreshed in place. Propagation takes up to about 10 minutes, and the app must re-read the files (watch the directory, because the update is a symlink swap). Env vars, single-key file mounts, and opaque secrets keep their old value until a redeploy.
  • reference/secret: the "Updating Secrets" section said every update needs a redeploy. It now names the exception and links to the new section.
  • guides/create-secret/dictionary: adds a Tip under "Mount as Directory".
  • llms.txt / skill.md: one line each so agents stop saying every secret change needs a redeploy.

How it was tested

A standard workload, with each mount type below:

Mount Updated in place?
Opaque secret mounted as a file No
Single dictionary key (cpln://secret/NAME.KEY) mounted as a file No
Whole dictionary secret (cpln://secret/NAME) mounted as a directory Yes, after about 9 minutes

Open questions for review

  • Is "up to about 10 minutes" the right number to publish? It comes from a single test.
  • Do other secret types mounted as a directory (userpass, keypair, and so on) also refresh? The docs only claim dictionary for now.

Checks

  • npx mintlify broken-links: no broken links
  • npx mintlify dev does not start, because the remote OpenAPI spec fails validation (/components/schemas/gvc: must have required property '$ref'). This change did not cause it.

🤖 Generated with Claude Code

A dictionary secret mounted as a directory (whole secret, no key) is
refreshed in the running container when the secret changes. Single-key
file mounts, opaque secrets, and env vars still need a redeploy.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
controlplanecorporation 🔴 Failed – Oct 27, 2026, 4:28 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

igorchyts and others added 2 commits October 27, 2026 09:47
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@igorchyts
igorchyts marked this pull request as ready for review October 27, 2026 16:58
@github-actions

Copy link
Copy Markdown

No description provided.

@github-actions

Copy link
Copy Markdown

No description provided.

@enk21
enk21 merged commit 2437f8d into main Oct 27, 2026
6 of 7 checks passed
@enk21
enk21 deleted the docs/secret-live-update branch October 27, 2026 18:46
@github-actions

Copy link
Copy Markdown

No description provided.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants