docs: deployment API key lifecycle + reserved env vars - #504
Draft
akxue wants to merge 1 commit into
Draft
Conversation
Explain that each deployment mints its own deployment-scoped KERNEL_API_KEY, that KERNEL_API_KEY and ENTRYPOINT_RELPATH are reserved (user-supplied values are overridden), and how a superseded deployment's key is drained after in-flight invocations complete. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents how the injected
KERNEL_API_KEYworks, closing a gap surfaced by two related issues (deployment-key teardown race, and deploys silently overriding a user-suppliedKERNEL_API_KEY).apps/deploy.mdx— new Reserved environment variables section:KERNEL_API_KEYandENTRYPOINT_RELPATHare reserved; user-supplied values are overridden. Shows the workaround (use a non-reserved var + read it explicitly).info/api-keys.mdx— new Deployment API keys section: one key minted per deployment, injected into invocations, and its lifecycle — a superseded deployment's key is drained (kept valid until in-flight invocations finish, released right after; idle redeploy releases immediately; ~95-min backstop only for workflows that die without releasing).Notes
🤖 Generated with Claude Code