docs(examples): spell out the codex-on-AgentKit deploy choices#609
Merged
Conversation
Users following the README hit the interactive `agentkit config` wizard and could pick wrong (esp. the TOS bucket). Replace the bare command list in the "Deploy" step with: - a copy-paste non-interactive `agentkit config` command (3 placeholders), and - the choices that matter if configuring interactively: launch type = cloud, TOS bucket = Auto (avoids the ListBuckets ownership failure), auth = API Key, runtime role, and the required MODEL_AGENT_* env vars. zh + en.
…onal Split the deploy config into explicit **Required** / **Optional** groups so users know what they must fill: agent_name/entry_point/launch_type/region, tos_bucket=Auto, runtime_role_name, and the MODEL_AGENT_ name/base/key env vars are required; language/version, runtime_name, apikey name, auth type, MODEL_AGENT_PROVIDER and OTEL_SDK_DISABLED are optional/defaulted. zh + en.
Per maintainer: MODEL_AGENT_* don't need to go in --runtime_envs (they are read from the .env bundled into the image), and --runtime_role_name is auto-selected. Show the minimal config command and move both to Optional; the required set is agent_name/entry_point/language(+version)/launch_type/region/tos_bucket=Auto/ runtime_name/runtime_apikey_name + OTEL_SDK_DISABLED. zh + en.
zakahan
approved these changes
Jun 15, 2026
zakahan
approved these changes
Jun 15, 2026
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
2 participants
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.
Follow-up to the
codex_runtime_on_agentkitexample. Users deploying via the README hit the interactiveagentkit configwizard and can pick the wrong options — most painfully the TOS bucket, which fails the build with aListBucketsownership error unless set toAuto.The "3. Deploy to AgentKit" step now gives:
agentkit configcommand (fill 3<...>placeholders) → thenlaunch/status/invoke.cloudAuto(avoids theListBucketsownership failure)custom_jwt)AutoMODEL_AGENT_*set (required — the codex runtime needsMODEL_AGENT_API_BASE+MODEL_AGENT_API_KEY)Both
README.mdandREADME.zh.md; markdownlint clean. These are the exact values used to deploy + verify the example end-to-end.