Clarify docs

google-github-actions · Nov 4, 2022 · 60569fa · 60569fa
1 parent 7e38fb1
commit 60569fa
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -554,6 +554,11 @@ Terraform module to automate your infrastructure provisioning. See [examples](ht
 
     ```sh
     export WORKLOAD_IDENTITY_POOL_ID="..." # value from above
+
+    # This should look like:
+    #
+    #   projects/123456789/locations/global/workloadIdentityPools/my-pool
+    #
     ```
 
 
@@ -597,6 +602,13 @@ Terraform module to automate your infrastructure provisioning. See [examples](ht
       --member="principalSet://iam.googleapis.com/${WORKLOAD_IDENTITY_POOL_ID}/attribute.repository/${REPO}"
     ```
 
+    Note that `$WORKLOAD_IDENTITY_POOL_ID` should be the **full** Workload
+    Identity Pool resource ID, like:
+
+    ```text
+    projects/123456789/locations/global/workloadIdentityPools/my-pool
+    ```
+
 1.  Extract the Workload Identity **Provider** resource name:
 
     ```sh