RDA Studio Installation Guide

This document captures pre-requsites, platforms certified to deploy RDA Studio in Robotic Data Automation Fabric (RDAF).

RDA Studio Software installation prerequisites

CloudFabrix supports Windows, Linux, and Mac OS environments to install, configure and run RDA studio software. Below are the prerequisites which need to be in place before RDA studio can be installed and configured.

1. Prerequisites

Before you proceed, make sure you meet the following requirements

Windows 10 / Linux / Mac OS X with the below software are installed

CPU - 2
Memory - 8 GB
Disk - 50 GB
Docker version 18.09.2 (or above)
Docker-compose (1.27.x and above)
Python 3.7.4 (recommended) or above
pip3 utility

Internet Connectivity to download the 'RDA' studio docker image.

CloudFabrix docker registry URL: cfxregistry.cloudfabrix.io
If there is HTTP Proxy in place, please refer to Docker documentation on how to configure HTTP Proxy settings for the Docker service.

Verify Prerequisites

Make sure the below commands are in the PATH variable in the user's login profile.

Run the below commands to verify currently installed RDA prerequisites.

docker --version

docker-compose --version

python3 --version

pip3 --version

2. Linux OS Environment

RDA software installation on Linux OS

Step 1:

Download the 'rda-docker-compose-with-ssl.tar' software package.

wget https://macaw-amer.s3.amazonaws.com/rda/rda-docker-compose-with-ssl.tar

Step 2:

Extract the rda-docker-compose-with-ssl.tar software package under the user's home directory or some other directory.

tar xvf rda-docker-compose-with-ssl.tar

List of files shown would be:

conf.yml
docker-compose.yml
setup.py
cfx_license_key.yml

Step 3:

Run setup.py python script as shown below.

python3 setup.y

Note

The setup.py creates a directory called cfx under user's home directory for configuration files and exported files. Example: /home/rdauser/cfx or ~/cfx

Below are the 'RDA' directory locations and their purpose.

~/cfx/cfxdx/config
- Location of the conf.yml file where many datasource credentials and other settings are configured.
~/cfx/cfxdx/output
- Location of the exported CSV / Excel / JSON files

Step 4:

To access 'RDA' interface, open up a browser and enter the URL as https://ipaddress:9998

Note: If firewall service is running, enable port 9998/tcp to access RDA service through a browser.

Additional Steps for CentOSAdditional Steps for Ubuntu

sudo firewall-cmd --add-port=9998/tcp --permanent
sudo firewall-cmd --reload

This section provides additional steps to deploy RDA on Ubuntu OS (Certified on 18.04). Using the currently logged-in user, run the following commands to make sure the user has sufficient permissions.

sudo groupadd docker
sudo gpasswd -a $USER docker
docker ps

If the above command throws an error 'permission denied error', run the following command to provide sufficient privileges to the currently logged-in user to run docker (Skip this step if the command does not throw permission denied error or the user has sufficient privileges/permissions).

sudo chmod 666 /var/run/docker.sock

- Run the following commands to install docker-compose for the currently logged-in user.

sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

Open firewall to allow 9998 port

sudo ufw allow 9998/tcp

Step 5: Access RDA Studio using Chrome/Safari browser

Note:
Access RDA using https://<rda-ip-address>:9998/ The default user name is rdademo and the password is rdademo1234

RDA related files

RDA Studio UI via Browser

Note: Default username/password can be changed from docker-compose.yml file under RDA studio install directory.

environment:
  CFXDX_CONFIG_FILE: /tmp/config/conf.yml
  RDA_USER: rdademo
  RDA_PASSWORD: rdademo1234

Step 5:
Accessing RDA Studio Main Landing Page

RDA related files

RDA Studio Main Landing Page

2.1 Upgrade RDA Studio on Linux

Step 1:

docker-compose --version (1.27.4)

List of files shown would be:

LICENSE.txt
HowTo-cfxdx.ipynb
conf.yml
docker-compose.yml
setup.py
cfx_license_key.yml

Step 2: Go to the directory where RDA studio was previously installed.

cd /home/macaw/rda-docker-compose-with-ssl

Step 3: Make sure RDA Studio is up and running. This can be verified by running the docker command as shown below.

bash# docker ps -a | grep cfxdx

dcfe060d7522  cfxregistry.cloudfabrix.io/ubuntu-cfxdx-nb-nginx-all:daily "/usr/bin/supervis..."   13 seconds ago  Up 12 seconds  0.0.0.0:9998->9998/tcp, 9999/tcp   rda-docker-compose-with-ssl_cfxdx_1

