mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-05-02 03:00:36 -04: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.4 KiB

Raw Blame History

AlloyDB for PostgreSQL Source

AlloyDB for PostgreSQL is a fully-managed, PostgreSQL-compatible database for demanding transactional workloads. It provides enterprise-grade performance and availability while maintaining 100% compatibility with open-source PostgreSQL.

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

Requirements

IAM Identity

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

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

roles/alloydb.client
roles/serviceusage.serviceUsageConsumer

Network Path

Currently, this source only supports connecting over Private IP. Most notably, this means you need to connect from a VPC that AlloyDB has been connected to.

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-alloydb-pg-source:
        kind: "alloydb-postgres"
        project: "my-project-name"
        region: "us-central1"
        cluster: "my-cluster"
        instance: "my-instance"
        database: "my_db"
        user: "my-user"
        password: "my-password"

Reference

field	type	required	description
kind	string	true	Must be "alloydb-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").
cluster	string	true	Name of the AlloyDB cluster (e.g. "my-cluster").
instance	string	true	Name of the AlloyDB instance within the cluser (e.g. "my-instance").
ip_type	string	true	IP Type of the AlloyDB 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.4 KiB Raw Blame History