Install Unravel for GCP BigQuery (Interactive Precheck install)

Before setting up Unravel for BigQuery, ensure the installation requirements are completed.

Follow the instructions to install and set up Unravel to receive BigQuery data.

Note

The instructions for installation provided in this section use the interactive precheck utility. For the manual installation instructions, refer to Manually installing Unravel for GCP BigQuery.

Install and set up Unravel on the GCP instance

Do the following to set up Unravel on the GCP instance.

1. Create and configure the GCE

On your GCP console, go to the GCE dashboard and click Create Instance.
Select the following options based on Unravel's instance requirements:
- Base OS
- Instance type and size
- Ports
- Networking
  The instance must be HTTPS and publicly accessible.
- Firewall rules or policies
  Sample inbound rule
  Type
  Protocol
  Port range
  Source
  All traffic
  All
  All
  For example, 10.10.0.0/16
  SSH
  TCP
  22
  0.0.0.0/0 or trusted public IP for SSH access
  Custom TCP Rule
  TCP
  3000
  Custom TCP Rule
  TCP
  4043
  Custom TCP Rule
  TCP
  4443
  Sample outbound rule
  Type
  Protocol
  Port range
  Source
  All traffic
  All
  All
  0.0.0.0/0
Note
The GCP instance should have all TCP access to the BigQuery cluster (server/parent or worker) nodes. You can grant access by inserting adding firewall rules of the BigQuery server/parent and worker with all TCP, all port range.
While creating the GCP instance add the Firewall properties, Enable the HTTP and HTTPS traffic Go to Network tab and add Network tags. (This is the firewall rule that is already created.)

Type	Protocol	Port range	Source
All traffic	All	All	For example, 10.10.0.0/16
SSH	TCP	22	0.0.0.0/0 or trusted public IP for SSH access
Custom TCP Rule	TCP	3000
Custom TCP Rule	TCP	4043
Custom TCP Rule	TCP	4443

Type	Protocol	Port range	Source
All traffic	All	All	0.0.0.0/0

Configure the GCE instance

Disable selinux.
```
sudo setenforce Permissive
```
Edit /etc/selinux/config to ensure the setting persists after reboot and ensure SELINUX=permissive.
```
sudo vi /etc/selinux/config
```
Install libaio.x86_64, lzop.x86_64, and ntp.x86_64.
```
sudo yum install -y libaio.x86_64
sudo yum install -y lzop.x86_64
sudo yum install -y ntp.x86_64
```
If you are using Unravel-managed MySQL or MariaDB, run sudo yum install numactl-devel.x86_64 command. Also refer to Integrating Database.
Set vm.max_map_count to 262144
Set nproc limit to unlimited.
Add unravel.conf file with the following settings to /etc/security/limits.d:
```
unravel    soft  nproc unlimited
```
Start ntpd and check the system time.
```
sudo service ntpd start
sudo ntpq -p
```
Create a new Unravel user, which should not be a root user. For example:
```
sudo useradd unravel
```

2. Download Unravel

Download Unravel onto the VM instance that you have created.

Important

Before downloading Unravel for your platform, ensure to get the username and password from Unravel Support.

Download the Unravel package (RPM or TAR):

You can refer to Download section for the complete list of Unravel product downloads.

For example:

Tar

curl -v https://preview.unraveldata.com/unravel/RPM/4.x.x/unravel-4.x.x.x-cloud.tar.gz -u username:password

RPM

curl -v https://preview.unraveldata.com/unravel/RPM/4.x.x/unravel-4.x.x.x.rpm -o unravel-4.x.x.x.rpm -u username:password

3. Deploy Unravel

Deploy Unravel on the GCP instance that you have created.

Unravel binaries are available as a tar file or RPM package. You can deploy the Unravel binaries in any directory on the server. However, the user who installs Unravel must have the write permissions to the directory where the Unravel binaries are deployed.

After deploying the Unravel binaries, the directory layout for the Tar and RPM will be unravel/versions/<Directories and files>. The binaries are deployed to <Unravel_installation_directory>, and Unravel will be available in <Unravel_installation_directory/unravel.

The following steps to deploy Unravel from a tar file should be performed by a user who will run Unravel.

Create an Installation directory.
```
mkdir /path/to/installation/directory
```
For example: mkdir /opt/
Extract the Unravel tar file to the installation directory, which you have created in the first step. After you extract the contents of the tar file, the unravel directory is created within the installation directory.
```
tar zxf unravel-<version>tar.gz -C /path/to/installation/directory
```
For example: tar zxf unravel-4.x.x.x.tar.gz -C /opt
The unravel directory will be available within /opt.
Grant ownership of the directory to a user who will run Unravel.
```
chown -R username:groupname /path/to/installation/directory
```
For example: chown -R hadoop:hadoop /opt/unravel/

