X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=test%2Fcr%2FREADME.md;h=a745529d9592255df159d2f60aaff117ebb512c5;hb=2479d8eeffbf064eaa3e11138c80d2368b386157;hp=c00f539ec408fbb567decbde6abc3d1e7bfb4367;hpb=330db2ab9b62777a96450527eb1978e15986a0d4;p=nonrtric.git
diff --git a/test/cr/README.md b/test/cr/README.md
index c00f539e..a745529d 100644
--- a/test/cr/README.md
+++ b/test/cr/README.md
@@ -1,8 +1,8 @@
# callback receiver - a stub interface to receive callbacks
The callback receiver is intended for function tests to simulate a RAPP.
-The callback receiver exposes the read and write urls, used by the agent, as configured in service.
-The callback receiver receives notifications from PMS when synchronization happens between PMS and RICs. However, the callback receiver can be uses to receive any json payload from any source.
+The callback receiver exposes the read and write urls, used by the a1pms, as configured in service.
+The callback receiver receives notifications from A1PMS when synchronization happens between A1PMS and RICs. However, the callback receiver can be uses to receive any json payload from any source.
## Ports and certificates
@@ -23,7 +23,7 @@ The control interface can be used by any test script.
The following REST operations are available:
>Send a message to CR
-This method puts a request message from PMS to notify that sychronization between PMS and certain RIC happens.
+This method puts a request message from A1PMS to notify that sychronization between A1PMS and certain RIC happens.
```URI and payload, (PUT or POST): /callbacks/ ```
```response: OK 200 or 500 for other errors```
@@ -48,7 +48,8 @@ There are a number of counters that can be read to monitor the message processin
```/counter/fetched_callbacks``` - The total number of fetched callbacks
```/counter/current_messages``` - The current number of callback messages waiting to be fetched
All counters also support the query parameter "id" to fetch counter for one individual id, eg ```/counter/current_messages?id=my-id```
-
+An additional counter is available to log remote hosts calling the server
+```/counter/remote_hosts``` - Lists all unique ip/host name that has sent messages on the callback endpoint
### Build and start
@@ -76,7 +77,7 @@ eg:
In 'docker-compose.yml', use field:
>```volumes: - ./certificate:/usr/src/app/cert:ro```
-The script ```cr-build-start.sh``` do the above two steps in one go. This starts the callback-receiver container in stand-alone mode for basic test.
If the callback-receiver should be executed manually with the agent, replace docker run with this command to connect to the docker network with the correct service name (--name shall be aligned with the other components, i.e. the host named given in all callback urls).
+The script ```cr-build-start.sh``` do the above two steps in one go. This starts the callback-receiver container in stand-alone mode for basic test.
If the callback-receiver should be executed manually with the a1pms, replace docker run with this command to connect to the docker network with the correct service name (--name shall be aligned with the other components, i.e. the host named given in all callback urls).
>```docker run --rm -it -p 8090:8090 -p 8091:8091 --network nonrtric-docker-net --name callback-receiver callback-receiver```
>Start the image on http only