Installing Unityapp

Skip to main content

Home

Installing Unityapp

Before installing the Unity app, complete the related prerequisites. You must download and extract the unity-app-47.tar.gz app tar file to the$UNRAVEL_HOME/data/apps/ directory. The following directories are extracted, which must be used to install the Unity one and the App Comparator separately.

unity-one
AppComparator

The Pipeline health and observability must be separately installed using the pipe_obs.tar.gz file.

Ensure to complete the prerequisites before you install.

Prerequisites

The section provides information about the prerequisites for Unity one app, App Comparator, and Pipeline health and observability.

Run the following prerequisites before you install Unityapp.

Verify that the ports 8111 and 8050 are open and accessible with a firewall.
Do one of the following steps to check if the ports are open:
1. Run the following commands.
```
ss -tnl | grep 8111
```
```
ss -tnl | grep 8050
```
2. Run the telnet command to check the telnet host port.
```
telnet <host> <port>
```
  For example:
  - Successful
    $ telnet xyz.unraveldata.com 8111 Connected to xyz.unraveldata.com.
  - Unsuccessful
    $ telnet xyz.unraveldata.com 8111 telnet: connect to address <IP address>: Connection refused
Keep the paths to the following handy:
- $UNRAVEL_HOME: The directory is located at <Unravel installation directory>/unravel.
- unravel.properties file.
Create directory apps under $UNRAVEL_HOME/data/ if it is not created already.
For example:
```
cd $UNRAVEL_HOME/data/
mkdir -p apps
```
Run the following pre-execution steps:
Download the Unityapp and copy the unity-app-47.tar.gz file to the $UNRAVEL_HOME/data/apps/ directory.
```
wget https://preview.unraveldata.com/unravel/patches/unity/unity-app.tgz
```

Run the following prerequisites before you install Pipeline health and observability

Verify if port 8080 is open and accessible with a firewall.
Do one of the following steps to check if the ports are open:
- Run the following command.
```
ss -tnl | grep 8080
```
- Run the telnet command to check the telnet host port.
```
telnet <host> <port>
```
  For example:
  - Successful
    $ telnet xyz.unraveldata.com 8080 Connected to xyz.unraveldata.com.
  - Unsuccessful
    $ telnet xyz.unraveldata.com 8080 telnet: connect to address <IP address>: Connection refused

Run the following pre-execution steps:

wget https://preview.unraveldata.com/unravel/RPM/pipe-obs/pipe_obs.tar.gz

Installing Unityapp

Important

In case there is an existing installation of the Unity app in your system, you must remove it and proceed with a fresh installation. Refer to Uninstalling Unity app.
An Unravel user must perform all the installation steps.

Untar the $UNRAVEL_HOME/data/apps/unity-app-47.tar.gz file, which you downloaded and copied earlier.
```
tar zxf unity-app-47.tar.gz
```
The following two directories are extracted:
- unity-one
- AppComparator

Change owner to Unravel, if not done already.

chown -R unravel-install-user:unravel-install-usergroup UNRAVEL_HOME/data/apps/

