mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-05 12:45:11 -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>
41 lines
2.0 KiB
Markdown
41 lines
2.0 KiB
Markdown
---
|
|
title: postgres-upgrade-precheck
|
|
type: docs
|
|
weight: 11
|
|
description: Perform a pre-check for a Cloud SQL for PostgreSQL major version upgrade.
|
|
---
|
|
|
|
The `postgres-upgrade-precheck` tool initiates a pre-check on a Cloud SQL for PostgreSQL
|
|
instance to assess its readiness for a major version upgrade using the Cloud SQL Admin API.
|
|
It helps identify potential incompatibilities or issues before starting the actual upgrade process.
|
|
|
|
{{< notice info >}}
|
|
This tool uses a `source` of type `cloud-sql-admin`.
|
|
{{< /notice >}}
|
|
|
|
## Tool Inputs
|
|
|
|
### Example
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: postgres-upgrade-precheck
|
|
type: postgres-upgrade-precheck
|
|
source: cloud-sql-admin-source
|
|
description: "Checks if a Cloud SQL PostgreSQL instance is ready for a major version upgrade to the specified target version."
|
|
```
|
|
|
|
### Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
| ------------ | :------: | :----------: | --------------------------------------------------------- |
|
|
| type | string | true | Must be "postgres-upgrade-precheck". |
|
|
| source | string | true | The name of the `cloud-sql-admin` source to use. |
|
|
| description | string | false | A description of the tool. |
|
|
|
|
| **parameter** | **type** | **required** | **description** |
|
|
| ----------------------- | :------: | :----------: | ------------------------------------------------------------------------------- |
|
|
| project | string | true | The project ID containing the instance. |
|
|
| instance | string | true | The name of the Cloud SQL instance to check. |
|
|
| targetDatabaseVersion | string | false | The target PostgreSQL major version for the upgrade (e.g., `POSTGRES_18`). If not specified, defaults to the PostgreSQL 18. |
|