genai-toolbox/docs/en/resources/sources/valkey.md at d013badbdace895d9cbb5572b85d3fffa8917187

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-02-18 02:51:58 -05: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, linkTitle, type, weight, description

title	linkTitle	type	weight	description
Valkey	Valkey	docs	1	Valkey is an open-source, in-memory data structure store, forked from Redis.

About

Valkey is an open-source, in-memory data structure store that originated as a fork of Redis. It's designed to be used as a database, cache, and message broker, supporting a wide range of data structures like strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs, and geospatial indexes with radius queries.

If you're new to Valkey, you can find installation and getting started guides on the official Valkey website.

Available Tools

valkey
Issue Valkey (Redis-compatible) commands.

Example

kind: sources
name: my-valkey-instance
type: valkey
address:
  - 127.0.0.1:6379
username: ${YOUR_USERNAME}
password: ${YOUR_PASSWORD}
# database: 0
# useGCPIAM: false
# disableCache: false

{{< notice tip >}} Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file. {{< /notice >}}

IAM Authentication

If you are using GCP's Memorystore for Valkey, you can connect using IAM authentication. Grant your account the required IAM role and set useGCPIAM to true:

kind: sources
name: my-valkey-instance
type: valkey
address:
  - 127.0.0.1:6379
useGCPIAM: true

Reference

field	type	required	description
type	string	true	Must be "valkey".
address	[]string	true	Endpoints for the Valkey instance to connect to.
username	string	false	If you are using a non-default user, specify the user name here. If you are using Memorystore for Valkey, leave this field blank
password	string	false	Password for the Valkey instance
database	int	false	The Valkey database to connect to. Not applicable for cluster enabled instances. The default database is `0`.
useGCPIAM	bool	false	Set it to `true` if you are using GCP's IAM authentication. Defaults to `false`.
disableCache	bool	false	Set it to `true` if you want to enable client-side caching. Defaults to `false`.

3.0 KiB Raw Blame History