...

For setting up this server the below applications or tools should be available in the server machine:

1. JDK – 1.817
2. TOMCAT – v8v9.50.xx
3. MAVEN – v3.8 or above
4. Device Manager 

The below software should be installed and available for running Device Manager UI server.

MySQL DB

Check whether My SQL DB is already installed and up and running.  For installation of MySQL in the below OS refer the below links

• Linux:

https://dev.mysql.com/doc/refman/5.6/en/linux-installation.html

Following page provide details on setting up MySQL 5.6 on linux .

Automatics Orchestration Setup#MySql5.6

• Microsoft Windows: https://dev.mysql.com/doc/refman/5.6/en/windows-installation.html

Jdk – 1.8

JDK should be available in the build machine where the .war file for Device Manager server is build and it should be available in the server machine.

• Linux:

https://docs.oracle.com/javase/8/docs/technotes/guides/install/linux_jdk.html

Following page provides details on installing Java 1.8 on linux.

Automatics Orchestration Setup#JDK1.8

• Microsoft Windows: https://docs.oracle.com/javase/8/docs/technotes/guides/install/windows_jdk_install.html#CHDEBCCJ

Tomcat – v8.5 or above

Tomcast 8.5 is required to deploy Device Manager UI server. Tomcat server installation file and setup documents can be found in the below links:

If you already have an existing setup of Automatics you can follow the steps in this page for upgrading the software's Automatics Technology Stack - Upgrade 

Software Requirement

• JDK 17

Please note that even though the recommended version of Orchestration is JDK17, it is reverse compatible with JDK11 also. So code also be compiled with JDK11. Follow Steps below to install Java 17 on CentOS/linux.

• • Update before installing any new program

sudo yum -y update

• • Install Java 17

sudo yum install java-17-openjdk

• • Verify Java is Installed

java -version

Sample output:

Image Added

• MariaDB 10.11

Follow below steps to install and configure MariaDB on CentOS/linux

• • All the packages need to be up-to-date. Use the following command to update your packages.

    Code Block
    language bash
    sudo yum update

    Create a new repo file for the latest version.

    Code Block
    language bash
    vi /etc/yum.repos.d/MariaDB.repo

    Copy and paste the following contents into the /etc/yum.repos.d/mariadb.repo file.

    Code Block
    [mariadb] name = MariaDB baseurl = http://yum.mariadb.org/10.11/centos7-amd64 gpgkey=https://yum.mariadb.org/RPM-GPG-KEY-MariaDB gpgcheck=1

    To exit and save the Vim file, type :wq and press Enter.

  • Install the Latest Version of MariaDB

Install 10.11 of MariaDB and the most common packages, using the command below.

sudo yum install MariaDB-server galera-4 MariaDB-client MariaDB-shared MariaDB-backup MariaDB-common

• • Start MariaDB

    Start the MariaDB service with this command.

    Code Block
    language bash
    sudo systemctl start mariadb

    To set MariaDB to start automatically when the VM boots up, use the following command.

    Code Block
    language bash
    sudo systemctl enable mariadb

    Check the current status of MariaDB using this command.

    Code Block
    language bash
    sudo systemctl status mariadb

    Check the currently installed MariaDB version with this command.

    Code Block
    language bash
    sudo mysql -u root -p -V

• Tomcat 9.0.XX

• Download: https://tomcat.apache.org/download-80.cgi
• Setup: https://tomcat.apache.org/tomcat-8.5-doc/setup.html

Follow below Steps to setup Tomcat server  on CentOs/linux.

• • Download
Apache
• • Tomcat
archive file
• • 9 from
 Apache Tomcat Download Webpage. You can use below wget command to download it. 

             $ wget <Apache Tomcat 8 archive file link>

Example:

Image Removed

• After competed download extract archive file in /tmp directory and move to the proper location as per your need.

Example:

...

• • the Apache Tomcat Archive

wget -c https://downloads.apache.org/tomcat/tomcat-9/v9.0.85/bin/apache-tomcat-9.0.85.tar.gz

• • Extract the Tomcat archive to the directory in which you want to deploy the Automatics Tools

    Code Block
    language bash
    sudo tar -xvf apache-tomcat-9.0.85.tar.gz -C /opt/automatics/

  • Navigate to the tomcat file path and run ./bin/startup.sh cmd to start the tomcat server.

Sample Output:

...

Image Added

Maven – 3

Maven is the tool used for building and managing Device Manager project. Please follow the below links to download and install Maven:

• Download: https://maven.apache.org/download.cgi
• Installation: https://maven.apache.org/install.html

Following page will provide the detailed steps to setup maven.

Automatics Orchestration Setup#Maven3

Device Manager Back End Server

Device Manager Server is used REST API based tool to manage different device details , add device details, & edit device details, add device groups etc. Device Manager UI is an application for visualizing and perform actions on different functionalities of device manager backend server.

Please refer below link to bring up know more about device manager setup and deployment.

Device Manager Deployment Document

Environment Setup

Following are the steps to be followed to setup Device Manager UI and its dependent software's in a Machine:

Build Device Manager UI .war file

...

To do this follow the below steps:

• Pull the latest Device Manager UI project from the repository link : https://code.rdkcentral.com/r/admin/repos/rdk/tools/device-manager-ui.
• After completing the pull, go the resources folder in the device manager

...

• project, and add

...

• DeviceManager URL in application.properties.(device-manager-ui\src\main\

...

• resources).

Example:

Image Added        

• Now navigate to the project Home folder and run the command “mvn clean install”.
• This will build DeviceManagerUI.war file of device-manager-ui in the folder “project_home/target”.

Deploy Device Manager UI application

Device Manager application should be deployed in Tomcat server (ver 8.5 or above). Follow the below steps to deploy the application.

1. Copy DeviceManagerUI.war file from “project_home/target” to “TOMCAT_HOME/webapps” folder.

...

2. If you need to run the application tomcat server in a port other than localhost: 8080 host, please follow the below steps to update in application.properties filechange the same.
   • Navigate to resource folder in device manager project(device-manager\src\main\resource) folder.
   • Open application.properties and update springfox.documentation.swagger.v2.host={protocol}:{host:port} value with selected port of your choice.
3. Now navigate to the project Home folder and run the command “mvn clean install”.
This will build device-manager-1.0.0-SNAPSHOT.war file of device-manager server in the folder “project_home/target”.
4. • the folder “TOMCAT_HOME/conf”.
   • Open server.xml and change the connector port in this file from 8080 to an available port of your choice. If another tomcat is running the same machine then change the DEFAULT Tomcat server SHUTDOWN port from 8005 to another available port. If you dont need to a SHUTDOWN port for tomcat then change the default port from 8005 to “-1”.
5. To start Device Manager application go to “TOMCAT_HOME/bin” folder and run sh or startup.bat (if its running on Microsoft windows) script.
6. To verify server logs check “TOMCAT_HOME/logs/catalina.out” file.

• To launch Device Manager application go to the URL : “{protocol}://{host:port}/DeviceManagerUI/login.html“

Image Added

• For the first time, login with username as "admin" without password.
• on success login user will be navigated to manage devices pages.

Following page will provide more information on device manager ui

Device Manager UI User Manual