Important

A root user should perform the following steps to deploy Unravel from an RPM package. After the RPM package is deployed, the remaining installation procedures should be completed by the Unravel user.

Create an installation directory.
```
mkdir /usr/local/unravel
```
Run the following command:
```
rpm -i unravel-<version>.rpm
```
For example: rpm -i unravel-4.x.x.x.rpm
The unravel directory will be available in /usr/local.
If you want to provide a different location, use the --prefix command. For example:
```
mkdir /opt/unravel
rpm -i unravel-4.x.x.x.rpm --prefix /opt
```
The unravel directory will be available in /opt.
Grant ownership of the directory to a user who will run Unravel. This user executes all the processes involved in the Unravel installation.
```
chown -R username:groupname /usr/local/unravel
```
For example: chown -R hadoop:hadoop /usr/local/unravel
Continue with the installation procedures as unravel user.

4. Install Unravel

You can also manually install Unravel, Refer to Run setup

The Interactive Precheck utility is run to validate the required configurations before installing Unravel. When you run the Interactive Precheck utility, various checks are prompted for gathering configuration information. The responses you provide for these checks generate a bootstrap configuration file. This file, which contains the configuration information, is then used to install Unravel.

Do the following to install and configure Unravel with Interactive Precheck.

After you download and deploy the Unravel, run the precheck.sh script from unravel/versions/X.Y.Z/healthcheck/.
For example:
/opt/unravel/versions/X.Y.Z/healthcheck/precheck.sh

Enter the necessary details when you are prompted for the following configuration information:

For this check, you must answer the following prompts:

Authentication mode
Method to fetch data from BigQuery

To complete the checks, do the following:

Authentication mode
Choose whether to integrate BigQuery with Unravel using one of the following authentication modes.
```
-- BigQuery
Authentication mode:
1- Dedicated key per project (multi)
2- Shared key per project (single)
3- VM attached service account (VM) 

Select one of the above. 
```
- 1-- Dedicated key per project, which is to integrate Unravel using the key within each project.
- 2-- Shared key per project, which integrates BigQuery with Unravel using a single key shared over multiple projects. If you select this option, you are prompted to enter the project ID where the single key is stored.
- 3-- VM attached service account, which integrates BigQuery with Unravel using a service account attached to a project, which is attached to the VM where Unravel is installed. If you choose this option, you must provide the project ID of the VM where Unravel is installed.
Method to fetch data from BigQuery
Select a method that can be used to get data from BigQuery. You can choose either the Pull method or the Push method.
```
-- BigQuery
Do you want Unravel to pull data from BigQuery? (yes=pull, no=push) (y/n)
```
Tip
Unravel recommends the Pull method, which is more secure.
- Pull method
  Type yes to use the Pull method. In case you leave it empty also, the pull method is used by default.
```
-- BigQuery
Do you want Unravel to pull data from BigQuery? (yes=pull, no=push) (y/n) [Yes]: yes
```
  The polling time to pull data from BigQuery is set to 300 seconds (5 mins) by default. You can change this time separately after installation by running the manager config set-polling command:
  For example:
```
/opt/unravel/manager config bigquery set-polling 100 
```
  Refer to Set polling period for BigQuery pull method for detailed instructions.
  Caution
  When you use the Pull method, there is some delay for the BigQuery jobs to be displayed on the Unravel UI compared to the Push method, where the BigQuery jobs are displayed in real-time.
- Push method:
  Type no, to use the Push method. If you select the push method, you are prompted to enter the LR endpoint and the LR port where data can be pushed from BigQuery. 4443 is the default LR port, which can be changed. Ensure that the LR end point supports HTTPS.
  Note
  Also, refer to 7. Configure an HTTPS Load Balancer for Unravel Endpoint
```
-- BigQuery
Do you want Unravel to pull data from BigQuery? (yes=pull, no=push) (y/n) [Yes]: no
Log receiver fully qualified hostname [None]: <lr-endpoint>
Log receiver port (integer) [4443]: <lr-port>
```

After you have installed Unravel for BigQuery, run the following command to verify the method you have set to get data from BigQuery.

<Unravel installation directory>/unravel/manager config bigquery show

The following sample output is shown:

-- Running: config bigquery show
BigQuery support: Enabled
LR endpoint: Default
Mode: pull
Polling: Default

Billing data location: Not configured

VM SA: Disabled

Project: test-01
integration: true
is_admin: false
is_monitoring: true
subscription_id: unravel-bigquery-sub
Project: test-02
integration: true
is_admin: false
is_monitoring: true
subscription_id: unravel-bigquery-sub
Project: test-03
integration: true
is_admin: false
is_monitoring: true
subscription_id: unravel-bigquery-sub