Install App Comparator app.
Installing App Comparator
Change directory to /bin.
cd $UNRAVEL_HOME/data/apps/AppComparator/bin/
This will run the App Comparator on the 8050 port by default. To change the default port, update AppComparator/app_comparator/resources/config.ini.
Run the start.sh script and specify the Unravel installation path and unravel.properties path when prompted.
For example:
This will run the app by default on the 8050 port.
Go to http://<unravelhost>:8050 and verify if the app is running.
Install Unity Oneapp.
Installing Unity Oneapp
Run the following steps to install
Using a terminal, change directory to $UNRAVEL_HOME/data/apps/unity-one/src.
Open the config.py file and specify the paths for the following:
Note
If the path for unravel.properties is $UNRAVEL_HOME/conf/unravel.properties , then remove /data from the following property in the config.py file { 25 unravel_props = unravel_install_dir + '/data/conf/unravel.properties'}
{ 25 unravel_props = unravel_install_dir + '/data/conf/unravel.properties'}
unravel_install_dir
Path to Unravel installation directory.
compare_url
Specify the URL of App Comparator. For example: http://xyz.unraveldata.com:8050
pipe_obs_url path(optional)
Specify the URL of Pipeline health and observability. For example: http://xyz.unraveldata.com:8112
For example:
Change directory to $UNRAVEL_HOME/data/apps/unity-one/src and set up the index mapping template for the Elastic search feature.
curl -XPOST -d@templates/features_template.json http://localhost:4171/_template/feature_template
The following output is shown:
{"acknowledged":true}
Start the app.
sh start.sh
Verify that a total of 4 processes are running:
ps -ef | grep unity
For example:
unravel 2370 1 0 16:53 ? 00:00:00 /home/unravel/unity-one/python3/bin/python3.7 -m gunicorn index:server --daemon --pid=gunicorn.pid --bind 0.0.0.0:8111 --threads=16 -w 1 --log-level debug --error-logfile logs/gunicorn_error.log --access-logfile logs/gunicorn_access.log --capture-output unravel 2375 2370 0 16:53 ? 00:00:12 /home/unravel/unity-one/python3/bin/python3.7 -m gunicorn index:server --daemon --pid=gunicorn.pid --bind 0.0.0.0:8111 --threads=16 -w 1 --log-level debug --error-logfile logs/gunicorn_error.log --access-logfile logs/gunicorn_access.log --capture-output unravel 2731 2375 0 16:53 ? 00:00:00 /home/unravel/unity-one/python3/bin/python3.7 reports/scheduler.py unravel 2732 2375 0 16:53 ? 00:00:06 /home/unravel/unity-one/python3/bin/python3.7 ast_extractor.py
Check $UNRAVEL_HOME/data/apps/unity-one/src/logs/ast-extractor.log for any exceptions.
Use a browser and go to https://<unravelhost>:8111 specified for Unity One app> to view the app on a browser.
Install Pipeline health and observability.
Installing Pipeline health and observability
Run the following steps to install Pipeline health and observability:
Go to Download and extract the pipeline_obs tar file to $UNRAVEL_HOME/data/apps/.
Using a terminal, change directory to $UNRAVEL_HOME/data/apps/pipe_obs/src and run the start.sh script.
sh start.sh
Use a browser and go to https://<unravelhost>:8080 to view the app on a browser.

Configuring SSL for Unity app

The section provides steps to configure SSL for Unity one app, App Comparator, and Pipeline health and observability.

Run the following steps to enable SSL for the Unity one app:

Change directories and open start.sh

cd $UNRAVEL_HOME/data/apps/unity-one/src/
vi start.sh

Update paths for the following in start.sh:
- KEY: specify the path to the key file.
- CERT: specify the path to the certificate files.

Open config.py and update enable_https option to true.

vi config.py

jobs_path = 'assets/reports/jobs'
# Enable https instead of using http
enable_https = true

Save and quit
Restart the Unity one app.
Caution
Chrome may not open the app because of self-signed certificates. There is a secret passphrase built into the error page. Ensure that the page is selected (click anywhere on the screen), and type thisisunsafe.

Run the following steps to enable SSL for the App Comparator:

Change directories and open config.ini.

cd $UNRAVEL_HOME/data/apps/AppComparator/app_comparator/resources/
vi config.ini

Update the following:
- protocol: Specify the protocol as https
- key_file: specify the path to the key file.
- cert_file: specify the path to the certificate files.
Save and quit
Restart the App Comparator.
Caution
Chrome may not open the app because of self-signed certificates. There is a secret passphrase built into the error page. Ensure that the page is selected (click anywhere on the screen), and type thisisunsafe.

Run the following steps to enable SSL for Pipeline health and observability:

Change directories and open start.sh

cd $UNRAVEL_HOME/data/apps/pipe_obs/src/
vi start.sh

Update the following in start.sh:
- KEY: specify the path to the key file.
- CERT: specify the path to the certificate files.
- ENABLE_HTTPS: Set this to true.
Save and quit
Restart the Pipeline health and observability app.
Caution
Chrome may not open the app because of self-signed certificates. There is a secret passphrase built into the error page. Ensure that the page is selected (click anywhere on the screen), and type thisisunsafe.

In this section:

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