diff options
Diffstat (limited to 'docs/simulators')
| -rw-r--r-- | docs/simulators/nf_simulator.rst | 84 |
1 files changed, 42 insertions, 42 deletions
diff --git a/docs/simulators/nf_simulator.rst b/docs/simulators/nf_simulator.rst index 6353d7db9..9ba295a55 100644 --- a/docs/simulators/nf_simulator.rst +++ b/docs/simulators/nf_simulator.rst @@ -20,23 +20,23 @@ The simulator is expected to cover planned NF behaviour - receive the config cha NF Simulator code is stored in https://github.com/onap/integration-simulators-nf-simulator and all it's sub repos are: -* for VES Client - https://github.com/onap/integration-simulators-nf-simulator-ves-client -* for Netconf Server - https://github.com/onap/integration-simulators-nf-simulator-netconf-server -* for AVCN Manager - https://github.com/onap/integration-simulators-nf-simulator-avcn-manager -* for PM HTTPS Server - https://github.com/onap/integration-simulators-nf-simulator-pm-https-server +- for VES Client - https://github.com/onap/integration-simulators-nf-simulator-ves-client +- for Netconf Server - https://github.com/onap/integration-simulators-nf-simulator-netconf-server +- for AVCN Manager - https://github.com/onap/integration-simulators-nf-simulator-avcn-manager +- for PM HTTPS Server - https://github.com/onap/integration-simulators-nf-simulator-pm-https-server For above components have been prepared: -* docker images in ONAP Nexus: +- docker images in ONAP Nexus: - * VES Client image - nexus3.onap.org:10001/onap/org.onap.integration.nfsimulator.vesclient - * AVCN Manager image - nexus3.onap.org:10001/onap/org.onap.integration.nfsimulator.avcnmanager - * PM HTTPS Server image - nexus3.onap.org:10001/onap/org.onap.integration.nfsimulator.pmhttpsserver - * Netconf Server images - nexus3.onap.org:10001/onap/org.onap.integration.nfsimulator.netconfserver + - VES Client image - nexus3.onap.org:10001/onap/org.onap.integration.nfsimulator.vesclient + - AVCN Manager image - nexus3.onap.org:10001/onap/org.onap.integration.nfsimulator.avcnmanager + - PM HTTPS Server image - nexus3.onap.org:10001/onap/org.onap.integration.nfsimulator.pmhttpsserver + - Netconf Server images - nexus3.onap.org:10001/onap/org.onap.integration.nfsimulator.netconfserver -* example helm charts: +- example helm charts: - * `Helm charts <https://github.com/onap/integration-simulators-nf-simulator/tree/master/helm>`_ + - `Helm charts <https://github.com/onap/integration-simulators-nf-simulator/tree/master/helm>`_ **VES Client, Netconf Server and PM HTTPS Server can be used and deployed separately depending on needs.** @@ -49,19 +49,19 @@ Only AVCN Manger connects VES Client with Netconf Server in order to support O1 **What does it do?** - * Supports both basic auth and TLS CMPv2 method of authentication. - * Allows to turn on and turn off hostname, verification in SSL. - * Allows to send one-time event and periodic events, based on event templates. - * Exposes API to manage VES Client - * Provides template mechanism (Template is a draft event. Merging event with patch will result in valid VES event. + - Supports both basic auth and TLS CMPv2 method of authentication. + - Allows to turn on and turn off hostname, verification in SSL. + - Allows to send one-time event and periodic events, based on event templates. + - Exposes API to manage VES Client + - Provides template mechanism (Template is a draft event. Merging event with patch will result in valid VES event. Template itself should be a correct VES event as well as valid json object. ) - * Patching - User is able to provide patch in request, which will be merged into template. - * Simulator supports corresponding keywords in templates: RandomInteger(start,end), RandomPrimitiveInteger(start,end), RandomInteger, + - Patching - User is able to provide patch in request, which will be merged into template. + - Simulator supports corresponding keywords in templates: RandomInteger(start,end), RandomPrimitiveInteger(start,end), RandomInteger, RandomString(length), RandomString, Timestamp, TimestampPrimitive, Increment - * In place variables support - Simulator supports dynamic keywords e.g. #dN to automatically substitute selected phrases in defined json schema. - * Logging - Every start of simulator will generate new logs that can be found in docker ves-client container. - * Swagger - Detailed view of simulator REST API is available via Swagger UI - * History - User is able to view events history. + - In place variables support - Simulator supports dynamic keywords e.g. #dN to automatically substitute selected phrases in defined json schema. + - Logging - Every start of simulator will generate new logs that can be found in docker ves-client container. + - Swagger - Detailed view of simulator REST API is available via Swagger UI + - History - User is able to view events history. 2. Netconf Server: @@ -74,17 +74,17 @@ Only AVCN Manger connects VES Client with Netconf Server in order to support O1 Server allows to: - * install custom configuration models on start up. - * change configuration of that modules on runtime. - * use TLS custom certificates - * configure change subscription for particular YANG modules (Netconf server image run python application on the startup.) - * manage netconf server using REST interface, with endpoints: + - install custom configuration models on start up. + - change configuration of that modules on runtime. + - use TLS custom certificates + - configure change subscription for particular YANG modules (Netconf server image run python application on the startup.) + - manage netconf server using REST interface, with endpoints: - * GET /healthcheck returns 200 "UP" if server is up and running - * POST /readiness return 200 "Ready" if server is ready, if not, returns 503 "Not Ready" - * POST /change_config/<path:module_name> changes configuration ad returns 202 "Accepted" - * GET /change_history returns 200 and change history as json - * GET /get_config/<path:module_name> returns 200 and current configuration + - GET /healthcheck returns 200 "UP" if server is up and running + - POST /readiness return 200 "Ready" if server is ready, if not, returns 503 "Not Ready" + - POST /change_config/<path:module_name> changes configuration ad returns 202 "Accepted" + - GET /change_history returns 200 and change history as json + - GET /get_config/<path:module_name> returns 200 and current configuration 3. AVCN Manager: ---------------- @@ -103,9 +103,9 @@ Only AVCN Manger connects VES Client with Netconf Server in order to support O1 **What does it do?** - * Supports TLS (CMPv2) method of authentication (used during connection to Data File Collector) - * Allows to use custom certificates - * Exposes REST API in order to manage PM files stored in HTTPS server + - Supports TLS (CMPv2) method of authentication (used during connection to Data File Collector) + - Allows to use custom certificates + - Exposes REST API in order to manage PM files stored in HTTPS server Guides @@ -124,19 +124,19 @@ User guides: Jenkins builds: -* `VES Client jenkins builds <https://jenkins.onap.org/view/integration-simulators-nf-simulator-avcn-manager/>`_ -* `AVCN Manager jenkins builds <https://jenkins.onap.org/view/integration-simulators-nf-simulator-netconf-server/>`_ -* `PM HTTPS Server jenkins builds <https://jenkins.onap.org/view/integration-simulators-nf-simulator-pm-https-server/>`_ -* `Netconf Server jenkins builds <https://jenkins.onap.org/view/integration-simulators-nf-simulator-ves-client/>`_ +- `VES Client jenkins builds <https://jenkins.onap.org/view/integration-simulators-nf-simulator-avcn-manager/>`_ +- `AVCN Manager jenkins builds <https://jenkins.onap.org/view/integration-simulators-nf-simulator-netconf-server/>`_ +- `PM HTTPS Server jenkins builds <https://jenkins.onap.org/view/integration-simulators-nf-simulator-pm-https-server/>`_ +- `Netconf Server jenkins builds <https://jenkins.onap.org/view/integration-simulators-nf-simulator-ves-client/>`_ NF Simulator CSIT test cases: -* `Project integration-simulators-nf-simulator-netconf-server-master-verify-csit-testsuites <https://jenkins.onap.org/view/integration-simulators-nf-simulator-netconf-server/job/integration-simulators-nf-simulator-netconf-server-master-verify-csit-testsuites/>`_ -* `Project integration-simulators-nf-simulator-netconf-server-master-csit-testsuites <https://jenkins.onap.org/view/integration-simulators-nf-simulator-netconf-server/job/integration-simulators-nf-simulator-netconf-server-master-csit-testsuites/>`_ +- `Project integration-simulators-nf-simulator-netconf-server-master-verify-csit-testsuites <https://jenkins.onap.org/view/integration-simulators-nf-simulator-netconf-server/job/integration-simulators-nf-simulator-netconf-server-master-verify-csit-testsuites/>`_ +- `Project integration-simulators-nf-simulator-netconf-server-master-csit-testsuites <https://jenkins.onap.org/view/integration-simulators-nf-simulator-netconf-server/job/integration-simulators-nf-simulator-netconf-server-master-csit-testsuites/>`_ NF Simulator sanity checks: -* https://github.com/onap/integration-simulators-nf-simulator/tree/master/sanitycheck +- https://github.com/onap/integration-simulators-nf-simulator/tree/master/sanitycheck .. |image1| image:: ../files/simulators/NF-Simulator.png :width: 10in
\ No newline at end of file |