Skip to content

Commit 247044a

Browse files
committed
Add link to DfE Analytics terraform docs from setup readme
1 parent 10c5dcd commit 247044a

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/google_cloud_bigquery_setup.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -523,7 +523,7 @@ With dfe-analytics our strong preference is to use WIF where possible. Where WIF
523523

524524
The diagram below demonstrates our use of WIF within dfe-analytics connecting from an Azure client to BigQuery.
525525

526-
![[azure-gcp-wif.svg]]
526+
<img src="https://raw.githubusercontent.com/DFE-Digital/dfe-analytics/refs/heads/main/docs/azure-gcp-wif.svg">
527527

528528
The steps below outline how to setup WIF for service accounts using either gcloud shell scripts or gcloud console.
529529

@@ -555,21 +555,27 @@ For each project a workload identity pool provider with the name `azure-cip-oidc
555555

556556
If this does not exist then one can be created with either the [create gcp workload identity pool provider](https://github.com/DFE-Digital/teacher-services-analytics-cloud/blob/main/scripts/gcloud/create-gcp-workload-identity-pool-provider.sh) gcloud script or from the [IAM](https://console.cloud.google.com/iam-admin/workload-identity-pools/pool/azure-cip-identity-pool) gcloud console using the attributes specified in the gcloud script.
557557

558-
### 4. Service account
558+
### 4. Terraform automation
559+
560+
The per project setup for WIF service accounts, permissions and client credentials should be automated through terraform. See the [dfe analytics terraform documentation](https://github.com/DFE-Digital/terraform-modules/blob/main/aks/dfe_analytics/README.md) for instructions on how to do this.
561+
562+
If WIF has been setup using terraform, then steps 5,6 and 7 below can be skipped, otherwise manual setup will be required as described in these steps.
563+
564+
### 5. Service account
559565

560566
A service account with the correct permissions on the events table should exist.
561567

562568
If this does not exist then follow the steps above:
563569
- [Create an appender service account](#3-create-an-appender-service-account)
564570
- [Give the service account access to your dataset](#3-create-an-appender-service-account)
565571

566-
### 5. Service account permissions for workload identity federation
572+
### 6. Service account permissions for workload identity federation
567573

568574
The service account defined in step 4 above should be granted access using service account impersonation.
569575

570576
If this does not exist then access can be granted with either the [update wif service account permissions ](https://github.com/DFE-Digital/teacher-services-analytics-cloud/blob/main/scripts/gcloud/update-wif-service-account-permissions.sh) gcloud script or from the [IAM](https://console.cloud.google.com/iam-admin/workload-identity-pools/pool/azure-cip-identity-pool) gcloud console, by navigating to the "GRANT ACCESS" window. Use the attributes specified in the gcloud script. Note that the subject must be set to the Managed Identity Object ID from Azure for each environment (see Step 1 above).
571577

572-
### 6. Download the WIF client credentials
578+
### 7. Download the WIF client credentials
573579

574580
Download the JSON WIF Credentials file and set to following environment variables to the content of this file:
575581

0 commit comments

Comments
 (0)