docs: deployment API key lifecycle + reserved env vars - #504
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>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
There was a problem hiding this comment.
Stale comment
Risk assessment: Very Low
Re-evaluated after the latest push (
6bf2556). Risk has not increased; the existing approval stands.What changed (verified from the diff, not the PR description):
apps/deploy.mdx— adds a “Reserved environment variables” section (KERNEL_API_KEY,ENTRYPOINT_RELPATH), Python/TypeScript examples for a non-reserved key, and a subsection on using a different key for the app’s own calls.info/api-keys.mdx— adds a “Deployment API keys” section covering minting, reserved-name override, drain-on-redeploy, and the ~95-minute backstop.Delta since last approval (
a7bc7d3→6bf2556): wording and structure only inapps/deploy.mdx(split reserved vs. workaround into a subheading; rephrase). No new files or behavior.Scope: 2 files, +41 / −0. No application code, config, CI, OpenAPI, or infrastructure files. No CODEOWNERS file in this repo, so CODEOWNERS review is not required.
Why Very Low: docs-site prose and example snippets only. No production logic, auth implementation, shared services, or infra impact.
Not re-approving: this automation already approved the PR, and the new commit does not raise risk.
Sent by Cursor Automation: Assign PR reviewers
There was a problem hiding this comment.
Risk assessment: Very Low
Re-evaluated the current HEAD (6bf2556). Risk has not increased; the existing approval stands. Not re-approving because this automation already approved the PR.
What changed (verified from the diff, not the PR description):
apps/deploy.mdx— adds a Reserved environment variables section (KERNEL_API_KEY,ENTRYPOINT_RELPATH), plus Python/TypeScript examples for passing a non-reserved key to the client.info/api-keys.mdx— adds a Deployment API keys section covering minting, reserved-name override, drain-on-redeploy, and the ~95-minute backstop.
Scope: 2 files, +41 / −0. Mintlify MDX prose and example snippets only. No application code, config, CI, OpenAPI, or infrastructure files. No CODEOWNERS file in this repo, so CODEOWNERS review is not required.
Why Very Low: documentation-only change on a docs site. No production logic, auth implementation, shared services, or infra impact.
Sent by Cursor Automation: Assign PR reviewers


docs-only. spells out the deployment api key lifecycle since none of it was written down, which is part of what made kernel-1620 confusing.
pairs with the deploy-time warnings (cli #230, kernel #3405).
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes with no runtime, auth, or application code impact.
Overview
Documents deployment-scoped
KERNEL_API_KEYbehavior and deploy-time env var rules that were previously undocumented.In
info/api-keys.mdx, adds a Deployment API keys section: each deploy mints its own key injected asKERNEL_API_KEY; redeploy supersedes the old deployment and releases the old key after the deployment is stopped and invocations finish (drain, not hard kill); idle redeploy releases immediately; ~95 minute backstop if a workflow dies without releasing. Clarifies that org/project keys passed explicitly only affect the app’s own API calls—the platform still uses the deployment key for invocation plumbing.In
apps/deploy.mdx, adds Reserved environment variables:KERNEL_API_KEYandENTRYPOINT_RELPATHcannot be overridden via--env/--env-file, plus Python/TypeScript examples for using a non-reserved var (e.g.MY_KERNEL_API_KEY) when you want a long-lived credential.Reviewed by Cursor Bugbot for commit 6bf2556. Bugbot is set up for automated code reviews on this repo. Configure here.