mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-06 21:24:58 -05:00
293c1d6889
This PR introduces a significant update to the Toolbox configuration file format, which is one of the primary **breaking changes** required for the implementation of the Advanced Control Plane. # Summary of Changes The configuration schema has been updated to enforce resource isolation and facilitate atomic, incremental updates. * Resource Isolation: Resource definitions are now separated into individual blocks, using a distinct structure for each resource type (Source, Tool, Toolset, etc.). This improves readability, management, and auditing of configuration files. * Field Name Modification: Internal field names have been modified to align with declarative methodologies. Specifically, the configuration now separates kind (general resource type, e.g., Source) from type (specific implementation, e.g., Postgres). # User Impact Existing tools.yaml configuration files are now in an outdated format. Users must eventually update their files to the new YAML format. # Mitigation & Compatibility Backward compatibility is maintained during this transition to ensure no immediate user action is required for existing files. * Immediate Backward Compatibility: The source code includes a pre-processing layer that automatically detects outdated configuration files (v1 format) and converts them to the new v2 format under the hood. * [COMING SOON] Migration Support: The new toolbox migrate subcommand will be introduced to allow users to automatically convert their old configuration files to the latest format. # Example Example for config file v2: ``` kind: sources name: my-pg-instance type: cloud-sql-postgres project: my-project region: my-region instance: my-instance database: my_db user: my_user password: my_pass --- kind: authServices name: my-google-auth type: google clientId: testing-id --- kind: tools name: example_tool type: postgres-sql source: my-pg-instance description: some description statement: SELECT * FROM SQL_STATEMENT; parameters: - name: country type: string description: some description --- kind: tools name: example_tool_2 type: postgres-sql source: my-pg-instance description: returning the number one statement: SELECT 1; --- kind: toolsets name: example_toolset tools: - example_tool ``` --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com>
44 lines
1.9 KiB
Markdown
44 lines
1.9 KiB
Markdown
---
|
|
title: Cloud SQL Admin
|
|
type: docs
|
|
weight: 1
|
|
description: "A \"cloud-sql-admin\" source provides a client for the Cloud SQL Admin API.\n"
|
|
aliases: [/resources/sources/cloud-sql-admin]
|
|
---
|
|
|
|
## About
|
|
|
|
The `cloud-sql-admin` source provides a client to interact with the [Google
|
|
Cloud SQL Admin API](https://cloud.google.com/sql/docs/mysql/admin-api). This
|
|
allows tools to perform administrative tasks on Cloud SQL instances, such as
|
|
creating users and databases.
|
|
|
|
Authentication can be handled in two ways:
|
|
|
|
1. **Application Default Credentials (ADC):** By default, the source uses ADC
|
|
to authenticate with the API.
|
|
2. **Client-side OAuth:** If `useClientOAuth` is set to `true`, the source will
|
|
expect an OAuth 2.0 access token to be provided by the client (e.g., a web
|
|
browser) for each request.
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
kind: sources
|
|
name: my-cloud-sql-admin
|
|
type: cloud-sql-admin
|
|
---
|
|
kind: sources
|
|
name: my-oauth-cloud-sql-admin
|
|
type: cloud-sql-admin
|
|
useClientOAuth: true
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
| -------------- | :------: | :----------: | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| type | string | true | Must be "cloud-sql-admin". |
|
|
| defaultProject | string | false | The Google Cloud project ID to use for Cloud SQL infrastructure tools. |
|
|
| useClientOAuth | boolean | false | If true, the source will use client-side OAuth for authorization. Otherwise, it will use Application Default Credentials. Defaults to `false`. |
|