Step 4: Make sure docker-compose command is in the PATH environment and docker-compose.yml is available in the directory as shown below.

bash# docker-compose --version 

docker-compose version 1.29.1, build unknown

bash# ls -lrt docker-compose.yml

-rw-rw-r--. 1 macaw macaw 838 May 19 13:37 docker-compose.yml

Step 5: Using the docker-compose command 'docker-compose down' and bring down the RDA Studio instances that are running in your environment as shown in the below screenshot.

bash# docker-compose down

Stopping rda-docker-compose-with-ssl_cfxdx_1 ... done
Stopping rda-docker-compose-with-ssl_minio_1 ... done
Removing rda-docker-compose-with-ssl_cfxdx_1 ... done
Removing rda-docker-compose-with-ssl_minio_1 ... done
Removing network rda-docker-compose-with-ssl_default

Step 6: Using the docker-compose command, upgrade RDA using the 'docker-compose pull'

bash# docker-compose pull
Pulling minio ... done
Pulling cfxdx ... pull complete

Pulling minio ... done
Pulling cfxdx ... extracting (100.0%)

Step 7: Start RDA upgraded Studio instance using 'docker-compose up -d' as shown in the below.

bash# docker-compose up --d 

Creating network "rda-docker-compose-with-ssl_default" with the default driver
Creating rda-docker-compose-with-ssl_minio_1 ... done
Creating rda-docker-compose-with-ssl_cfxdx_1 ... done

Step 8: Verify the RDA docker instances to be up-and-running using the 'docker ps -a' command as shown below.

bash# docker ps -a | grep cfxdx 

1d7493d9a757 cfxregistry.cloudfabrix.io/ubuntu-cfxdx-nb-nginx-all:daily "/usr/bin/supervis..."   14 seconds ago  Up 12 seconds  0.0.0.0:9998->9998/tcp, 9999/tcp rda-docker-compose-with-ssl_cfxdx_1

3. Mac OS Environment

Note: Please check the Prerequisites - Installation Prerequisites before you proceed.

Note: Make sure the below commands are in the PATH variable in the user's login profile.

Run the below commands to verify currently installed RDA prerequisites.

Verify Prerequisites

Make sure the below commands are in the PATH variable in the user's login profile.

Run the below commands to verify currently installed RDA prerequisites.

docker --version

docker-compose --version

python3 --version

pip3 --version

Step 1:
Download the 'rda-docker-compose-with-ssl.tar' software package.

Download the binary from https://macaw-amer.s3.amazonaws.com/rda/rda-docker-compose-with-ssl.tar

Step 2:
Create a virtual environment using python3

python3 -m venv <name of the environment>
eg.
$ python3 -m venv rda-venv

Step 3:
Source virtual env that was created in Step 2 as shown below.

$ cd rda-venv 
$ source bin/activate
(rda-venv)$  

Step 4:
Install docker-compose tool needed to install RDA as shown below

(rda-venv)$  pip3 install docker-compose
(rda-venv)$  docker-compose --version
docker-compose version 1.29.0, build 07737305
(rda-venv)$  

Note: Make sure docker-compose is installed properly

Step 5:
Extract the 'rda-docker-compose-with-ssl.tar' software package under the user's home directory or some other directory.

(rda-venv)$  tar -xvf rda-docker-compose-with-ssl.tar

Step 6:
Run setup.py python script as shown below.

(rda-venv):rda-venv $ python3 setup.py

Successful installation and setup of RDA Studio on Mac OS Note: The setup.py creates a directory called 'cfx' under user's home directory for configuration files and exported files. (Ex: /home/userid/cfx)

Below are the 'RDA' directory locations and their purpose.
* /home/userid/cfx/cfxdx/config --> Location of the conf.yml file where many datasource credentials and other settings are configured.
* /home/userid/cfx/cfxdx/output --> Location of the exported CSV / Excel / JSON files

Step 7:
To access 'RDA' interface, open up a browser and enter the URL as https://ipaddress:9998

Note: Access RDA using https://rda-ip-address:9998/

The default user name is rdademo and the password is rdademo1234

RDA related files

Default landing page of RDA Studio on Mac OS Note: Default username/password can be changed from docker-compose.yml file under RDA studio install directory.

environment:
  CFXDX_CONFIG_FILE: /tmp/config/conf.yml
  RDA_USER: rdademo
  RDA_PASSWORD: rdademo1234

Note: Default username/password can be changed from docker-compose.yml file under RDA install directory.

3.1 Upgrade RDA Studio on MacOS

Step 1:
Make sure the docker (desktop) environment is intact as per RDA installation prereqs. Also, docker-compose is available to the user (as shown in the below)