Datapage projects: 0 out of 100.

--------------------------------
Please have the output of manager config bigquery show as the above

This check allows you to configure database-related information and an external database for Unravel.

-- Database configuration
 Configure an external database? (y/n) [No]:

If you answer No, an Unravel-managed database is used for the installation.

If you answer Yes, you are further prompted for the type of external database that you want to configure.

-- Database configuration
   
   Configure an external database? (y/n) [No]: y

   Type
   1- PostgresQL
   2- MySQL
   3- MariaDB

If you choose a specific type of external database, you are prompted for the following database information and test connectivity to that database. Refer to Integrating Database for more details. For example: Integrate database (Cloud)

-- Database configuration
  
   Configure an external database? (y/n) [No]: y

   Type
   1- PostgresQL
   2- MySQL
   3- MariaDB

   Select one of the above []: 1
   Selected: PostgresQL

   Database hostname [None]:

   Database port (integer) [None]:

   Database schema [None]:

   Does the database use TLS (y/n) [No]: 

   Database username [None]:

   Database password [None] (no echo):

   Do you wish to test connecting to the external database? (y/n) [Yes]:-- Database configuration
 Configure an external database? (y/n) [No]:

If you choose MySQL or MariaDB database you are further prompted for extra packages. If you answer Yes, the Extra packages section searches for the required JDBC drivers.
```
-- Database configuration
 Will Unravel connect to a MySQL or MariaDB database (ex: hive metastore) ? (y/n) [No]: 
```

The Extra packages check shows if you use Unravel-managed MySQL/MariaDB or need JDBC drivers. Else, this check is automatically skipped.

-- Extra package location

*** JDBC drivers are required for Unravel managed MySQL or MariaDB.
*** Database software package is required for Unravel managed MySQL or MariaDB.

External package location [None]: /<my-extra-packages>
##This is the path to the directory where the required packages are located.

If the required packages are located, then the following message is shown:

The following packages will be installed:
   Database server: /my-extra-packages/mysql-5.7.27-linux-glibc2.12-x86_64.tar.gz
   JDBC driver:
     - /my-extra-packages/mysql-connector-java-5.1.48.tar.gz

 External package: Ok

If the required packages are not found, then the following error message is showing:

External package: ERROR
 - ERROR: Couldn't find jdbc drivers in /my-extra-packages
 - ERROR: Looked for:
   mysql-connector-java-*.tar.gz
   mysql-connector-java-*.jar
   mariadb-java-client-*.jar
 - ERROR: Couldn't find database server package in /my-extra-packages
 - ERROR: Looked for:
   mysql-*-linux-glibc2.12-x86_64.tar.gz
   mariadb-*-linux-x86_64.tar.gz

The license option prompts you to set the Unravel license. Specify the license file location.

--License
Do you want to set the unravel license now? (y/n) [Yes]:
License file location (ex: /path/to/unravel.license) [/home/unravel/valid.lic]:
License: Ok

If the license file is valid, the OK message is displayed.
If the license file is expired, the license expired error is displayed with the license expiry date and timestamp.
If the license file content is incorrect, the invalid license error is displayed with the appropriate error message. You can fix the error in the license file and then set the license.
To resolve the errors, see Licensing error messages and troubleshooting.

Note

If the filename is not provided, the command prompts for the license information. You can provide either a path to the license file or the content of the license file.

Sample content of the license file:

##### BEGIN UNRAVEL LICENSE 
Licensee     : ACME Disintegrating Pistol Manufacturing
Valid from    :  2022-12-16 00:00:00 UTC 
Expire after  :  2023-10-16 23:59:00 UTC
License type : Enterprise
Licensed number of nodes : 1000000
Signature    : c2Uvb2JqLnRhcmdldC92OF9pbml0aWFsaXplcnMvZ2VuL3RvcnF1ZS
Revision     : 1
##### END UNRAVEL LICENSE #####

This check allows you to configure and test HTTPS for the unravel UI. This check prompts you for the certificate, key, password, and hostname details used to access Unravel.

Use HTTPS to access unravel? (y/n) [Yes]:  
##If you answer “Yes”, you are prompted for the path to the certificate and key. Unravel uses this information to configure TLS during installation. 
##If you answer “No”, you are shown a warning message for confirmation.

The information provided is verified for the following:

If the Key and Certificate match
If the certificate is valid
If the certificate applies for the provided hostname

This check allows you to set the Unravel UI port and verify the connectivity.

