Installing Unravel on cloud platforms using Ansible

Home

Installing Unravel on cloud platforms using Ansible

You can install Unravel on Amazon EMR, Databricks (Azure, AWS), and Google cloud platform (Dataproc, BigQuery) using Ansible.

Navigate to the ansible-installation directory and create a copy of the vars_template.yml file.
```
cp vars_template.yml vars.yml
```
Edit vars.yml by using any editor. For example, the vi editor.
```
vi vars.yml
```

Update the value for the cloud_platform parameter.

# Update any required fields
# Must set cloud_platform=emr/dataproc/databricks

The vars.yml file contains deployment parameters. You can customize these parameters for installing and deploying Unravel on cloud platforms.

Parameter Name	Description	Required or Optional
`skip_download_untar`	Y: If you set this variable to `Y`, it skips the step to download and extract the Unravel tarball and configures or sets up Unravel. N: If you set this variable to `N`, it downloads and extracts the Unravel installation tarball.	Required
`unravel_tar_url`	Specify URL of the Unravel installation tarball. Example: `https://preview.unraveldata.com/unravel/RPM/<version>/unravel-<version>.<buildnumber>.tar.gz`	Required
`unravel_tar_download_username`	Specify an authorization user name to download the Unravel installation tarball. Example: `Unravel-<version>`	Optional
`unravel_tar_download_password`	Specify an authorization user name to download the Unravel installation tarball. Example: `<password>`	Optional
`unravel_tar_dst`	Specify the path to the folder where the Unravel installation tarball is saved. Example: `/tmp`	Optional
`unravel_user`	Operating system user running as Unravel. Example: `Unravel`	Required
`unravel_group`	Operating system group running as Unravel. Example: `unravelgroup`	Required
`unravel_root_path`	Specify the root folder path to install Unravel. Example: `/opt`	Required
`unravel_version`	Specify the Unravel version you want to install and upgrade. Example: `<version>.buildnumber`	Required
`skip_precheck`	If you set this variable to `Y`, it skips the interactive precheck utility.	Required
`db_type`	Database type. It can be MySQL, MariaDB, or PostgreSQL. The PostgreSQL database is considered if you do not specify the database type.	Required
`use_external_database`	Set to `Y` to use an external database. If you have specified `db_type`, then set `use_external_database` to `N`.	Required
`external_db_host` `external_db_port` `external_db_schema` `external_db_user` `external_db_pass`	Specify values for the external database. If you have specified `use_external_database=Y`, then you must set these values.	Optional
`db_extra_path`	Specify the path to the folder where JDBC driver or database binaries are placed for MySQL and MariaDB. Example: `/temp/mysql`	Optional
`data_dir`	Custom data directory for Unravel Elasticsearch, Kafka, and so on. Creates the external data directory outside the Unravel installation directory.	Optional
Path to the Private certificate needs to import into Unravel truststore
`trust_certs`	Specify the path of the private certificate. You must import this certificate into Unravel truststore.	Optional
`password`	Specify the password set for the private certificate.	Optional
For TLS UI
`tls_ui`	Set to `Yes` if TLS for UI needs to be configured.	Required
`tls_ui_cert` `cert_path`	Path to the certificate served by Unravel when TLS UI is enabled.	Optional
`password`	Specify the password for `jks` and `pcks` format certificates.	Optional
`tls_ui_key`	Specify the path to the private key for the TLS UI certificate.	Optional
`tls_key_pwd`	Specify the password to decrypt the private key.	Optional
Path for setting up Unravel license
`license_path`	Specify the path of the license file. The file must be readable by the `unravel` user. Note If you define the `license_path` variable, the license setup is automatically run.	Required
Other parameters
`should_start_unravel`	If you set this variable to `Y`, Unravel automatically starts after installation.	Optional

The following table lists parameters (for cloud) available in the vars.yml file, their descriptions, and example values:

Parameter Name	Description	Required or Optional
`cloud_platform`	Specify the name of the cloud platform. The supported values are Databricks, Amazon EMR, Dataproc, HDI, and BigQuery.	Required
For Databricks You can configure multiple workspaces using the following parameters effectively and quickly rather than configuring them individually from the user interface. For information about workspace, see Databricks documentation.
`dbx_path`	Specify the path of `databricks-cli`.	Optional
`workspace_id_placeholder`	Databricks workspace ID, which can be found in the Databricks URL. Replace with the workspace ID of the workspace. It acts as a unique key for this workspace.	Optional
`workspace_name`	Databricks workspace name, which can be found in the Databricks URL.	Optional
`workspace_instance`	Regional URL where the Databricks workspace is deployed.	Optional
`workspace_token`	Specify the token generated for the Databricksworkspace. Use the personal access token to secure authentication to the Databricks REST APIs instead of passwords. You can generate the token from the workspace URL (Go to Settings > User Settings > Access Token > Generate New Token) See Authentication using Databricks personal access tokens to create personal access tokens.	Optional
`workspace-tier`	Specify the subscription option: Standard, Premium, or Enterprise. You can get the pricing information from the Azure portal. For detailed information about pricing tiers, see Databricks AWS pricing.	Optional
`remove`	Set this variable to `true` to remove a Databricks workspace. Default is `false`.	Optional
`lr_hostname`	Specify the Log Receiver (LR) endpoint.	Optional
`lr_port`	Specify the Log Receiver (LR) endpoint port.	Optional
`lr_tls`	Specify `yes` to encrypt the Log Receiver (LR) endpoint.	Optional
`verify_lr_cert`	Specify `no` if you do not want to verify the Log Receiver (LR) certificate trust chain.	Optional
For BigQuery
`bq_project_id`	Specify the project ID of the BigQuery project to be removed.	Optional
`bq_subscription_id`	Specify the subscription ID of the BigQuery project to be removed.	Optional
`bq_credentials_file`	Specify the path to the service Key file or credentials file for BigQuery.	Optional

Note

For Dataproc and Amazon EMR, Ansible does not process any parameters.

From the Unravel server, run the Ansible playbook.
```
ansible-playbook -i inventories/ install_unravel.yml -e @vars.yml -vvv
```
Applies all values specified in the vars.yml to the Ansible playbook. See Verify Unravel installation using Ansible.

(Optional) Update the cloud_node inventory if you do not run the Ansible playbook from the Unravel server.

Command

vi inventories/cloud_node/hosts

Output

# Example hosts file
# [cloud_node]
# abc.unraveldata.com ansible_user=unravel ansible_ssh_private_key_file=/root/.ssh/id_rsa

Define the hive metastore properties in a .txt file for Databricks. See Configuring Hive Metastore (Cloud).
Define the hive metastore properties in a .txt file for Dataproc. See Configuring Hive Metastore (Cloud).
Define the hive metastore properties in a .txt file for EMR. See Configuring Hive Metastore (Cloud) and Configuring external hive metastore (EMR).
Specify the BigQuery configuration in Unravel. See Add BigQuery details in Unravel.
Configure the EMR cluster in Unravel. See Connect a new or existing EMR cluster to Unravel.
Configure the Dataproc cluster in Unravel. See Connecting Unravel Server to a new Dataproc cluster.
Specify the path of a .txt file in the prop_file_paths variable. Ensure that the .txt file is readable by the Unravel user.
```
ansible-playbook -i inventories/ install_unravel.yml -e @vars.yml -vvv --tag hive_metastore
```

In this section:

Would you like to provide feedback? Just click here to suggest edits.

Home

Installing Unravel on cloud platforms using Ansible

Note

Note

Search results