Software Requirements (Reference setup)

Installation of dependencies

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.

Steps to install Open JDK

• sudo apt-get update

• sudo apt-get install openjdk-8-jdk

Check your installation using the command : java  -version

Install Maven (Version 3.6.0)

Maven version should be 3 +. 

To install maven follow these steps:

• sudo apt update

• sudo apt install maven

• Check the installation using : mvn -version

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

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

• schema.cql file is available in 'xconf-angular-admin/src/test/resources/schema.cql'. We can use this cql file to create a corresponding schema . Open another terminal , step into apache-cassandra-3.11.9 folder and  run the following command

          bin/cqlsh -f  { path-to-the-schem.cql file}

         eg : bin/cqlsh  -f ~/xconf/xconfserver/xconf-angular-admin/src/test/resources/schema.cql

• To check if tables are created successfully, we can use cqlsh 
• To start cqlsh, step into cassandra folder and enter the command:
  

   bin/cqlsh 

• It gives cassandra cqlsh prompt as output. To check if all the tables are present enter the following commands in cqlsh prompt :

          USE "demo"; 

          DESCRIBE KEYSPACE;

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

Configuration and Service startup

 Start Cassandra Service

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

          cd apache-cassandra-3.11.9
          sudo bin/cassandra

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

          bin/nodetool status

Configure and Start Application Services

Build Project

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

cd ~xconf/xconfserver