* Add allow_origins flag to cloud run page per issue #1113 - 1
Rendered page:
Agent's PR: #1118
Original Issue: #1113
--
This PR updates the deployment documentation to include --allow_origins flag (with regex support).
While the original draft suggested updating multiple pages, a review of the live site confirmed that this feature is already documented in the main CLI reference for the api_server and web commands.
Additional format changes:
- Fixed Markdown rendering bugs: Repaired broken code blocks in the Environment variables and Cloud Build permissions sections, fixed the misplaced Secret command, and corrected the malformed numbered list under Prerequisites.
- Style changes.
* Update cloud-run.md
* Update cloud-run.md
The site rendered one language under two names. Tab labels were split
137 `TypeScript` / 53 `Typescript`, with three pages carrying both
spellings at once (custom-agents.md 7/7, patterns.md 1/7,
function-tools.md 4/1), and the language-support badges were split 67/18
the same way. Because pymdownx.tabbed slugifies tab labels to lowercase,
both variants rendered and linked fine, so no link check or build warning
ever flagged it -- it was visible only to readers, as two names for one
SDK.
Every user-visible occurrence is normalized to `TypeScript`, plus the two
inconsistencies that turned up while doing it. 80 changed lines, accounted
for exactly:
53 tab label === "Typescript" -> === "TypeScript"
18 badge span lst-typescript">Typescript -> TypeScript
3 prose mention cloud-run.md, mcp-tools.md, workflows/patterns.md
2 api-reference/index.md card heading and link text
1 badge div attr title="...Python and Typescript."
1 mkdocs.yml nav Typescript ADK -> TypeScript ADK
1 code fence ```javascript -> ```typescript on a .ts include
1 artifacts/index.md closing summary sentence
---
80
The first six rows are pure casing: 78 lines that differ from their
originals by nothing but `Typescript` -> `TypeScript`. The last two are
not, and are the reason this is not a `sed`:
llm-agents.md:872 fenced `--8<-- ".../capital_agent.ts"` as ```javascript.
It was the only javascript-fenced `.ts` include in docs/ (the other 189
TypeScript fences are correct), and it cost that one snippet its
TypeScript highlighting.
artifacts/index.md:1084 closed the page by naming languages and got the
list wrong. It described reaching the artifact methods "using Python's
context objects or directly interacting with the `BaseArtifactService` in
Java" -- a two-language enumeration at the end of a page that carries
Python, TypeScript, Go, Java and Kotlin tabs (11/10/10/10/11), and one
that contradicts :556, which correctly names four of them. The
enumeration is dropped rather than extended: the sentence now describes
the two ways to reach these methods -- through the context object, or
through `BaseArtifactService` -- which is what the page actually teaches
and does not rot when a sixth language is added.
docs/api-reference/index.md is included even though the rest of
docs/api-reference/ is generated output that must not be touched. That
tree holds 3,140 generated HTML files and exactly one hand-authored page:
this one. It is Markdown, it is the only api-reference entry mkdocs.yml
lists as `.md` rather than `index.html` (:272, :441), it uses Material
`grid cards` and `:fontawesome-*:` shortcodes, and it carries a
`CONTRIBUTORS:` note citing issues #1716 and #1717. Its TypeScript card
already said "TypeScript" twice in its body text while its heading and
link text said "Typescript"; those two are now consistent with the body.
No generated file is modified.
Not in this change: the broken `SseConnectionParams` sample in
mcp-tools.md (docs-ts/p6c-mcp-ts-sample) and the `@google/adk` example
version bumps (docs-ts/p6b-example-versions). Only the casing of the
prose line above that sample is touched here.
Verified: `mkdocs build` exits 0 with an empty warning set on both main
and this branch, and the two warning sets are identical. A rendered
before/after diff of the whole site shows every `__tabbed_*` id, every
tab radio id and every heading anchor unchanged. Zero `=== "Typescript"`
and zero `lst-typescript">Typescript` remain anywhere in the repo.
Co-authored-by: Amaad Martin <amaadmartin@google.com>
* docs: update ADK Go imports to v2 for core concepts and tutorials
* docs: update ADK Go imports and APIs to v2 for runtime and safety
* docs: update ADK Go imports to v2 for features (workflows, tools, skills, sessions, plugins)
* docs: update ADK Go imports to v2 for operations and integrations
---------
Co-authored-by: Kristopher Overholt <koverholt@google.com>
* docs: update GOOGLE_GENAI_USE_VERTEXAI to GOOGLE_GENAI_USE_ENTERPRISE in configs and models
* docs: update GOOGLE_GENAI_USE_VERTEXAI in deployment and setup guides
* docs: update GOOGLE_GENAI_USE_VERTEXAI and Client parameter in integrations and streaming docs
* docs: update GOOGLE_GENAI_USE_VERTEXAI in tutorials and examples
---------
Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
* wip: temporary staging
* Consolidate Google Cloud and Agent Platform connection info
* remove gcp-mentions file
* adding links to central GCP connection page
* minor updates
* responded to review comments
* docs(gke): add Workload Identity IAM binding for adk deploy gke
The automated deployment path (`adk deploy gke`) generates a manifest
that uses the `default` Kubernetes service account in the `default`
namespace, but the docs only documented the Workload Identity IAM
binding for the manual path (which uses a custom `adk-agent-sa`).
Without binding `roles/aiplatform.user` to the `default` service
account, agent pods start but model requests fail with
`403 PERMISSION_DENIED`.
Add a "Configure Workload Identity for Agent Platform" step under
Option 2 with the correct binding for the `default` service account,
and cross-reference it from the 403 troubleshooting entry.
Fixes#1254
* Update gke.md
---------
Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
* docs: update Cloud Run deployment guide for compute service account to have permission to use Cloud Build.
* Update cloud-run.md
---------
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
* fix: correct agents-cli skill names and deployment targets in Coding with AI tutorial
- Fix skill names to match actual agents-cli implementation:
- google-agents-cli-adk-deploy → google-agents-cli-deploy
- google-agents-cli-adk-dev → google-agents-cli-workflow
- google-agents-cli-adk-eval → google-agents-cli-eval
- google-agents-cli-adk-observe → google-agents-cli-observability
- google-agents-cli-adk-scaffold → google-agents-cli-scaffold
- Add missing google-agents-cli-publish skill
- Add GKE as deployment target (was missing from deploy command description)
- Fix publish destination: 'Agent Store' → 'Gemini Enterprise'
- Reorder skills to match canonical order from agents-cli
* docs: use full branding 'Agents CLI in Agent Platform' in intro paragraphs
Use the full product name 'Agents CLI in Agent Platform' in introductory
paragraphs and first mentions, then shorten to 'Agents CLI' in subsequent
prose references. Command names and code blocks remain as 'agents-cli'.
Changes:
- coding-with-ai.md: First mention uses full branding
- agents-cli.md: Title and intro paragraph use full branding
- index.md: Deployment path description uses full branding
- All subsequent prose references use 'Agents CLI' instead of 'agents-cli'
- Command references and code blocks unchanged (still 'agents-cli')
* Rename asp.md to agents-cli.md and update redirects
- Renamed docs/deploy/agent-runtime/asp.md to agents-cli.md
- Updated navigation reference in mkdocs.yml
- Added redirect rule: agent-runtime/asp.md → agents-cli.md
- Updated existing redirect: agent-engine/asp.md → agents-cli.md
The 'asp' name no longer makes sense as a page name now that we're
referencing Agent Starter Pack / agents-cli directly.
Note: This applies on top of PR #1673 which renamed:
- 'agent-engine' directory → 'agent-runtime'
- 'Agent Engine' product → 'Agent Runtime'
* Complete migration from Agent Starter Pack to agents-cli
This commit completes the migration from "Agent Starter Pack (ASP)"
terminology to "agents-cli" across documentation and updates references
to align with the new Agent Platform tooling.
Changes:
- Updated docs/deploy/agent-runtime/agents-cli.md: Replaced all "Agent
Starter Pack" and "ASP" references with "agents-cli", updated commands
from 'uvx agent-starter-pack enhance --adk -d agent_engine' to
'agents-cli scaffold enhance --deployment-target agent_engine', and
updated all documentation links to point to google.github.io/agents-cli/
- Updated docs/tutorials/coding-with-ai.md: Replaced "ADK Dev Skills"
section with "agents-cli" section, changed installation from
'npx skills add google/adk-docs/skills -y -g' to
'uvx google-agents-cli setup', updated skill names table to new
agents-cli skill names, and added CLI commands table
- Updated docs/deploy/agent-runtime/index.md: Changed "Agent Starter Pack
deployment" to "agents-cli deployment" and updated reference from
"The Agent Starter Pack (ASP)" to "agents-cli in Agent Platform"
- Deleted docs/skills/ directory: Skills have been migrated to the
agents-cli repository
* Fix agents-cli deployment instructions to use correct CLI commands
Replace incorrect make command references with agents-cli deploy and agents-cli infra single-project. Update deployment workflow to reflect actual agents-cli usage.
* Update navigation to use agents-cli instead of Agent Starter Pack
Replace "Agent Starter Pack" with "agents-cli" in the navigation menu. Redirects from old ASP URLs are already in place.
* Restore docs/skills/index.md - Agent Skills documentation
This file documents the Agent Skills feature (agentskills.io specification),
not ADK Dev Skills. It was mistakenly deleted in the ASP → agents-cli migration.
Agent Skills are a general ADK feature where agents can use modular,
self-contained units of functionality based on the Agent Skill specification.
* Fix terminology: Agent Engine runtime → Agent Runtime runtime
Update deployment path description to use consistent "Agent Runtime runtime"
terminology instead of "Agent Engine runtime".
* Fix broken agents-cli documentation links
Replace broken links to /guide/ (which 404s) with correct links to main
documentation page. The /guide/ URL is a directory listing that doesn't
exist in the agents-cli docs structure.
Changes:
- Line 31: "Development guide" link → "Guide" pointing to main docs
- Line 221: "Development guide" link → "agents-cli documentation" pointing to main docs
Both now correctly point to https://google.github.io/agents-cli/
* Delete ADK Dev Skills directory - migrated to agents-cli
Remove the entire skills/ directory containing ADK Dev Skills. These
skills have been migrated to the agents-cli repository and are now
distributed as part of the agents-cli package.
Users should now install skills via:
uvx google-agents-cli setup
Instead of the old method:
npx skills add google/adk-docs/skills -y -g
Deleted skills (now available in agents-cli):
- adk-dev-guide → google-agents-cli-workflow
- adk-cheatsheet → google-agents-cli-adk-code
- adk-eval-guide → google-agents-cli-eval
- adk-deploy-guide → google-agents-cli-deploy
- adk-observability-guide → google-agents-cli-observability
- adk-scaffold → google-agents-cli-scaffold
Total: 19 files removed across 6 skill directories
* Remove skills CI checks
---------
Co-authored-by: Kristopher Overholt <koverholt@google.com>
* docs: home page
* updates based on feedback
* respond to review feedback
* docs: update gemini selector strings to "flash-latest"
* Update homepage.css
* Replace google.github.io/adk-docs URLs and /adk-docs/ paths with adk.dev
Migrate all hardcoded documentation references to use the new custom
domain. Update root-relative links to remove the /adk-docs/ subpath
prefix since the site will be served from the root of adk.dev.
* Additional fixes
* doc: A2A support in ADK Java
* doc: fix spelling for the Agent2Agent protocol name
* doc: addressing Kris' comments on the A2A Java documentation
* docs: update ADK Java to version 1.0.0
* Updated ASP description and recommendation
* Updated ASP description and recommendation
* Use present tense as instructed
---------
Co-authored-by: Pedro Melendez <pemelend@google.com>
* doc: Reference version 0.5.0 of ADK for Java
* doc: Update references of version 0.6.0 of ADK for Java instead of older versions
---------
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
* add: change the sqlite url to be async
* add: explanation of why the use of this
---------
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
* docs: Add Go language quickstart
* updates based on review comments
* fix tab stops
* update based on review comments
* sync with main
* update to tested version
* Added google_search snippet
* Fix: Address Go style guide issues in google_search.go
* Migrated to new API
* Fixed tool info in md file
* Added partial check
* Added function-tools sample
* Migrated to new API
* Added partial check
* Ran linter
* feat: add go fmt check
* Run go fmt only on changed files
* Added google_search snippet
* Fix: Address Go style guide issues in google_search.go
* Migrated to new API
* Added partial check
* Added function-tools sample
* Migrated to new API
* Added partial check
* Ran linter
* feat: add go fmt check
* Run go fmt only on changed files
* Feat: Add Golang example for LLM agents
* Added schema agent
* Added session support
* Migrated to new API
* Added back OutputKey
* Added missing snippets
* Moved snipped to its own package
* Minor cleanup
* Reverted llm-agents.md
* Added back correct changes to llm-agents.md
* Updated to newest API
* Ran linter
* WIP
* WIP: Added the rest of the agents
* Added sequential agent
* Migrated agents to new API
* Fixed snippet tags
* Updated parallel and sequential with OutputKey
* Updated loop agent
* Cleanup
* Fixed and ran linter
* Removed comment
* Ran linter
* Added custom agent snippets
* Migrated to new API
* Fixed incorrect info about channels since run returns an Iterator, not Channel
* Cleanup and renaming
* Ran linter
* Fixed md
* Added multi-agent docs
* Updated to use AgentTool
* Split snippets
* Added missing file
* Ran linter and fixed API
* Added Models snippets
* Migrated to new API
* Embedded imports
* Ran linter
* Added long running tool
* Ran linter and fixed API
* Switched to two-turn style
* Ran linter
* Added callback snippets
* Added back imports
* Added types of callbacks snippets
* feat(go): align callback snippets with other languages
* Ran linter and updated API
* Added tool callbacks
* Added artifact snippets
* Use story.pdf instead of random bytes
* Fixed issue with artifact loading
* Cleanup unneeded fixes
* Added back inadvertently removed GCS section
* Addressed PR comments
* Ran linter
* feat: Added context snippets
* Fixed callback signature
* Fixed additional callbacks
* Added remaining snippets
* Added conceptual runner example
* Removed duplicate code
* Clean up tags and imports
* Updated API
* Twaked text
* Ran linter
* Fixed broken API issues
* Updated to latest Go ADK API
* Added func param info
* Interleaved Py and Go
* Revert mistakes
* Removed extra newline
* Added example cloud run code and update md with Go (#41)
* Added example cloud run code and update md with Go
* Added a2a_agent_url and fixed future tense
* Moved Go before Java
---------
Co-authored-by: ivanmkc <ivanmkc@google.com>
* adding go snippets to runconfig docs
* realigning runconfig go examples with current state of adk-go.
* adding language support tags to individual runtime config fields
* removing unsupported supportcfc go examples
* removing unsupported streamingmode.bidi go snippets
* Added AgentTool examples (#31)
* Added AgentTool example
* Ran formatter
---------
Co-authored-by: ivanmkc <ivanmkc@google.com>
* adding initial go sessions.sessions snippets
* updating go session docs + session examples
* update go session snippets
* updating DatabaseSessionService language support tag
* cleaning up go vertex ai comments
* removing go.mod for session_management_example
* docs: add language support tags for Go
* initial go runtime sample updates
* fixing runtime go snippet formatting
* formatting updates to runtime go snippets
* updating runtime go examples to streamline to newer go features
* adding go snippets for events
* updating go snippets for events
* adding artifactdelta snippet for go
* minor java fixes, cleaning up go event.content
* Custom tools: Merging again (#44)
* Added missing custom-tools snippets
* Split user_preference runner code
* Split more files
* Tweaks
* Split session into 1 and 2 and added artifact saving
* Fixed conflict
---------
Co-authored-by: ivanmkc <ivanmkc@google.com>
* Fixed tab issue with cloud-run md (#45)
Co-authored-by: ivanmkc <ivanmkc@google.com>
* adding initial go snippets for memory services
* updating go memory sample, adding python formatting in docs to clarify current support.
* removing go replace for memory example
* removing go.sum from memory_example
* fixing go formatting for memory example
* fixing go memory snippets to streamline examples in docs
* removing unnecessary go.mod for memory_example.go and snippet cleanup
* adding go session state snippets."
* adding additional go state examples for state injection
* fixing go formatting
* fixing language ordering on session/state.md; removing unnecessary go.mod files
* reworking error functions in go session state samples
* fixing go formatting on session state samples
* initial go snippets for safety tools
* fixing go snippet formatting in safety/index.md
* temp storing safety example
* cleaning up go snippets in safety docs; deferring safety go full example
* cleaning up go safety snippets
* Added link to Go API docs (#47)
Co-authored-by: ivanmkc <ivanmkc@google.com>
* Added a2a_basic sample (#46)
* Added a2a_basic sample
* Removed dummy LLMs
* Added md
Fix inaccuracies in md
Ran formatter
* Cleaned up index
---------
Co-authored-by: ivanmkc <ivanmkc@google.com>
* Reverted to proper ToC and added missing links (#48)
Co-authored-by: ivanmkc <ivanmkc@google.com>
* Added missing get-started/go.md (#50)
Co-authored-by: ivanmkc <ivanmkc@google.com>
* Added missing JSON tags for Go structs (#51)
* Added json tags
* Added jsonschema and json tags
---------
Co-authored-by: ivanmkc <ivanmkc@google.com>
* Renamed Golang to Go (#52)
Co-authored-by: ivanmkc <ivanmkc@google.com>
---------
Co-authored-by: Joe Fernandez <joefernandez@google.com>
Co-authored-by: ivanmkc <ivanmkc@google.com>
Co-authored-by: Toni Klopfenstein <tklopfenstein@google.com>
* docs: add language support tags to pages
- replace img.shield tags
- add language support tags where missing
* update Agents page with general tags
* update language and version tagging
- response to review comments
- rename css styles to avoid style name conflicts
* add tags to api-server page
Updated the link to the deployment instructions and added details about where to find example code.
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
Zyan