Skip to content

docs: add link to IAM setup guide in Prerequisites #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akaraj187 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add link to IAM setup guide in Prerequisites #83

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f2168b
docs: add link to IAM setup guide in Prerequisites
akaraj187 Jan 15, 2026
cb33d1c
docs: add info on creating IAM users and default credential behavior
akaraj187 Jan 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ Before you begin, ensure you have the following:
* IAM Permissions:
* Cloud SQL Client (`roles/cloudsql.client`)
* Cloud SQL Admin (`roles/cloudsql.admin`)
> **Note:**
> 1.For instructions on how to configure IAM authentication and add these roles, please see the official [Google Cloud IAM Authentication Guide](https://cloud.google.com/sql/docs/postgres/iam-authentication#configure-iam-authentication).
> 2. You must also add the IAM user to your Cloud SQL instance. See [Creating a database user](https://cloud.google.com/sql/docs/postgres/add-manage-iam-users#creating-a-database-user).
> 3. If you do not configure a specific `CLOUD_SQL_POSTGRES_USER` or `PASSWORD`, this extension defaults to using the active local IAM user credentials.

## Getting Started

Expand Down