In this document, we are planning to bring up xconfadmin, xconfui, xconfwebconfig, cassandra in four different containers and checking the connectivity in them. This is documented based on the docker bringup in Ubuntu 24.04 machine

Pre-requisite

• Install docker in your machine

$ docker --version
Docker version 27.5.1, build 27.5.1-0

• Make sure docker compose plugin is working by checking below command, not docker-compose (this is old version v1)

$ docker compose version
Docker Compose version v2.36.2

Steps to bring up

Tree structure of the code details https://github.com/rdkcentral/rdk-cloud-container-config is as follows.

├── cassandra
│   └── db
│       ├── db_create_tables.cql
│       └── db_init.cql
├── docker-compose.yaml
├── init-cassandra.sh
├── xconfadmin
│   ├── CONTRIBUTING.md
│   ├── COPYING -> LICENSE
│   ├── Dockerfile
│   ├── LICENSE
│   └── config
│       └── sample_xconfadmin.conf
├── xconfui
│   ├── CONTRIBUTING.md
│   ├── COPYING -> LICENSE
│   ├── Dockerfile
│   ├── LICENSE
│   └── config
│       └── sample_xconfui.conf
└── xconfwebconfig
    ├── CONTRIBUTING.md
    ├── COPYING -> LICENSE
    ├── Dockerfile
    ├── LICENSE
    └── config
        └── sample_xconfwebconfig.conf

•  Create a folder in your workspace you wish to run the xconf modules
•  Copy the  docker-compose.yaml  file  to the folder you have created
• Copy the init_cassandra.sh to the folder you have created
• Clone the xconfadmin repo to your working folder 
  •  

    $ git clone https://github.com/rdkcentral/xconfadmin.git <working folder name>  ( If the folder name is different, make sure the xconfadmin is the folder name)

•  copy the https://github.com/rdkcentral/rdk-cloud-container-config/pull/3/files#diff-67e5e77dc4be6981749eeec371b56a358ad455b182a7720841fbdc6dc57ca7d0 https://github.com/rdkcentral/rdk-cloud-container-config/blob/main/talaria/Dockerfile dockerfile and  https://github.com/rdkcentral/rdk-cloud-container-config/blob/main/talaria/talaria.yaml yaml  from the attachment to the talaria folder
•  Clone the scytale repo to your working folder

  •  $ git clone https://github.com/xmidt-org/scytale <working folder name>( If the folder name is different, make sure the scytale is the folder name)

• Replace  https://github.com/rdkcentral/rdk-cloud-container-config/blob/main/scytale/Dockerfile dockerfile and https://github.com/rdkcentral/rdk-cloud-container-config/blob/main/scytale/scytale.yaml yaml from the attachment to the scytale folder
• git clone tr1d1um module to the folder you have created

  • $ git clone https://github.com/xmidt-org/tr1d1um <working folder name> ( If the folder name is different, make sure the tr1d1um is the folder name)

• Replace https://github.com/rdkcentral/rdk-cloud-container-config/blob/main/tr1d1um/Dockerfile dockerfile and https://github.com/rdkcentral/rdk-cloud-container-config/blob/main/tr1d1um/tr1d1um.yaml yaml from the attachment to the tr1d1um folder
• Follow this steps for generating basic auth token WebPA (Xmidt) Ubuntu Reference Setup#Generatingaauthtoken and replace in all basic authentication 
• Replace  your server IP in these sections 

./tr1d1um/tr1d1um.yaml:12:server: "<public IP>"
./tr1d1um/tr1d1um.yaml:305:targetURL: http://<public IP>:6300/api/v2
./talaria/talaria.yaml:9:server: "public IP"
./scytale/scytale.yaml:9:server: "public IP"
./scytale/scytale.yaml:214:  endpoints: ["http://<public IP>:8080/api/v3/device/send"]
./scytale/scytale.yaml:370:    - http://<public IP>:6300

• Run docker compose 

$ docker compose up --build -d 

•  check created containers  are running successfully

$ docker ps
CONTAINER ID   IMAGE     COMMAND                  CREATED      STATUS      PORTS                                                                                                      NAMES
57dd3ec297cb   tr1d1um   "/etc/tr1d1um/tr1d1um"   3 days ago   Up 3 days   0.0.0.0:6100-6103->6100-6103/tcp, :::6100-6103->6100-6103/tcp                                              tr1d1um
b8a3dc0d915b   scytale   "/etc/scytale/scytale"   3 days ago   Up 3 days   0.0.0.0:6300-6303->6300-6303/tcp, :::6300-6303->6300-6303/tcp                                              scytale
54082f1f8526   talaria   "/etc/talaria/talaria"   3 days ago   Up 3 days   0.0.0.0:6200-6204->6200-6204/tcp, :::6200-6204->6200-6204/tcp, 0.0.0.0:8080->8080/tcp, :::8080->8080/tcp   talaria

• Verify docker images are created successfully

$ docker images
REPOSITORY   TAG       IMAGE ID       CREATED      SIZE
tr1d1um      latest    aa9d55a69a6c   3 days ago   71.2MB
scytale      latest    137bad8f272c   3 days ago   82.9MB
talaria      latest    884a6d178222   3 days ago   74.9MB

Note :  For this bringup, talaria port is modified to 8080, rest of the ports used are same as in the repo.

For errors, can be checked by $ docker logs <containerid>

Testing

GET Parameter

SET Parameter

List of connected Devices

AUTH_TOKEN       : Basic base64 encoded auth token or SAT (if enabled).

WEBPA-URL          : URL of Tr1d1um service in IP:PORT format.

DEVICE_MAC        :  MAC address of the CPE device.

PARAMETER         : GET/SET Parameter that need to be requested.