-- Unravel default port
  
  Port number (integer) [3000]: 

  Do you want to test if the port is accessible? (y/n) [Yes]: 
    
  This will open port 3000 and listen for connection for 120 seconds.
  Use your browser to test if the Unravel UI will be accessible on that port.
    
  We have detected the following hostnames:
  - some.host.example
    
 Browse to: http://some.host.example:3000
    
 ATTENTION: This address is an example. You should test with the URL that will be used to access Unravel.

A connection on port 3000 is tried and established. If the connection is successful, Unravel Port Test: OK is shown on the browser, and Unravel port: Reached is shown on the server.

This check allows you to set a custom data directory and verify the access if the directories exist. You will always find the software location where you deploy the Unravel binaries. In this check, only the space and access are tested. That data location that you have configured will be used.

-- Unravel directories

  Software [/opt/unravel]: 

  Data [/opt/unravel/data]: 

  Directories: ERROR
  - OK: 33 GB of free disk space for software.
  - ERROR: SYSH0026: Space for data 33 GB is low, recommended minimum is 100 GB.

This check allows you to configure and test email. You are prompted for host and credentials, and the following items are tested:

Connectivity
Authentication, only if provided.
Optional: Send test mail.

Following is a sample:

-- Mail server (SMTP) configuration

Unravel can send notification and alert emails.
   This will allow you to configure and test connection to a SMTP server.
   Optionally, it can also send a test email.

   You will have to provide:
   - Protocol, hostname and port
   - Credentials if required



   Configure a SMTP server? (y/n) [No]: y

   SMTP hostname [None]: smtphostname.gmail.com

   SMTP port (usually 25 for clear text, 465 for SSL, 587 for STARTLS) (integer) [None]: 587

   Security protocol
   1- None
   2- SSL
   3- StartTLS

   Select one of the above [None]: 3
   Selected: StartTLS

   Authentication required? (y/n) [Yes]: y

   Username [None]: daemon@unraveldata.com

   Password [None] (no echo):

   From [None]: daemon@unraveldata.com

   To [None]: user@unraveldata.com

   Send test email (y/n) [No]: y

Note

For more information, refer to Using the Interactive Precheck utility.

The responses that you have provided for the configuration information are used to generate a configuration file. You can use this configuration file when you run the setup command to install and configure Unravel.

After you have completed the responses, you are prompted to confirm if you want to generate the bootstrap configuration file. Press ENTER if you want to generate the bootstrap configuration file.
```
-- Unravel bootstrap configuration

   Generate a unravel bootstrap configuration file? (y/n) [Yes]:
```
The bootstrap configuration file is generated and located at $HOME/unravel-interactive-precheck/unravel-bootstrap.yaml.

Install Unravel with the bootstrap configuration file.

<unravel_installation_directory>/unravel/versions/<Unravel version>/setup --bootstrap $HOME/unravel-interactive-precheck/unravel-bootstrap.yaml

Apply the changes.

<Unravel installation directory>/unravel/manager config apply

Start all the services.

<unravel_installation_directory>/unravel/manager start

Check the status of services.
```
<unravel_installation_directory>/unravel/manager report 
```
The following service statuses are reported:
- OK: Service is up and running.
- Not Monitored: Service is not running. (Has stopped or has failed to start)
- Initializing: Services are starting up.
- Does not exist: The process unexpectedly disappeared. A restart will be attempted ten times.
You can also get the status and information for a specific service. Run the manager report command as follows:
```
<unravel_installation_directory>/unravel/manager report <service> 
```
For example: /opt/unravel/manager report auto_action

5. Run the CURL command to fix a known issue

You can encounter a NoIndexFound exception for fresh installations of Unravel on GCP-BigQuery. This is a known issue in Unravel version 4.7.7.0. As a workaround for this issue, you must run the following CURL command on the Unravel node after the installation:

curl -XPUT http://localhost:4171/app-19700101_07

6. Enable Transport Layer Security (TLS) for Unravel UI

Refer to Enabling Transport Layer Security (TLS) for Unravel UI.

7. Configure an HTTPS Load Balancer for Unravel Endpoint

Note

The HTTPS load balancer for Unravel endpoint must be configured only when using the Push model.

Unravel LR endpoint should be available over a publically accessible HTTPS endpoint to receive messages from BigQuery PubSub. The Load Balancer is an easier and more secure method to push the log messages between the Google Cloud Platform (GCP) and Unravel. Use the following instructions to configure an HTTPS load balancer for Unravel with public endpoint and SSL termination.

You must have the following information handy before you configure the Load Balancer:

Region and Zone where the Unravel VM is running.
Network and Subnet-network where the Unravel VM is running.
A valid SSL certificate in GCP.

Do the following to create a Load Balancer

Create an instance group. Refer to Create a managed instance group for detailed instructions.
- In the New unmanaged instance group page, ensure to keep the following items the same as that of Unravel VM.
  - Location > Region
  - Location > Zone
  - Network and Instances > Network
  - Network and Instances > SubNetwork