List of files shown would be:

conf.yml
docker-compose.yml
setup.py
cfx_license_key.yml

Step 2:
Go to the directory where RDA Studio was previously installed.

$: cd rda-venv
$: source bin/activate
(rda-venv):rda-venv $

Step 3:
Make sure RDA is up and running. This can be verified by running the docker command as shown in the below.

(rda-venv):rda-venv $ docker ps -a

Step 4:
Go to the directory where RDA Studio was installed and also, docker-compose.yml is available (as shown in the below)

(rda-venv):rda-venv $ docker-compose --version
docker-compose version 1.29.2, build unknown

(rda-venv):rda-venv $ ls -lrt docker-compose.yml
-rw-r--r--  1 rpisupati  staff  744 May 16 10:33 docker-compose.yml

Step 5:
Using the docker-compose command 'docker-compose down' and bring down the RDA instances that are running in your environment as shown in the below screenshot.

(rda-venv):rda-venv $ docker-compose down

Stopping rda-docker-compose-with-ssl_cfxdx_1 ... done
Stopping rda-docker-compose-with-ssl_minio_1 ... done
Removing rda-docker-compose-with-ssl_cfxdx_1 ... done
Removing rda-docker-compose-with-ssl_minio_1 ... done
Removing network rda-docker-compose-with-ssl_default

Step 6:
Using the docker-compose command, upgrade RDA using the 'docker-compose pull' command as shown in the below.

(rda-venv):rda-venv $ docker-compose pull
Pulling minio ... done
Pulling cfxdx ... pull complete

Pulling minio ... done
Pulling cfxdx ... extracting (100.0%)

Step 7:
Start RDA upgraded instance using 'docker-compose up -d' as shown in the below.

(rda-venv):rda-venv $ docker-compose up --d 

Creating network "rda-docker-compose-with-ssl_default" with the default driver
Creating rda-docker-compose-with-ssl_minio_1 ... done
Creating rda-docker-compose-with-ssl_cfxdx_1 ... done

Access RDA Studio using https://IPAddress:9998 and verify the latest version.

4. Windows OS Environment

Note: Please check the Prerequisites - Installation Prerequisites before you proceed.

Note: Make sure the below commands are in the PATH variable in the user's login profile.

Verify Prerequisites

Make sure the below commands are in the PATH variable in the user's login profile.

Run the below commands to verify currently installed RDA prerequisites.

docker.exe --version
OR
docker --version

docker-compose.exe --version
OR
docker-compose --version

python3.exe --version
OR 
python3 --version

pip3.exe --version
OR
pip3 --version

Step 1:
Download the 'rda-docker-compose-with-ssl.tar' software package.

Download the binary from https://macaw-amer.s3.amazonaws.com/rda/rda-docker-compose-with-ssl.tar

Step 2:
Extract 'rda-docker-compose.tar' software package and copy the folder to C: (or other folder location)

Windows Prerequisite Tools

Note: 7zip or Winrar utility is needed to extract the 'rda-docker-compose-with-ssl.tar' file on Windows OS.

Step 3:
Open Windows Powershell CLI or CMD CLI utility (CLI), go to C:\rda-docker-compose-with-ssl (or other folder location 'rda-docker-compose-with-ssl' install folder is unpacked) and run setup.py python script as shown below.

PS C:\rda-docker-compose-with-ssl > 
PS C:\rda-docker-compose-with-ssl > python3 .\setup.py


Copyright (C) 2021 CloudFabrix Software Inc. All rights reserved.

License terms are specified here:
https://www.cloudfabrix.com/license/cfxdimensions/eula.pdf

By proceeding with installation, you are agreeing to accept the License terms as specified at the above URL.

Login Succeeded
[INFO] Downloading docker images
Pulling minio ... done
Pulling cfxdx ... done
[INFO] Starting Services
Creating network "rda-docker-compose-with-ssl_default" with the default driver
Creating rda-docker-compose-with-ssl_minio_1 ... done
Creating rda-docker-compose-with-ssl_cfxdx_1 ... done

Connect using browser to http://IPADDRESS:9998

PS C:\rda-docker-compose-with-ssl >

Note

The setup.py creates a folder called 'cfx' under the user's home directory for configuration files and exported files.(Ex: C:\Users\Administrator\cfx).

Below are the 'RDA' studio folder locations and their purpose.

C:\Users\Administrator\cfx\cfxdx\config --> Location of the conf.yml file where many datasource credentials and other settings are configured.

Step4:
To access the 'RDA' interface, open up a browser and enter the URL as https://:9998

Windows-firewall

