Setup for BigQuery Connector - Access Management¶
This section outlines the procedure for setting up GCP BigQuery. Please ensure that you have completed the prerequisites before beginning the setup.
Please perform the following steps to configure the GCP BigQuery connector:
-
SSH into the instance where Privacera is installed.
-
Run the following command to navigate to the /config directory.
Bash -
Run the following command to create a new directory:
Bash -
Run the following command to copy the sample vars:
Bash -
Run the following command to open the .yml file to be edited.
Bash -
Transfer the Service Account key JSON file, obtained during Attach IAM Role to Service Account, to the
/custom-vars/connectors/bigquery/instance1/
directory. Subsequently, modify thevars.connector.bigquery.yml
file by updating the variableCONNECTOR_BIGQUERY_OAUTH_PRIVATE_KEY_FILE_NAME
with the name of the newly placed JSON file. -
Modify the following properties:
-
CONNECTOR_BIGQUERY_PROJECT_ID
- Enter the GCP Bigquery Project ID you want to use. -
CONNECTOR_BIGQUERY_PROJECT_LOCATION
- Set GCP Bigquery Project Location. -
CONNECTOR_BIGQUERY_USE_VM_CREDENTIALS
- Set this to true, if you are running connector on GCP instance. -
CONNECTOR_BIGQUERY_OAUTH_SERVICE_ACCOUNT_EMAIL
- Set the service account email which have access to GCP resources required by PolicySync. -
CONNECTOR_BIGQUERY_OAUTH_PRIVATE_KEY_FILE_NAME
- Set Private key file name if
CONNECTOR_BIGQUERY_USE_VM_CREDENTIALS is set to False. -
CONNECTOR_BIGQUERY_CUSTOM_IAM_ROLES_SCOPE
- Set the scope of the custom IAM roles to be created. Allowed values: "project" or "org". -
CONNECTOR_BIGQUERY_ORGANIZATION_ID
- Enter your GCP organization ID if you want to create IAM roles at the organization level. -
CONNECTOR_BIGQUERY_AUDIT_ENABLE
- Set to "true" to enable auditing for BigQuery. -
CONNECTOR_BIGQUERY_AUDIT_EXCLUDED_USERS
- Enter a comma-separated list of users whose access audits you want to exclude. If not set, it excludes the service account set inCONNECTOR_BIGQUERY_OAUTH_SERVICE_ACCOUNT_EMAIL
by default. -
CONNECTOR_BIGQUERY_MANAGE_PROJECT_LIST
- Enter a comma-separated list of project IDs that PolicySync will manage. -
CONNECTOR_BIGQUERY_MANAGE_DATASET_LIST
- Enter a comma-separated list of datasets that PolicySync will manage. Format:<PROJECT_ID>.<DATASET_NAME>
. -
CONNECTOR_BIGQUERY_GRANT_UPDATES
- Set to "true" to enable PolicySync to perform grant and revoke updates on access control. -
CONNECTOR_BIGQUERY_NATIVE_PUBLIC_GROUP_IDENTITY_NAME
- Enter the public group identity name for access grants. Allowed values: "ALL_AUTHENTICATED_USERS", "ALL_USERS", or any valid Google group name. -
CONNECTOR_BIGQUERY_ENABLE
- Set to "true" to enable PolicySync for BigQuery. -
CONNECTOR_BIGQUERY_MANAGE_ENTITY_PREFIX
- Enter a comma-separated list of prefixes for users, groups, and roles that PolicySync will manage. For example:dev_*, sa_*
. Leave blank to manage all entities.
-
-
Once the properties have been configured, execute the following commands to update your Privacera Manager platform instance:
-
In PrivaceraCloud, navigate to Settings -> Applications.
-
On the Applications screen, select BigQuery.
-
Enter the application Name and Description, then click Save. The name can be any designation of your choice, such as
BigQuery Connector for account 123456
. -
Open the BigQuery application.
-
Enable the Access Management option using the toggle button.
-
Under the BASIC tab, enter the values for:
-
BigQuery Project Location :
us
-
BigQuery Project Id :
projectXXX
-
Service Account Email :
Use the service account email which have access to GCP resources required by PolicySync.
-
Service Account Json Key Content :
Use Service Account JSON
-
Projects to Set Access Control Policies :
Project IDs you want to manage
-
Native Public Group Identity Name :
Specifies the public group identity to be used for access grants in policies referring to public groups. Allowed values: ALL_AUTHENTICATED_USERS (All GCP project authenticated users) or ALL_USERS (All Google authenticated users).
-
Enable Audit :
Specifies whether Privacera fetches access audit data from the data source. Allowed values: true or false.
-
-
Click SAVE.
-
The configured BigQuery connector appears under Applications.
-
Once saved and enabled, the BigQuery connector will start. Then you can hover on the VIEW LOGS button to check the status, either Running or Stopped.
-
Perform following steps to restart the BigQuery connector application:
-
Go to Settings → Applications → select the****BigQuery** connector application** .
-
Edit the application → Disable it → and Save it.
-
Open the same application again and then: Enable it → and Save it.
-
- Prev topic: Prerequisite
- Next topic: Advance Configurations