github/genai-toolbox
1
0
Fork 0
mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-02-11 23:55:07 -05:00
Code Issues Packages Projects Releases 14 Wiki Activity

feat!: replace Source field ip_type with ipType for consistency (#197)

Browse Source 
Replace `ip_type` with `ipType` to match the camel-case of the other
fields.
Update docs since we support both private and public IP connections.
This commit is contained in:
Wenxin Du
2025-01-14 10:56:06 +08:00
committed by GitHub
parent 1fcc20a846
commit e069520bb7
7 changed files with 41 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/sources/alloydb-pg.md
View File

@@ -32,15 +32,16 @@ IAM identity has been given the following IAM permissions:
### Network Path
Currently, this source only supports [connecting over Private
IP][private-ip]. Most notably, this means
you need to connect from a VPC that AlloyDB has been connected to.
Currently, AlloyDB supports connection over both [private IP][private-ip] and
[public IP][public-ip]. Set the `ipType` parameter in your source
configuration to `public` or `private`.
[private-ip]: https://cloud.google.com/alloydb/docs/private-ip
[public-ip]: https://cloud.google.com/alloydb/docs/connect-public-ip
### Database User
Current, this source only uses standard authentication. You will need to [create a
Currently, this source only uses standard authentication. You will need to [create a
PostreSQL user][alloydb-users] to login to the database with.
[alloydb-users]: https://cloud.google.com/alloydb/docs/database-users/about
@@ -69,9 +70,7 @@ sources:
| 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`. |
| ipType | 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"). |

11
docs/sources/cloud-sql-pg.md
View File

@@ -30,16 +30,17 @@ IAM identity has been given the following IAM roles:
### Network Path
Currently, this source only supports [connecting over Public IP][public-ip].
Because it uses the Go connector, is uses rotating client certificates to
establish a secure mTLS connection with the instance.
Currently, Cloud SQL supports connection over both [private IP][private-ip] and
[public IP][public-ip]. Set the `ipType` parameter in your source
configuration to `public` or `private`.
[private-ip]: https://cloud.google.com/sql/docs/postgres/configure-private-ip
[public-ip]: https://cloud.google.com/sql/docs/postgres/configure-ip
### Database User
Current, this source only uses standard authentication. You will need to [create a
PostreSQL user][cloud-sql-users] to login to the database with.
PostreSQL user][cloud-sql-users] to login to the database with.
[cloud-sql-users]: https://cloud.google.com/sql/docs/postgres/create-manage-users
@@ -65,7 +66,7 @@ sources:
| project | string | true | Id of the GCP project that the cluster was created in (e.g. "my-project-id"). |
| 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`. |
| ipType | 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"). |