mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-01-30 17:58:24 -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>
68 lines
3.5 KiB
Markdown
68 lines
3.5 KiB
Markdown
---
|
|
title: cloud-sql-clone-instance
|
|
type: docs
|
|
weight: 10
|
|
description: "Clone a Cloud SQL instance."
|
|
---
|
|
|
|
The `cloud-sql-clone-instance` tool clones a Cloud SQL instance using the Cloud SQL Admin API.
|
|
|
|
{{< notice info dd>}}
|
|
This tool uses a `source` of type `cloud-sql-admin`.
|
|
{{< /notice >}}
|
|
|
|
## Examples
|
|
|
|
Basic clone (current state)
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: clone-instance-basic
|
|
type: cloud-sql-clone-instance
|
|
source: cloud-sql-admin-source
|
|
description: "Creates an exact copy of a Cloud SQL instance. Supports configuring instance zones and high-availability setup through zone preferences."
|
|
```
|
|
|
|
Point-in-time recovery (PITR) clone
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: clone-instance-pitr
|
|
type: cloud-sql-clone-instance
|
|
source: cloud-sql-admin-source
|
|
description: "Creates an exact copy of a Cloud SQL instance at a specific point in time (PITR). Supports configuring instance zones and high-availability setup through zone preferences"
|
|
```
|
|
|
|
## Reference
|
|
|
|
### Tool Configuration
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
| -------------- | :------: | :----------: | ------------------------------------------------------------- |
|
|
| type | string | true | Must be "cloud-sql-clone-instance". |
|
|
| source | string | true | The name of the `cloud-sql-admin` source to use. |
|
|
| description | string | false | A description of the tool. |
|
|
|
|
### Tool Inputs
|
|
|
|
| **parameter** | **type** | **required** | **description** |
|
|
| -------------------------- | :------: | :----------: | ------------------------------------------------------------------------------- |
|
|
| project | string | true | The project ID. |
|
|
| sourceInstanceName | string | true | The name of the source instance to clone. |
|
|
| destinationInstanceName | string | true | The name of the new (cloned) instance. |
|
|
| pointInTime | string | false | (Optional) The point in time for a PITR (Point-In-Time Recovery) clone. |
|
|
| preferredZone | string | false | (Optional) The preferred zone for the cloned instance. If not specified, defaults to the source instance's zone. |
|
|
| preferredSecondaryZone | string | false | (Optional) The preferred secondary zone for the cloned instance (for HA). |
|
|
|
|
## Usage Notes
|
|
|
|
- The tool supports both basic clone and point-in-time recovery (PITR) clone operations.
|
|
- For PITR, specify the `pointInTime` parameter in RFC3339 format (e.g., `2024-01-01T00:00:00Z`).
|
|
- The source must be a valid Cloud SQL Admin API source.
|
|
- You can optionally specify the `zone` parameter to set the zone for the cloned instance. If omitted, the zone of the source instance will be used.
|
|
- You can optionally specify the `preferredZone` and `preferredSecondaryZone` (only in REGIONAL instances) to set the preferred zones for the cloned instance. These are useful for high availability (HA) configurations. If omitted, defaults will be used based on the source instance.
|
|
|
|
## See Also
|
|
- [Cloud SQL Admin API documentation](https://cloud.google.com/sql/docs/mysql/admin-api)
|
|
- [Toolbox Cloud SQL tools documentation](../cloudsql)
|
|
- [Cloud SQL Clone API documentation](https://cloud.google.com/sql/docs/mysql/clone-instance) |