mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-01-29 09:18:12 -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>
51 lines
2.8 KiB
Markdown
51 lines
2.8 KiB
Markdown
---
|
|
title: cloud-sql-mysql-create-instance
|
|
type: docs
|
|
weight: 2
|
|
description: "Create a Cloud SQL for MySQL instance."
|
|
---
|
|
|
|
The `cloud-sql-mysql-create-instance` tool creates a new Cloud SQL for MySQL
|
|
instance in a specified Google Cloud project.
|
|
|
|
{{< notice info >}}
|
|
This tool uses the `cloud-sql-admin` source.
|
|
{{< /notice >}}
|
|
|
|
## Configuration
|
|
|
|
Here is an example of how to configure the `cloud-sql-mysql-create-instance`
|
|
tool in your `tools.yaml` file:
|
|
|
|
```yaml
|
|
kind: sources
|
|
name: my-cloud-sql-admin-source
|
|
type: cloud-sql-admin
|
|
---
|
|
kind: tools
|
|
name: create_my_mysql_instance
|
|
type: cloud-sql-mysql-create-instance
|
|
source: my-cloud-sql-admin-source
|
|
description: "Creates a MySQL instance using `Production` and `Development` presets. For the `Development` template, it chooses a 2 vCPU, 16 GiB RAM, 100 GiB SSD configuration with Non-HA/zonal availability. For the `Production` template, it chooses an 8 vCPU, 64 GiB RAM, 250 GiB SSD configuration with HA/regional availability. The Enterprise Plus edition is used in both cases. The default database version is `MYSQL_8_4`. The agent should ask the user if they want to use a different version."
|
|
```
|
|
|
|
## Parameters
|
|
|
|
The `cloud-sql-mysql-create-instance` tool has the following parameters:
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
| --------------- | :------: | :----------: | --------------------------------------------------------------------------------------------------------------- |
|
|
| project | string | true | The Google Cloud project ID. |
|
|
| name | string | true | The name of the instance to create. |
|
|
| databaseVersion | string | false | The database version for MySQL. If not specified, defaults to the latest available version (e.g., `MYSQL_8_4`). |
|
|
| rootPassword | string | true | The root password for the instance. |
|
|
| editionPreset | string | false | The edition of the instance. Can be `Production` or `Development`. Defaults to `Development`. |
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
| ----------- | :------: | :----------: | -------------------------------------------------------------- |
|
|
| type | string | true | Must be `cloud-sql-mysql-create-instance`. |
|
|
| source | string | true | The name of the `cloud-sql-admin` source to use for this tool. |
|
|
| description | string | false | A description of the tool that is passed to the agent. |
|