- Under Port Mapping, enter the following:
  - Port Name: http4043
  - Port Number: 4043
Set up an HTTPS Load Balancer. Refer to Set up an HTTPS Load Balancer for detailed instructions. Ensure to do the following:
- Under Name, update the name as unravel-loadbalancer.
- In Backends > New Backend > Instance groups, select the Unravel instance group that you had created in Step 1.
- Under Health check, do the following:
  - Select Create a health check, and then add the name as unravel-4043-hc
  - Update the Protocol as HTTP and Port as 4043.
  - Update the Request Path as /lr/status.
- Ensure that Port is set to 443 to allow HTTPS traffic.
After the Load Balancer is created, find the public IP address of the Load Balancer that is mentioned under Frontend section of the Load Balancer. Add the IP address of the Load Balancer to a valid DNS name.

8. Set up Unravel to receive BigQuery data automatically

Unravel can be set up to automatically create and configure resources in more than 100 projects at a time. You can either add single projects or multiple projects at a time for Unravel monitoring. These projects can be added either with customer-supplied credentials or with Unravel-generated credentials.

You must separately configure the BigQuery projects that you want to track from the Data page. The Data page on Unravel UI can show data for only up to 100 BigQuery projects.Data

Unravel ships the following resources, which are required to automatically set up Unravel to receive BigQuery data.

Terraform
Open-source software for infrastructure provisioning.
gcloud CLI
Set of tools to create and manage Google Cloud resources.

Note

You can also manually set up Unravel to receive BigQuery data. Refer to Set up Unravel to receive BigQuery data

Before you set Unravel to receive BigQuery data

BigQuery projects can be set in Unravel using either one of the following:

Unravel-generated credentials
Customer-supplied credentials

For projects added with Unravel-generated credentials, all the resources are created and handled by Unravel. However, for the customer-supplied credentials, you must create and provide all the resources.

Ensure to have the following handy before you add the projects:

Google account with required IAM role permissions for gcloud CLI authentication
IAM role permissions for gcloud CLI authentication
The Google account used to authenticate with gcloud CLI must have the following permissions to create and delete resources on GCP for tracking BigQuery. These permissions fit into the security principle of least privilege , which means that these are the only permissions required to get the job done. If you do not have the following permissions, the Terraform script will not run properly.
Important
The IAM role permissions should be for every project the Google account user wants to integrate with Unravel.
iam.roles.create
iam.roles.delete
iam.roles.get
iam.roles.undelete
iam.roles.update
iam.serviceAccountKeys.create
iam.serviceAccountKeys.delete
iam.serviceAccountKeys.get
iam.serviceAccounts.create
iam.serviceAccounts.delete
iam.serviceAccounts.get
iam.serviceAccounts.getIamPolicy
iam.serviceAccounts.setIamPolicy
logging.sinks.create
logging.sinks.delete
logging.sinks.get
pubsub.subscriptions.create
pubsub.subscriptions.delete
pubsub.subscriptions.get
pubsub.topics.attachSubscription
pubsub.topics.create
pubsub.topics.delete
pubsub.topics.get
pubsub.topics.getIamPolicy
pubsub.topics.setIamPolicy
resourcemanager.projects.get
resourcemanager.projects.getIamPolicy
resourcemanager.projects.setIamPolicy
Execute the following commands from the Google Cloud shell to automate the creation of a role and bind it to the user.
Run the following to create the role.
gcloud iam roles create UnravelGoogleAuthRole --organization=<your-org-id-in-gcp> --title=UnravelGoogleAuthRole --description="Creation of role in GCP on an organization level for automated integrating bigquery projects with Unravel" --permissions=iam.roles.create,iam.roles.delete,iam.roles.get,iam.roles.undelete,iam.roles.update,iam.serviceAccountKeys.create,iam.serviceAccountKeys.delete,iam.serviceAccountKeys.get,iam.serviceAccounts.create,iam.serviceAccounts.delete,iam.serviceAccounts.get,iam.serviceAccounts.getIamPolicy,iam.serviceAccounts.setIamPolicy,logging.sinks.create,logging.sinks.delete,logging.sinks.get,pubsub.subscriptions.create,pubsub.subscriptions.delete,pubsub.subscriptions.get,pubsub.topics.attachSubscription,pubsub.topics.create,pubsub.topics.delete,pubsub.topics.get,pubsub.topics.getIamPolicy,pubsub.topics.setIamPolicy
For example:
gcloud iam roles create UnravelGoogleAuthRole --organization=592556919173 --title=UnravelGoogleAuthRole --description="Creation of role in GCP on an organization level for automated integrating bigquery projects with Unravel" --permissions=iam.roles.create,iam.roles.delete,iam.roles.get,iam.roles.undelete,iam.roles.update,iam.serviceAccountKeys.create,iam.serviceAccountKeys.delete,iam.serviceAccountKeys.get,iam.serviceAccounts.create,iam.serviceAccounts.delete,iam.serviceAccounts.get,iam.serviceAccounts.getIamPolicy,iam.serviceAccounts.setIamPolicy,logging.sinks.create,logging.sinks.delete,logging.sinks.get,pubsub.subscriptions.create,pubsub.subscriptions.delete,pubsub.subscriptions.get,pubsub.topics.attachSubscription,pubsub.topics.create,pubsub.topics.delete,pubsub.topics.get,pubsub.topics.getIamPolicy,pubsub.topics.setIamPolicy,resourcemanager.projects.get,resourcemanager.projects.getIamPolicy,resourcemanager.projects.setIamPolicy
Bind the role to a user.
gcloud organizations add-iam-policy-binding <your-org-id-in-gcp> --member='user:<user account>' --role='organizations/<unravel-organization-ID>/roles/UnravelGoogleAuthRole'
For example:
gcloud organizations add-iam-policy-binding 592556919173 --member='user:user@unraveldata.com' --role='organizations/592556919173/roles/UnravelGoogleAuthRole'
Project ID file in case you are integrating multiple projects at a time with Unravel.
Project ID text file
You can configure multiple projects with customer-supplied credentials. To implement this, you must create a text file containing the list of project IDs and provide the path of this file during integration. Each line in the text file must carry a single Project ID.
For example:
```
project-id-011
project-id-012
project-id-013
project-id-014
project-id-015
project-id-016
project-id-017
project-id-018
project-id-019
project-id-020
```
Customer-supplied credential files in case you are integrating projects using customer-supplied credentials.
Customer-supplied credentials directory
Each project, which you want to add for monitoring, must have a corresponding credentials file in the credentials directory with the same project ID and .json extension.
Important
The credentials file should have the same name as the project ID.
For example, you have the project-id-file with the following project IDs:
```
first-project
second-project
```
then the credential files in the credentials directory should have the service account keys JSON file as follows:
```
first-project.json
second-project.json
```
Log Receiver (LR) endpoint
This is required only when you are adding projects.
Subscription ID (Optional)
The subscriber ID that you want to configure with a pub/sub topic. This is optional. If this is not provided then the default subscription ID unravel-bigquery-sub is considered.
Note
If you have created the resources on GCP, then the Subscription ID is mandatory.

