diff options
Diffstat (limited to 'test/mocks/pnfsimulator')
| -rw-r--r-- | test/mocks/pnfsimulator/README.md | 38 |
1 files changed, 36 insertions, 2 deletions
diff --git a/test/mocks/pnfsimulator/README.md b/test/mocks/pnfsimulator/README.md index 5b9871a18..e6c076ffa 100644 --- a/test/mocks/pnfsimulator/README.md +++ b/test/mocks/pnfsimulator/README.md @@ -1,2 +1,36 @@ -# pnf-simulator -Generate VES event related to PNF integration. +# PNF Simulator +Simulator that generates VES events related to PNF PNP integration. + +##Downloading simulator +Official version of simulator can be downloaded for public ONAP docker registry as image. +*docker login -u anonymous -p anonymous nexus3.onap.org:10003* + +Another option is to checkout PNF Simulator project from ONAP Git repository. + +##Usage of simulator + +###Configuration +The configuration for simulator is stored in */config/config.json* file. +It contains all parameters for simulation such as duration time,interval between messages and values of the configurable fields of VES message. +If you want to change duration or value of message sending to VES collector you just need to edit this file. +The message that is being sent to VES is built inside the simulator and it's content can be found in log of the simulator. + +###Running simulator +The recommended way is to checkout PNF Simulator project from ONAP Git repository and use *simulator*.sh script +If you copy *simulator.sh* script to another location, keep in mind to copy also *docker-compose.yml* and directories: *config,json_schema and netconf*. +In order to run simulator, invoke ./simulator.sh start +Script downloads if necessary needed Docker images and runs instances of these images. + +###Logging +It is possible to get access to logs by invocation of *./simulator.sh* logs. +The content of the logs is related to the last simulator run. +Every start of simulator will generate new logs. + + + + + + + + + |