genai-toolbox/docs/en/resources/sources/redis.md at e8598fb53ff0b7464a0ab5a08e6fdffc887e38ca

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-04-09 03:02:26 -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.8 KiB

Raw Blame History

title, linkTitle, type, weight, description

title	linkTitle	type	weight	description
Redis	Redis	docs	1	Redis is a in-memory data structure store.

About

Redis is a in-memory data structure store, used as a database, cache, and message broker. It supports data structures such as strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs, and geospatial indexes with radius queries.

If you are new to Redis, you can find installation and getting started guides on the official Redis website.

Available Tools

redis
Run Redis commands and interact with key-value pairs.

Requirements

Redis

AUTH string is a password for connection to Redis. If you have the requirepass directive set in your Redis configuration, incoming client connections must authenticate in order to connect.

Specify your AUTH string in the password field:

kind: sources
name: my-redis-instance
type: redis
address:
  - 127.0.0.1:6379
username: ${MY_USER_NAME}
password: ${MY_AUTH_STRING} # Omit this field if you don't have a password.
# database: 0
# clusterEnabled: false
# useGCPIAM: false

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

Memorystore For Redis

Memorystore standalone instances support authentication using an AUTH string.

Here is an example tools.yaml config with AUTH enabled:

kind: sources
name: my-redis-cluster-instance
type: memorystore-redis
address:
  - 127.0.0.1:6379
password: ${MY_AUTH_STRING}
# useGCPIAM: false
# clusterEnabled: false

Memorystore Redis Cluster supports IAM authentication instead. Grant your account the required IAM role and make sure to set useGCPIAM to true.

Here is an example tools.yaml config for Memorystore Redis Cluster instances using IAM authentication:

kind: sources
name: my-redis-cluster-instance
type: memorystore-redis
address:
  - 127.0.0.1:6379
useGCPIAM: true
clusterEnabled: true

Reference

field	type	required	description
type	string	true	Must be "memorystore-redis".
address	string	true	Primary endpoint for the Memorystore Redis 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 Redis, leave this field blank
password	string	false	If you have Redis AUTH enabled, specify the AUTH string here
database	int	false	The Redis database to connect to. Not applicable for cluster enabled instances. The default database is `0`.
clusterEnabled	bool	false	Set it to `true` if using a Redis Cluster instance. Defaults to `false`.
useGCPIAM	string	false	Set it to `true` if you are using GCP's IAM authentication. Defaults to `false`.

3.8 KiB Raw Blame History