To connect to BigQuery, Sisu requires a minimum level of permissions. This is accomplished using Google Cloud Platform (GCP) Service Accounts, which allow for permissions to be assigned to application connections instead of users. It is recommended that you create a new Service Account for Sisu. For more information on creating a Service Account, please refer to the the Google GCP Documentation here.
Step 1: Service Account Permissions
Note: The individual creating this Service Account will need to have Owner permissions on the BigQuery Project and also will need to enable the BigQuery API. To accomplish this, please refer to above documentation link.
Create a new Service Account and assign it the permissions listed below. These are required so the Service Account can access BigQuery and query the necessary data for Sisu analysis. For information about these roles and permissions, please refer to the BigQuery predefined IAM roles documentation.
- BigQuery Data Viewer
- BigQuery Job User
- BigQuery Read Session User
- BigQuery Resource Viewer
Step 2: Gather Connection Information
Navigate to the newly created Service Account and access the 'Keys' subpage. This should be empty. Select the 'Add Key' option and use JSON as the format for the key. This will create and download a private JSON key used for the Service Account. For more information on creating Service Accounts, please refer to the Google Cloud Platform Authentication documentation.
Note: This key cannot be recovered if lost.
<INSERT SCREENSHOT FOR THIS PROCESS?>
In the BigQuery project, take note of the ProjectID and write it down. This will be used in conjunction with the JSON Key for the Sisu connection.
<Insert example of where user can find project ID>
At the end of this step, the following information should have been obtained:
- Project ID
- Service account credentials file (JSON)
Step 3: Grant permissions to dataset
Navigate to the BigQuery console in order to assign the appropriate permissions to the Sisu Service Account. Follow the steps below to share the dataset with the Service Account. If multiple datasets need to be assigned to the Service account, repeat these steps multiple times.
For more information on granting access to datasets, please refer to the BigQuery Controlling access to datasets documentation.
Connecting a New Data Source
To establish the connection in Sisu, navigate to the Data tab in the main menu. Select the "+ New data source" button at the top right of the page and choose BigQuery from the data source type dropdown menu. Fill in the Project Id and upload the JSON file downloaded during the Service Account creation step.
Select Add and Sisu will validate the connection.
If there are any issues, please contact the Google Cloud Platform administrator, or send Sisu an email at firstname.lastname@example.org.