mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-02-11 23:55:07 -05:00

Files

Wenxin Du 8ca7e91240 docs: Add auth source docs (#132 )

Add authsources and authenticated parameter docs. Format some other .md
docs.

---------

Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>

2024-12-17 13:49:43 -05:00

3.2 KiB

Raw Blame History

Cloud SQL for PostgreSQL Source

Cloud SQL for PostgreSQL is a fully-managed database service that helps you set up, maintain, manage, and administer your PostgreSQL relational databases on Google Cloud Platform.

If you are new to Cloud SQL for PostgreSQL, you can try creating and connecting to a database by following these instructions.

Requirements

IAM Identity

By default, this source uses the Cloud SQL Go Connector to authorize and establish mTLS connections to your Cloud SQL instance. The Go connector uses your Application Default Credentials (ADC) to authorize your connection to Cloud SQL.

In addition to setting the ADC for your server, you need to ensure the IAM identity has been given the following IAM roles:

roles/cloudsql.client

Network Path

Currently, this source only supports connecting over Public IP. Because it uses the Go connector, is uses rotating client certificates to establish a secure mTLS connection with the instance.

Database User

Current, this source only uses standard authentication. You will need to create a PostreSQL user to login to the database with.

Example

sources:
    my-cloud-sql-pg-source:
        kind: "cloud-sql-pg-postgres"
        project: "my-project"
        region: "us-central1"
        instance: "my-instance"
        database: "my_db"
        user: "my-user"
        password: "my-password"

Reference

field	type	required	description
kind	string	true	Must be "cloud-sql-postgres".
project	string	true	Name of the GCP project that the cluster was created in (e.g. "my-project").
region	string	true	Name of the GCP region that the cluster was created in (e.g. "us-central1").
instance	string	true	Name of the Cloud SQL instance within the cluser (e.g. "my-instance").
ip_type	string	true	IP Type of the Cloud SQL instance, must be either `public` or `private`. Default: `public`.
database	string	true	Name of the Postgres database to connect to (e.g. "my_db").
user	string	true	Name of the Postgres user to connect as (e.g. "my-pg-user").
password	string	true	Password of the Postgres user (e.g. "my-password").

3.2 KiB Raw Blame History