Xconf Server-User Guide for configuration and feature Validation

Pre-requisite

• Access to Raspberry Pi terminal.
• Access to Xconf server from browser https://xconf.rdkcentral.com:9093/admin/ 
  • For Admin mode(read and writ permission) -> username : admin, password: RdkXcadm$2120
  • For User mode(only read mode) -> username: user ,password: RdkXcusr@2210          

• Disable log rotation in RPI using below command. (This is optional)
  • systemctl disable rdkbLogMonitor
  • reboot 

Admin UI: Common Configuration

• Define Environments

           Flow:  Xconf-server -> Common -> Environments
           Click on Create Button.

           Click on Create, Enter the ID and Description fields, click on Save.
           ID : <Unique Identifier>  ; Description : <Description>

• Define Models

          Flow: Xconf-server -> Common -> Models
          Click on Create, Enter the ID and Description fields, click on Save.

• Define Mac List

          Flow: Xconf-server -> Common -> MAC Lists -> Create -> Add your Device MAC address -> Save.

• Define IP List

          Flow: Xconf-server -> Common -> IP Lists -> Create-> Create -> Add your device IP address -> Save.

Feature Validation: LogUpload

• In Raspberry Board, add the server details for log upload.
• Configure the Bellow details to dcm.properties and comment out the other details .

            File :  /etc/dcm.properties

           LOG_SERVER=xconf.rdkcentral.com
           DCM_LOG_SERVER=https://xconf.rdkcentral.com/xconf/logupload.php
           DCM_LOG_SERVER_URL=https://xconf.rdkcentral.com:9092/loguploader/getSettings
           DCM_SCP_SERVER=xconf.rdkcentral.com
           DCM_LA_SERVER_URL=https://xconf.rdkcentral.com/xconf/logupload.php

• In Xconf UI Change Application to stb in top right corner of the window.

• Defining the Upload repositories

          Flow: Xconf-server -> DCM -> Upload repository -> create ->save
          Name: <Unique Identifier>
          Description: <Unique Identifier>
          URL:  HTTP: http://35.161.239.220/xconf/telemetry_upload.php

• Defining the formula

           Flow: Xconf-server -> DCM -> Formulas -> Create
           Name: <unique name for log upload>
           Description: <Short description for log upload>
           Percentage: 100
           Build condition:  estbMacAddress IS <MAC Address> OR estbIP IS <IP Address> 
                                    (or)  estbMacAddress IS <MAC Address>  AND model is <Model Name>   (Model name is already configured under Common Tab)

• As soon as the formula is saved, then a ‘define Settings’ tab with ‘Create Device Settings’, ‘Create log settings’, Create VOD settings’ will be available.

• Click on 'Create Device Settings' tab and edit the Device Settings.

• Click on ‘Create Log Update setting’ and Edit the Log upload Setting (Create schedule & add the upload repository created beforehand).

           Name: Enter the name given during Log Upload Formula Creation.
           Note: The formula will be effective only if we select 'Are Settings Active' option to 'true' in 'Create Device Settings' and 'Log Upload settings'.

Verification at Xconf UI.

• Test Page for Log Upload
  Flow: Xconf-Server -> DCM ->Test Page 

• Parameters: give a parameter that will match the one of the formulas that you have created.
  • estbMacAddress < MAC Address> or
  • estbIP <IP Address>
  • model <Model Name>

Log Upload: Client End Verification (In RPI)

• Remove already existing DCM Settings config files under /tmp
             rm -rf /tmp/DCM*
• Restart the log upload service in Raspberry Pi using the command
            systemctl restart CcspTelemetry.service
            root@RaspberryPi-Gateway:~# systemctl restart CcspTelemetry.service
• Verify through CURL command
             curl -i 'https://xconf.rdkcentral.com:9092/loguploader/getSettings?estbIP=<IP ADDRESS>'
             or
             curl -i 'https://xconf.rdkcentral.com:9092/loguploader/getSettings?estbMacAddress=<MAC-Address>'

• Sample Output:

• On successful Log upload, conf file will be created under /tmp directory. This file contains the details of log upload settings which are already configured in the server.
            File : /tmp/DCMSettings.conf

• Verify the logs in /rdklogs/logs/dcmscript.log file
• The log file contains the details of
  • Service status, tftp details, reboot flag , check on reboot flag ,
  • Upload settings details – location, protocol.
• Shows list of files which are to be uploaded to the server as a tar file (logs will be zipped and creates a tar file on every bootup/service restart), Backup folder details (/rdklogs/logs/PreviousLogs_backup)
• HTTP request processing status.   

• Json response on server