RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
Table of Contents |
---|
Background Color | ||
---|---|---|
| ||
Introduction |
Device Manager is an application to manage different devices by fetching the device details, adding devices, adding device groups, managing device reservations etc.
This document provides the deployment steps for setting up Device Manager server and all its dependencies.
For setting up this server the below applications or tools should be available in the server machine:
Background Color | ||
---|---|---|
| ||
Prerequisites |
The below software should be installed and available for running Device Manager 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
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
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.
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
Tomcat – 8 - Ver above v8.5
Tomcast 8 is required to deploy Device Manager server. Tomcat server installation file and setup documents can be found in the below links:
Follow below Steps to setup Tomcat server on CentOs/linux.
Download Apache Tomcat archive file from Apache Tomcat Download Webpage. You can use below wget command to download it.
$ wget <Apache Tomcat 8 archive file link>
Example:
Example:
Sample Output:
Maven – 3
Maven is the tool used for building and managing Device Manager project. Please follow the below links to download and install Maven:
Following page will provide the detailed steps to setup maven.
Automatics Orchestration Setup#Maven3
Background Color | ||
---|---|---|
| ||
Environment Setup |
Following are the steps to be followed to setup Device Manager Server and its dependent softwares in a Machine:
After installation of My SQL DB, connect to DB using MySQL command line tool.
1.Create a database with name 'device_manager'.
DB creation command :
Background Color | ||
---|---|---|
| ||
mysql> create database device_manager; mysql> use device_manager; -- For connecting to device_manager DB |
2.For creating all the tables required for Device Manager server, excecute the script 'sql' available with Device Manager source code inside 'device-manager\src\main\resources'.
Excecute Table creation script:
If already connected to 'device_manager' DB
Background Color | ||
---|---|---|
| ||
mysql> source <<path to 'Device_Manager_DB.sql' file>> |
To connect to 'device_manager' DB and run table creation scripts
Background Color | ||
---|---|---|
| ||
mysql -u root -p device_manager < Device_Manager_DB.sql |
3.Check whether all the tables are created successfully in DB, run the below command after connecting to 'device_manager' DB.
Background Color | ||
---|---|---|
| ||
mysql> show tables; |
Build the .war file of Device Manager server using Maven 3 and JDK 8.
To do this follow the below steps:
Device Manager application should be deployed in Tomcat server (ver 8). Follow the below steps to deploy the application.
To verify Device Manager application go to the URL : “{protocol}://{host:port}/DeviceManager/deviceCategory/all“
If DeviceManager is already deployed, but swagger API /Device/addDeviceUsingPOST not displaying following fields, then we have to upgrade Device Manager to configure connected client details.
Steps to upgrade Device Manager
Background Color | ||
---|---|---|
| ||
Swagger Documentation |
Swagger UI is an tool which can be used to visualize and try out all the APIs of a web application. Swagger UI is integrated to Device Manager application and it could be used to visualize all the APIs in this application and Swagger UI can be used to invoke all the APIs in this application.
Device Manager documentation and Tryout feature can used by going to the URL : “{protocol}://{host:port}/DeviceManager/swagger-ui.html