Setup Unravel to automatically configure BigQuery projects for Unravel monitoring

Stop Unravel.

<Unravel installation directory>/unravel/manager stop

Set the Log Receiver (LR) endpoint. This step is required only if you are using customer-supplied credentials to add the projects.
Important
Ensure that the LR end point supports HTTPS.
```
<Unravel installation directory>/unravel/manager config bigquery set-lr-endpoint <host> <port>
```
For example: /opt/unravel/manager config bigquery set-lr-endpoint myhostname.unraveldata.com 1234
Run <Unravel installation directory>/unravel/manager config bigquery show to verify. The following output is shown
```
— Running: config bigquery show
BigQuery support: Enabled
LR endpoint: https://myhostname.unraveldata.com:1234
No project configured.
```
Add BigQuery projects.
Configure the BigQuery projects that you want to be monitored by Unravel. Single or multiple BigQuery projects can be added for monitoring. You can configure the projects either with the customer-supplied credentials or with Unravel-generated credentials.
Also, refer to Remove BigQuery projects from Unravel
Single BigQuery monitoring project (customer-supplied credentials)
When you configure a single project with customer-supplied credentials, you specify the path to the credentials file, and the credentials in the file are copied and encrypted.
Note
For customer-supplied credentials, you must configure the target endpoint of the Pub/Sub subscription ID to unravel the LR HTTPS endpoint. This is mandatory if you have selected the Push method.
To add a single BigQuery project for Unravel monitoring with customer-supplied credentials, do the following:
Using a terminal, run the following command from the Unravel installation directory:
For API Pull/Push method
<Unravel installation directory>/unravel/manager config bigquery add <project-id> <subscription-id> <path/to/credentials-file>
For example:
/opt/unravel/manager config bigquery add my-project subscription-12345 /credentials/unravel.json
For INFORMATION-SCHEMA method
<Unravel installation directory>/unravel/manager config bigquery add <project-id> <path/to/credentials-file>
For example:
/opt/unravel/manager config bigquery add my-project /credentials/unravel.json
Note
You can use the same command to add more projects one at a time. If you use the same project ID, the existing project gets updated.
Multiple BigQuery projects (Unravel-generated credentials)
Unravel can automatically create resources on the GCP side and generate the credentials required to monitor BigQuery projects.
Run the following command to add multiple BigQuery projects for Unravel monitoring with customer-supplied credentials:
<Unravel installation directory>/unravel/manager config bigquery add --batch </path/to/project-id-file> [--subscription-id <sub>] --need-integration
Note
</path/to/project-id-file>: The full path to the directory containing the project IDs.
--subscription-id : This is an optional field. If you do not provide any value, the default unravel-bigquery-sub is considered.
In case you have chosen the INFORMATION-SCHEMA method for polling data, you need not add the subscription ID.
For example, you have a list of projects in project-id-file with a subscription ID as a-sub-id. Run the following command to add multiple projects with Unravel-generated credentials:
manager config bigquery add --batch /opt/unravel/project-id-file --subscription-id a-sub-id --need-integration
Run <Unravel installation directory>/unravel/manager config bigquery show to verify. The following output is shown:
$ /opt/unravel/manager config bigquery show -- Running: config bigquery show BigQuery support: Enabled LR endpoint: https://myhost.unraveldata.com:1234 Project: first-project credentials_file: /opt/unravel/data/conf/bigquery/credentials/first-project datapage: true integration: true subscription_id: a-sub-id Project: second-project credentials_file: /opt/unravel/data/conf/bigquery/credentials/second-project datapage: true integration: true subscription_id: a-sub-id Datapage projects: 2 out of 100. — Ok
Single BigQuery project (Unravel-generated credentials)
Unravel can automatically create the appropriate resources and generate the credentials required to monitor BigQuery projects. To add a single BigQuery project for Unravel monitoring with Unravel generated credentials, do the following:
Using a terminal, run the following command from the Unravel installation directory:
```
<Unravel installation directory>/unravel/manager config bigquery add <project-id> <subscription-id> --need-integration
```
Note
In case you have chosen the INFORMATION-SCHEMA method for polling data, you need not add the subscription ID.
For example:
/opt/unravel/manager config bigquery add my-project subcription-12345 --need-integration
Multiple BigQuery projects (Unravel-generated credentials)
Unravel can automatically create resources on the GCP side and generate the credentials required to monitor BigQuery projects.
Run the following command to add multiple BigQuery projects for Unravel monitoring with customer-supplied credentials:
<Unravel installation directory>/unravel/manager config bigquery add --batch </path/to/project-id-file> [--subscription-id <sub>] --need-integration
Note
</path/to/project-id-file>: The full path to the directory containing the project IDs.
--subscription-id : This is an optional field. If you do not provide any value, the default unravel-bigquery-sub is considered.
In case you have chosen the INFORMATION-SCHEMA method for polling data, you need not add the subscription ID.
For example, you have a list of projects in project-id-file with a subscription ID as a-sub-id. Run the following command to add multiple projects with Unravel-generated credentials:
manager config bigquery add --batch /opt/unravel/project-id-file --subscription-id a-sub-id --need-integration
Run <Unravel installation directory>/unravel/manager config bigquery show to verify. The following output is shown:
$ /opt/unravel/manager config bigquery show -- Running: config bigquery show BigQuery support: Enabled LR endpoint: https://myhost.unraveldata.com:1234 Project: first-project credentials_file: /opt/unravel/data/conf/bigquery/credentials/first-project datapage: true integration: true subscription_id: a-sub-id Project: second-project credentials_file: /opt/unravel/data/conf/bigquery/credentials/second-project datapage: true integration: true subscription_id: a-sub-id Datapage projects: 2 out of 100. — Ok

