Skip to content

Commit 55e97c7

Browse files
amit-62amit-62
committed
FRI Updated
1 parent 54d73c7 commit 55e97c7

2 files changed

Lines changed: 155 additions & 0 deletions

File tree

‎fri/README.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# The Control-Core FRI for Closed-Loop Neuromodulation Control Systems
2+
3+
The Control-Core File Receiving Interface (FRI) is built with is Python-3.10. It is the core component that makes the distributed executions a reality in the Control-Core framework.
4+
5+
6+
# Building FRI Container
7+
8+
Connect to the Server VM, assuming x.x.x.x to be the IP address of your server.
9+
````
10+
$ ssh -i "controlcore.pem" ubuntu@x.x.x.x
11+
````
12+
Perform Git clone if this is the first time you are configuring the Server
13+
````
14+
$ git clone git@github.com/ControlCore-Project/concore.git
15+
````
16+
17+
First build the Docker Container of the FRI.
18+
````
19+
$ git pull
20+
21+
$ sudo docker build -t fri .
22+
````
23+
24+
# Running Control-Core FRI with Kong as containers
25+
26+
If you are already running FRI, make sure to stop and clear existing FRI container as it is likely conflict with the port. If there is Kong gateway running in default ports, stop and clear it too.
27+
````
28+
$ docker stop fri
29+
$ docker rm fri
30+
$ docker stop kong
31+
$ docker rm kong
32+
````
33+
34+
Start and configure Cassandra container for Kong API.
35+
````
36+
$ docker run -d --name kong-database \
37+
-p 9042:9042 \
38+
cassandra:3
39+
40+
41+
$ docker run --rm \
42+
--link kong-database:kong-database \
43+
-e "KONG_DATABASE=cassandra" \
44+
-e "KONG_PG_HOST=kong-database" \
45+
-e "KONG_PG_USER=kong" \
46+
-e "KONG_PG_PASSWORD=kong" \
47+
-e "KONG_CASSANDRA_CONTACT_POINTS=kong-database" \
48+
kong kong migrations bootstrap
49+
````
50+
51+
Start Kong
52+
````
53+
$ docker run -d --name kong \
54+
--link kong-database:kong-database \
55+
-e "KONG_DATABASE=cassandra" \
56+
-e "KONG_PG_HOST=kong-database" \
57+
-e "KONG_PG_PASSWORD=kong" \
58+
-e "KONG_CASSANDRA_CONTACT_POINTS=kong-database" \
59+
-e "KONG_PROXY_ACCESS_LOG=/dev/stdout" \
60+
-e "KONG_ADMIN_ACCESS_LOG=/dev/stdout" \
61+
-e "KONG_PROXY_ERROR_LOG=/dev/stderr" \
62+
-e "KONG_ADMIN_ERROR_LOG=/dev/stderr" \
63+
-e "KONG_ADMIN_LISTEN=0.0.0.0:8001, 0.0.0.0:8444 ssl" \
64+
-p 80:8000 \
65+
-p 8443:8443 \
66+
-p 8001:8001 \
67+
-p 8444:8444 \
68+
kong
69+
````
70+
71+
Start FRI container
72+
````
73+
$ nohup sudo docker run --name fri -p 8090:8081 fri > controlcore.out &
74+
````
75+
76+
Delete if there is a previously configured Kong service. If not, skip this step. First you need to find the ID-VALUE for the route with a GET command before deleting the route and service.
77+
````
78+
$ curl -X GET "http://localhost:8001/services/fri/routes"
79+
````
80+
Use the ID output from above to issue the delete command as below (issue this only if you have a previous conflicting service definiton in kong. Otherwise, skip this step):
81+
````
82+
$ curl -X DELETE "http://localhost:8001/services/fri/routes/ID-VALUE"
83+
84+
$ curl -X DELETE "http://localhost:8001/services/fri/"
85+
````
86+
87+
Define Kong Service and Route.
88+
89+
First Configure a Kong service, replacing the variable "private-ip" with the private IP address of your server below.
90+
````
91+
$ curl -i -X POST --url http://localhost:8001/services/ --data 'name=fri' --data 'url=http://private-ip:8090'
92+
````
93+
Then configure route to the service
94+
````
95+
$ curl -i -X POST --url http://localhost:8001/services/fri/routes --data 'paths=/'
96+
````
97+
98+
Now, controlcore.org is routed through the Kong APIs.
99+
100+
101+
# Troubleshooting the FRI
102+
103+
Connect to the Server VM
104+
````
105+
$ ssh -i "controlcore.pem" ubuntu@x.x.x.x
106+
````
107+
Check the Server logs.
108+
````
109+
$ tail -f controlcore.out
110+
````
111+
or
112+
````
113+
$ sudo docker logs fri -f
114+
````
115+
Find the FRI docker container
116+
````
117+
$ sudo docker ps
118+
````
119+
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
120+
dfdd3b3d3308 fri "python main.py" 38 minutes ago Up 38 minutes 0.0.0.0:80->80/tcp fri
121+
122+
Access the container
123+
````
124+
$ sudo docker exec -it dfdd /bin/bash
125+
````
126+
127+
128+
129+
# Citing the CONTROL-CORE FRI
130+
131+
If you use the CONTROL-CORE FRI in your research, please cite the below paper:
132+
133+
* Kathiravelu, P., Arnold, M., Fleischer, J., Yao, Y., Awasthi, S., Goel, A. K., Branen, A., Sarikhani, P., Kumar, G., Kothare, M. V., and Mahmoudi, B. **CONTROL-CORE: A Framework for Simulation and Design of Closed-Loop Peripheral Neuromodulation Control Systems**. In IEEE Access. March 2022. https://doi.org/10.1109/ACCESS.2022.3161471

‎fri/service_config.sh‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#!/bin/bash
2+
3+
SERVICES=('init' 'ctl' 'pm' 'cleanup')
4+
for service in "${SERVICES[@]}"
5+
do
6+
name="name="$service
7+
path="paths=/"$service
8+
service_path="url=http://private-ip:8090/"$service
9+
route_path="http://localhost:8001/services/"$service"/routes"
10+
plugin_path="http://localhost:8001/services/"$service"/plugins"
11+
echo "Name is, $name"
12+
echo "Path is, $path"
13+
echo "Service path is, $service_path"
14+
echo "Route path is, $route_path"
15+
echo "Plugin path is, $plugin_path"
16+
echo "Creating Service, $service..."
17+
curl -i -X POST --url http://localhost:8001/services/ --data $name --data $service_path
18+
echo "Creating route for $service..."
19+
curl -i -X POST --url $route_path --data $path
20+
echo "Creating apikey-based authentication for $service..."
21+
curl -X POST $plugin_path --data "name=key-auth" --data "config.key_names=apikey"
22+
done

0 commit comments

Comments
 (0)