You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-21Lines changed: 28 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,6 +50,23 @@ Before you begin, ensure you have the following:
50
50
51
51
## Getting Started
52
52
53
+
### Configuration
54
+
55
+
Please keep these env vars handy during the installation process:
56
+
57
+
-`CLOUD_SQL_POSTGRES_PROJECT`: The GCP project ID.
58
+
-`CLOUD_SQL_POSTGRES_REGION`: The region of your Cloud SQL instance.
59
+
-`CLOUD_SQL_POSTGRES_INSTANCE`: The ID of your Cloud SQL instance.
60
+
-`CLOUD_SQL_POSTGRES_DATABASE`: The name of the database to connect to.
61
+
-`CLOUD_SQL_POSTGRES_USER`: (Optional) The database username. Defaults to the active IAM user.
62
+
-`CLOUD_SQL_POSTGRES_PASSWORD`: (Optional) The password for the database user.
63
+
-`CLOUD_SQL_POSTGRES_IP_TYPE`: (Optional) Type of the IP address: `PUBLIC`, `PRIVATE`, or `PSC`. Defaults to `PUBLIC`.
64
+
65
+
> [!NOTE]
66
+
>
67
+
> - Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
68
+
> - If your Cloud SQL for PostgreSQL instance uses private IPs, you must run your agent in the same Virtual Private Cloud (VPC) network.
69
+
53
70
### Installation & Usage
54
71
55
72
To start interacting with your database, install the skills for your preferred AI agent, then launch the agent and use natural language to ask questions or perform tasks.
@@ -62,6 +79,8 @@ To start interacting with your database, install the skills for your preferred A
0 commit comments