genai-toolbox/docs/en/resources/tools/alloydb/alloydb-create-instance.md at e8598fb53ff0b7464a0ab5a08e6fdffc887e38ca

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-05-02 03:00:36 -04:00

Files

Yuan Teoh 293c1d6889 feat!: update configuration file v2 (#2369 )

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>

2026-01-27 16:58:43 -08:00

3.0 KiB

Raw Blame History

title, type, weight, description, aliases

title

type

weight

description

aliases

alloydb-create-instance

docs

The "alloydb-create-instance" tool creates a new AlloyDB instance within a specified cluster.

/resources/tools/alloydb-create-instance

About

The alloydb-create-instance tool creates a new AlloyDB instance (PRIMARY or READ_POOL) within a specified cluster. It is compatible with alloydb-admin source. This tool provisions a new instance with a public IP address.

Permissions & APIs Required: Before using, ensure the following on your GCP project:

The AlloyDB API is enabled.
The user or service account executing the tool has one of the following IAM roles:
- roles/alloydb.admin (the AlloyDB Admin predefined IAM role)
- roles/owner (the Owner basic IAM role)
- roles/editor (the Editor basic IAM role)

The tool takes the following input parameters:

Parameter	Type	Description	Required
`project`	string	The GCP project ID where the cluster exists.	Yes
`location`	string	The GCP location where the cluster exists (e.g., `us-central1`).	Yes
`cluster`	string	The ID of the existing cluster to add this instance to.	Yes
`instance`	string	A unique identifier for the new AlloyDB instance.	Yes
`instanceType`	string	The type of instance. Valid values are: `PRIMARY` and `READ_POOL`. Default: `PRIMARY`	No
`displayName`	string	An optional, user-friendly name for the instance.	No
`nodeCount`	int	The number of nodes for a read pool. Required only if `instanceType` is `READ_POOL`. Default: `1`	No

Note The tool sets the password.enforce_complexity database flag to on, requiring new database passwords to meet complexity rules.

Example

kind: tools
name: create_instance
type: alloydb-create-instance
source: alloydb-admin-source
description: Use this tool to create a new AlloyDB instance within a specified cluster.

Reference

field	type	required	description
type	string	true	Must be alloydb-create-instance.
source	string	true	The name of an `alloydb-admin` source.
description	string	false	Description of the tool that is passed to the agent.

3.0 KiB Raw Blame History

About

Example

Reference

3.0 KiB

Raw Blame History