X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=test%2Fprodstub%2FREADME.md;h=6128b9a45a1f612d127f02bccfb30f002a91455c;hb=b188e12cc1b4be627ae6f8f424f06c38ffb89804;hp=116469fd96f4d6063889c64b745b500d546f4a4a;hpb=330db2ab9b62777a96450527eb1978e15986a0d4;p=nonrtric.git diff --git a/test/prodstub/README.md b/test/prodstub/README.md index 116469fd..6128b9a4 100644 --- a/test/prodstub/README.md +++ b/test/prodstub/README.md @@ -2,7 +2,7 @@ The producer stub is intended for function tests of simulate data producers. The simulator handles the callbacks for supervision of producers as well as create/update and delete jobs. -As an intial step, the indended job and producers, with supported types, are setup (armed) in the simulator. +As an initial step, the intended job and producers, with supported types, are setup (armed) in the simulator. In addition, specific response codes can configured for each callback request. ## Ports and certificates @@ -16,7 +16,7 @@ The certificate and key shall be placed in the same dir and the dir shall be mou | 8093 | https | The dir cert contains a self-signed cert. Use the script generate_cert_and_key.sh to generate a new certificate and key. The password of the certificate must be set 'test'. -The same urls are availables on both the http port 8092 and the https port 8093. If using curl and https, the flag -k shall be given to make curl ignore checking the certificate. +The same urls are available on both the http port 8092 and the https port 8093. If using curl and https, the flag -k shall be given to make curl ignore checking the certificate. ### Prodstub interface @@ -42,16 +42,16 @@ The following REST operations are available: >Arm a job create
This method arms a job for creation and sets an optional response code for create/update
-```URI and payload, (PUT): /arm/create//[?response=]```
+```URI and payload, (PUT): /arm/create//[?response=]```
```response: 200 or 400 for other errors``` >Arm a job delete
This method arms a job for deletion and sets an optional response code for delete
-```URI and payload, (PUT): /arm/delete//[?response=]```
+```URI and payload, (PUT): /arm/delete//[?response=]```
```response: 200 or 400 for other errors``` >Arm a producer supervision
This method arms a supervision and sets an optional response code for supervision calls
-```URI and payload, (PUT): /arm/delete/[?response=]```
+```URI and payload, (PUT): /arm/delete/[?response=]```
```response: 200 or 400 for other errors``` >Arm a type for a producer
@@ -121,12 +121,12 @@ 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 ->Start the container without specifing external certificates:
+>Start the container without specifying external certificates:
```docker run --rm -it --p 8092:8092 -p 8093:8093 producer-stub``` It will listen to http 8092 port and https 8093 port(using default certificates) at the same time. -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"``` @@ -136,7 +136,7 @@ eg: In 'docker-compose.yml', use field:
>```volumes: - ./certificate:/usr/src/app/cert:ro``` -The script ```prodstub-build-start.sh``` do the build and docker run in one go. This starts the stub container in stand-alone mode for basic test.
If the producer-stub 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 the same as configured in consul for the read and write streams). +The script ```prodstub-build-start.sh``` do the build and docker run in one go. This starts the stub container in stand-alone mode for basic test.
If the producer-stub 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 the same as configured in consul for the read and write streams). ```docker run --rm -it -p 8092:8092 -p 8093:8093 --name producer-stub producer-stub``` ### Basic test