Skip to content

Commit

Permalink
docs: add steps for testing the connector (#616)
Browse files Browse the repository at this point in the history
  • Loading branch information
nancynh authored Sep 11, 2024
1 parent 6f2556a commit abdb9f8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
12 changes: 8 additions & 4 deletions .envrc.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
export ALLOYDB_URI=projects/<PROJECT-ID>/locations/<REGION>/clusters/<CLUSTER>/instances/<INSTANCE>
export ALLOYDB_USER=some-user
export ALLOYDB_PASS=some-password
export ALLOYDB_DB=some-db-name
export ALLOYDB_DB="some-db"
export ALLOYDB_USER="some-user"
export ALLOYDB_PASS="some-password"
export ALLOYDB_INSTANCE_NAME="projects/<PROJECT>/locations/<REGION>/clusters/<CLUSTER>/instances/<INSTANCE>"
export ALLOYDB_INSTANCE_IP="some-IP-address"
export ALLOYDB_IAM_USER="[email protected]"
export ALLOYDB_IMPERSONATED_USER="some-impersonated-IAM-user"
export ALLOYDB_PSC_INSTANCE_URI="projects/<PROJECT>/locations/<REGION>/clusters/<CLUSTER>/instances/<INSTANCE>"
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,10 @@ information on using pull requests.

This project follows [Google's Open Source Community
Guidelines](https://opensource.google/conduct/).

## Testing

NOTE: Be sure to run the following commands in the same VPC as the AlloyDB instance

1. Set the environment variables. You can see an example of the environment variables needed by running `cat .envrc.example`
1. Run the tests by using: `go test`

0 comments on commit abdb9f8

Please sign in to comment.