Add projects to Data page.

You must separately configure the BigQuery projects that you want to track from the Data page. The Data page on Unravel UI can show data for only up to 100 BigQuery projects.Data

Also, refer to Remove BigQuery projects from Data page on Unravel UI.

To add single projects to Data page, run the following:
```
<Unravel installation directory>/unravel/manager config bigquery enable-datapage <project-id>
```
For example: /opt/unravel/manager config bigquery enable-datapage myproject
To add multiple projects to Data page, run the following:
```
<Unravel installation directory>/unravel/manager config bigquery enable-datapage --batch </path/to/project-id-file> 
```
For example: /opt/unravel/manager config bigquery enable-datapage --batch /opt/unravel/project-id-file

Run <Unravel installation directory>/unravel/manager config bigquery show to verify if the project IDs are enabled for Data page. The following sample output is shown:

$ /opt/unravel/manager config bigquery show
— Running: config bigquery show

BigQuery support: Enabled
LR endpoint: https://myhost.unraveldata.com:1234
Project: project-id-file
integration: true
subscription.id: a-sub-id

Project: first-project
credentials.file: /opt/unravel/data/conf/bigquery/credentials/first-project
subscription.id:  a-sub-id

Project: second-project
credentials.file: /opt/unravel/data/conf/bigquery/credentials/second-project
subscription.id:  a-sub-id

