Software Requirements (Reference setup)

Installation of dependencies

1. Install Java JDK

Java JDK version should be 1.8+ for now [Note that it must be 1.8.x for now]. Get the supported version from Oracle or use the OpenJDK packages.

...

Check your installation using the command : java  -version

2. Install Maven (Version 3.6.0)

Maven version should be 3 +. 

...

• sudo apt update

• sudo apt install maven

• Check the installation using : mvn -version

3. Download xconf server code

We can download the latest xconfserver code from https://github.com/rdkcentral/xconfserver. The latest version of the code is available in main branch.

• Create a folder : mkdir xconf

• Step into the folder cd xconf/

• git clone https://github.com/rdkcentral/xconfserver.git -b main

4. Install and setup Cassandra(Version 3.11.9)

Install Cassandra

To install Cassandra , follow the below steps

• Download the tarball file for the version 3.11.9 : 

  wget -c https://archive.apache.org/dist/cassandra/3.11.9/apache-cassandra-3.11.9-bin.tar.gz  
  

• Unpack the tarball :  
  tar -xvf  apache-cassandra-3.11.9-bin.tar.gz
  
  

• Step into apache-cassandra-3.11.9 folder :

  cd apache-cassandra-3.11.9
  
  

• To start Cassandra, run the following command

  sudo bin/cassandra
  
  

• To verify that Cassandra is up and running, enter the following command :

  bin/nodetool status

Configure Cassandra

Note :  For the next step, make sure that python is installed. Because cqlsh is python based command line tool. If python is not installed , use this command : sudo apt install python2.7

...

• To exit from cqlsh prompt, we can use the command : quit

Configuration and Service startup

1. Start Cassandra Service

• To start an Xconf application, start the Cassandra server by executing the following commands:  
  

...

• Status of xconf server can be verified by using  the command

          bin/nodetool status

2. Configure and Start Application Services

a. Build Project

• Go to the xconf-server folder and run the following command to download all dependencies.

...

          mvn clean install

b. Configure Angular Admin UI

• For first time application deployment, create a "service.properties"  file under the path xconfserver/xconf-angular-admin/src/main/resources/service.properties with the following contents. The sample service.properties file will be available in xconf-angular-admin/src/test/resources/service.properties, the below content is taken from there and modified with change in cassandra port.

...

If the user wants only read permissions ,then enter username and password for the login are user and user respectively.

c. Configure DataService

• For first time application deployment, create a "service.properties"  file under the path xconfserver/xconf-dataservice/src/main/resources/service.properties with the following contents. The sample service.properties file will be available in xconf-dataservice/src/test/resources/service.properties, the below content is taken from there and modified with change in cassandra port.
  

  cassandra.keyspaceName=demo cassandra.contactPoints=127.0.0.1 cassandra.username= cassandra.password= cassandra.port=9042 cassandra.authKey= dataaccess.cache.tickDuration=60000 dataaccess.cache.retryCountUntilFullRefresh=10 dataaccess.cache.changedKeysTimeWindowSize=900000 dataaccess.cache.reloadCacheEntries=false dataaccess.cache.reloadCacheEntriesTimeout=1 dataaccess.cache.reloadCacheEntriesTimeUnit=DAYS dataaccess.cache.numberOfEntriesToProcessSequentially=10000 dataaccess.cache.keysetChunkSizeForMassCacheLoad=500 dataaccess.cache.changedKeysCfName=XconfChangedKeys4

  
  

• Step into xconf-dataservice folder
   

      cd ~xconf/xconfserver/xconf-dataservice

...

NOTE: To run the Admin UI and data service applications in background start jetty server as follows:

nohup mvn jetty:run &

Configuration and Validation of

...

services

Admin UI Common Configuration

Below steps will affect all the features in xconf system and should be configured after initial setup. Go to the steps given in site navigation step and press on create button to create new entries.

Define Environments

...

Feature Validation(RFC)

Configuration

RDK Feature control configuration can be added by adding below 2 sections

...

Verification

1. Verification of feature and feature rule via test page.

...

            }

        ]

    }

}

Client end verification (RPI)

Feature Validation (LogUpload)

Configuration

1. Create upload repository via DCM->Upload repository -> Create.   Here we can add where to configure the log upload, is the upload url and which protocol is used)

...

5.  Edit the Log upload Setting (Create schedule & Add the upload repository created beforehand.

Verification

1. Verification of log upload settings test page.

...

    "urn:settings:VODSettings:SRMIPList": null

}

Client end verification (RPI)

Feature Validation (Telemetry)

1. Telemetry configuration can be done by adding a permanent profile which contains below objects
   1. Upload repository
   2. Profile options (Header, content, frequency etc.)
2. Creating a targeting rule which is basically mapping the profile to a set of MAC/IP/Device etc.

Configuration

1. Create a permanent profile Telemetry - > Permanent Profiles -> Create

...

Verification

1. Verification of telemetry test page.

...

        "uploadRepository:uploadProtocol": "HTTP"

    }

}

Client end verification (RPI)

Feature Validation (Firmware update)

Please refer below links for firmware update

...

XConf - Configuring Firmware

Import and Export Feature

We can import and export all the configuration data from the UI itself.  This feature can be primarily used for transferring the configuration data from one xconfserver setup to the other one.

To export data from a page, Click on ‘Export All’ button in that page.  The configuration data will be downloaded as a json file.

Image Added

To import data,

1. Open the dropdown menu next to ‘Create’ button.
2. From the drop down menu, click on ‘Import’.
3. A new page will be displayed with option to browse the location of the json file to be imported. Select the file that need to be imported.
4. All the data from the file will be listed in the page.
5. Click on ‘Import All’ to import all data

Image Added