X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=test%2Fcr%2FREADME.md;h=e93fd1be1042edaf94ab9b2cb450460742dc2ce5;hb=b188e12cc1b4be627ae6f8f424f06c38ffb89804;hp=c00f539ec408fbb567decbde6abc3d1e7bfb4367;hpb=cd16500f7dece0971c6c859e8273c00895a76210;p=nonrtric.git
diff --git a/test/cr/README.md b/test/cr/README.md
index c00f539e..e93fd1be 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,12 +23,12 @@ 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 synchronization between A1PMS and certain RIC happens.
```URI and payload, (PUT or POST): /callbacks/ ```
```response: OK 200 or 500 for other errors```
>Fetch one message for an id from CR
-This method fetches the oldes message for an id, and removes the message.
+This method fetches the oldest message for an id, and removes the message.
```URI and payload, (GET): /get-event/```
```response: 200 or 500 for other errors```
@@ -37,7 +37,7 @@ This method fetches all message in an array for an id, and removes all messages.
```URI and payload, (GET): /get-all-events/```
```response: 200 or 500 for other errors```
->Dump all currently wating callback messages in CR
+>Dump all currently waiting callback messages in CR
This method fetches all message in an array for an id. Messages are left intact in the CR.
```URI and payload, (GET): /db```
```response: 200```
@@ -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
@@ -66,7 +67,7 @@ file "key.crt" is the key file
file "generate_cert_and_key.sh" is a shell script to generate certificate and key
file "pass" stores the password when you run the shell script
-This certificates/key can be overriden by mounting a volume when using "docker run" or "docker-compose"
+This certificates/key can be overridden by mounting a volume when using "docker run" or "docker-compose"
In 'docker run', use field:
>```-v "$PWD/certificate:/usr/src/app/cert"```
@@ -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