Skip to content
This repository has been archived by the owner on Jun 3, 2024. It is now read-only.

Commit

Permalink
Update README with Example (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
llam15 authored Dec 12, 2023
1 parent b470d22 commit 1b411bf
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,23 @@ must be configured with credentials that have the permissions to:
- Create Workload Identity Pools and Providers
- Create and manage Service Accounts

## Example Usage
```terraform
module "gcp_connector" {
source = "symopsio/gcp-connector/google"
version = "~> 1.0"
environment = "production"
identity_pool_project_id = "my-project-id"
gcp_org_id = "123456789"
enable_google_group_management = true
}
```

## Caveats
### Google Group Management
If using this module to set up the infrastructure to allow Sym to manage Google Group management, you must additionally
If using this module to set up the infrastructure to allow Sym to manage Google Group membership, you must additionally
grant the Sym Service Account some permissions in your Google Workspace account.

To do so, you must create a custom Admin Role in the [Google Workspaces Admin Console](https://admin.google.com/ac/roles)
Expand Down

0 comments on commit 1b411bf

Please sign in to comment.