Datapage projects: 2 out of 100

Integrate BigQuery projects for Unravel monitoring. This is a mandatory step for Unravel-generated credentials.
Note
When the following command is run, you can configure all the projects added for Unravel monitoring at once i.e projects with customer-supplied credentials as well as with Unravel managed credentials.
```
<Unravel installation directory>/unravel/manager config bigquery integrate
```
A URL will be provided in the output.
Note
If you want to skip the interactive gcloud authentication by Unravel and handle the gcloud authentication on your own, then run the command as follows:
```
<Unravel installation directory>/unravel/manager config bigquery integrate --skip-authorization
```
Authenticate gcloud CLI.
1. On a Google Chrome browser, copy the URL provided in the output, and in the sign-in dialog box, click Allow. Ensure to sign in to the gcloud CLI from the account that is authenticated with the required permissions.
2. From the Sign in to the glcoud CLI box, click Copy button to copy the authorization code.
3. Go back to the terminal and paste the authorization code in the Enter authorization code field and press ENTER. This will run the following actions in the background:
  - Authenticate the user with Google Cloud.
  - Configure the required resources on the GCP.
  - Encrypt the credentials (service account keys) and then integrate them with Unravel.
  - Integrate all the added BigQuery projects with Unravel.
  - Securely sign out the end user from the gcloud session.

Apply the changes.

<Unravel installation directory>/unravel/manager config apply

Start Unravel.

<Unravel installation directory>/unravel/manager start

Also, see a complete list of manager commands for BigQuery installation. Configurations

Also, see Set up Unravel to receive BigQuery data manually.

Remove BigQuery projects from Unravel

Note

When you remove a BigQuery project from Unravel, then the associated data also gets deleted from ElasticSearch.

Stop Unravel.

<Unravel installation directory>/unravel/manager stop

Run the following command from the Unravel installation directory.
- For single project
```
<Unravel installation directory>/unravel/manager config bigquery remove <project-ID>
```
  For example: /opt/unravel/manager config bigquery remove my-project
- For multiple projects
```
<Unravel installation directory>/unravel/manager config bigquery remove --batch </path/to/project-id-file>
```
  For example: /opt/unravel/manager config bigquery remove --batch /opt/unravel/my-projects.txt

Apply the changes.

<Unravel installation directory>/unravel/manager config apply

Start Unravel.

<Unravel installation directory>/unravel/manager start

Remove BigQuery projects from Data page on Unravel UI

Note

When you remove a BigQuery project from Data page, then the associated data also gets deleted from ElasticSearch.

Stop Unravel.

<Unravel installation directory>/unravel/manager stop

Run the following command from the Unravel installation directory.
- For single project
```
<Unravel installation directory>/unravel/manager config bigquery delete-datapage <project-ID>
```
  For example: /opt/unravel/manager config bigquery delete-datapage --batch my-project
- For multiple projects
```
<Unravel installation directory>/unravel/manager config bigquery delete-datapage --batch </path/to/project-id-file>
```
  For example: /opt/unravel/manager config bigquery delete-datapage --batch /opt/unravel/my-projects.txt

Apply the changes.

<Unravel installation directory>/unravel/manager config apply

Start Unravel.

<Unravel installation directory>/unravel/manager start

9. Verify BigQuery integration

To verify BigQuery integration with Unravel, do the following:

On the GCP console, run test queries from the project integrated with Unravel.
Using a supported web browser, navigate to Unravel URL (For example, https://<unravel-host>:3000) and log onto Unravel UI using the credentials.
Navigate to Jobs tab > Applications , and under Application type, select BigQuery. The details of the test queries run from the GCP console will be listed under the All tab.

In this section:

Home

Install Unravel for GCP BigQuery (Interactive Precheck install)

Note

Install and set up Unravel on the GCP instance

1. Create and configure the GCE

Note

Configure the GCE instance

2. Download Unravel

Important

3. Deploy Unravel

Important

4. Install Unravel

Tip

Caution

Note

Note

Note

5. Run the CURL command to fix a known issue

6. Enable Transport Layer Security (TLS) for Unravel UI

7. Configure an HTTPS Load Balancer for Unravel Endpoint

Note

8. Set up Unravel to receive BigQuery data automatically

Note

Before you set Unravel to receive BigQuery data

Important

Important

Note

Setup Unravel to automatically configure BigQuery projects for Unravel monitoring

Important

Note

Note

Note

Note

Note

Note

Note

Note

Note

9. Verify BigQuery integration

Search results