If Windows firewall service is enabled, enable ports 9998/tcp to access RDA service through a browser.

Studio-default-user-password

The default user/password for RDA authentication is: rdademo/rdademo1234

4.1 Upgrade RDA Studio on WindowsOS

Step 1:
Make sure the docker (desktop) environment is intact as per RDA Studio installation prereqs. Also, docker-compose.exe is available to the user (as shown in the below)

PS C:\cd "Program Files\Docker\Docker\resources\bin"
PS C:\Program Files\Docker\Docker\resources\bin > dir docker-compose.exe 

05/03/2021  10:10 PM    10,451,720   docker-compose.exe

Step 2:
Go to the directory where RDA Studio is previously installed.

List of files shown would be:

PS C:\cd rda-docker-compose-with-ssl
PS C:\rda-docker-compose-with-ssl > 

  C:\cd rda-docker-compose-with-ssl 
  C:\rda-docker-compose-with-ssl> dir
      05/03/2021  10:56 AM    <DIR>         .
      05/03/2021  10:56 AM    <DIR>         ..
      05/03/2021  10:10 PM    450           conf.yml
      05/03/2021  10:10 PM    1250          cfx_license_key.yml
      05/03/2021  10:10 PM    711           docker-compose.yml
      05/03/2021  10:10 PM    8641          HowTo-cfxdx.ipynb
      05/03/2021  10:10 PM    272           LICENSE.txt
      05/03/2021  10:10 PM    2891          setup.py
                    6 File(s)               14,215 bytes
                    2 Dir(s)        12,473,393,152 bytes

Step3: Make sure RDA Studio is up and running. This can be verified by
running the docker command as shown below.

PS C:\cd rda-docker-compose-with-ssl
PS C:\rda-docker-compose-with-ssl > 
PS C:\rda-docker-compose-with-ssl > docker ps -a 

CONTAINER ID      IMAGE             COMMAND     CREATED     STATUS    PORTS
759a68b50e    cfxregistry.cloudfabrix.io/ubuntu-cfxdx-nb-nginx-all:daily "/usr/bin/supervis..." 3 weeks ago    Up 10 seconds 0.0.0.0:9998

Step4:
Go to the directory where RDA Studio is installed and also,
docker-compose.yml is available as shown below.

PS C:\cd rda-docker-compose-with-ssl
PS C:\rda-docker-compose-with-ssl > dir docker-compose.yml

05/03/2021  10:10 PM    711           docker-compose.yml

Step5:
Using the docker-compose command 'docker-compose down' and bring down
the RDA Studio instances that are running in your environment as shown below.

PS C:\cd rda-docker-compose-with-ssl
PS C:\rda-docker-compose-with-ssl > docker-compse down

Stopping rda-docker-compose-with-ssl_cfxdx_1 ... done
Stopping rda-docker-compose-with-ssl_minio_1 ... done
Removing rda-docker-compose-with-ssl_cfxdx_1 ... done
Removing rda-docker-compose-with-ssl_minio_1 ... done
Removing network rda-docker-compose-with-ssl_default ...

PS C:\cd rda-docker-compose-with-ssl

Step6:
Using the docker-compose command, upgrade RDA Studio using
the 'docker-compose pull' command as shown below.

PS C:\cd rda-docker-compose-with-ssl
PS C:\rda-docker-compose-with-ssl > docker-compse pull

Pulling minio ... done
Pulling cfxdx ... done

PS C:\cd rda-docker-compose-with-ssl

Step7:
Start RDA Studio upgraded instance using 'docker-compose up --d' as shown below.

PS C:\cd rda-docker-compose-with-ssl
PS C:\rda-docker-compose-with-ssl > docker-compose up --d

Creating network "rda-docker-compose-with-ssl_default" with the default driver
Creating rda-docker-compose-with-ssl_minio_1 ... done
Creating rda-docker-compose-with-ssl_cfxdx_1 ... done

PS C:\cd rda-docker-compose-with-ssl

Step8:
Verify the RDA Studio docker instances are up-and-running using the 'docker ps -a' command as shown below.

PS C:\cd rda-docker-compose-with-ssl
PS C:\rda-docker-compose-with-ssl > 
PS C:\rda-docker-compose-with-ssl > docker ps -a 

CONTAINER ID      IMAGE             COMMAND     CREATED     STATUS    PORTS
759a68b50e    cfxregistry.cloudfabrix.io/ubuntu-cfxdx-nb-nginx-all:daily "/usr/bin/supervis..." 3 weeks ago    Up 10 seconds 0.0.0.0:9998

Access RDA Studio using https://IPAddress:9998 and verify the latest version.