aboutsummaryrefslogtreecommitdiffstats
path: root/docs/simulators
diff options
context:
space:
mode:
authorKrzysztof Kuzmicki <krzysztof.kuzmicki@nokia.com>2021-04-19 12:51:54 +0200
committerMarcin Przybysz <marcin.przybysz@nokia.com>2021-04-20 06:23:15 +0000
commit0da02f4ea83b49cc03895ee106ad0b4fdfbe36c8 (patch)
treef8609c9e920945a294dc1e165b120d3d80991bea /docs/simulators
parent433b0cabec3a7ceb232940eb2b62872a583cea49 (diff)
[INTEGRATION] NF simulator documentation - fix indents and bullet points
fix indents and bullet points Issue-ID: INT-1869 Signed-off-by: Krzysztof Kuzmicki <krzysztof.kuzmicki@nokia.com> Change-Id: Id8e2462407fdd4facbdebb652d6b57f9ee2ab100
Diffstat (limited to 'docs/simulators')
-rw-r--r--docs/simulators/nf_simulator.rst87
1 files changed, 47 insertions, 40 deletions
diff --git a/docs/simulators/nf_simulator.rst b/docs/simulators/nf_simulator.rst
index 8b7fae89a..64a6ac3b5 100644
--- a/docs/simulators/nf_simulator.rst
+++ b/docs/simulators/nf_simulator.rst
@@ -45,66 +45,73 @@ Only AVCN Manger connects VES Client with Netconf Server in order to support O1
1. VES Client:
--------------
-Application that generates VES events on demand.
-
-**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.
- 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,
- 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.
+1. Purpose of VES Client
+
+ Application that generates VES events on demand.
+
+2. What does it do?
+
+ - Support both basic auth and TLS CMPv2 method of authentication.
+ - Allow to turn on and turn off hostname, verification in SSL.
+ - Allow to send one-time event and periodic events, based on event templates.
+ - Expose API to manage VES Client
+ - Provide 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 support 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.
2. Netconf Server:
------------------
-This server uses sysrepo to simulate network configuration.
-It is based on sysrepo-netopeer2 image.
+1. Purpose of Netconf Server
-**What does it do?**
+ This server uses sysrepo to simulate network configuration.
+ It is based on sysrepo-netopeer2 image.
-Server allows to:
+2. What does it do?
-- 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:
+ Server allows to:
- - 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
+ - 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
3. AVCN Manager:
----------------
-Manager that fetches changes of configuration from kafka and sends them to VES client.
+1. Purpose of AVCN Manager
+
+ Manager that fetch changes of configuration from kafka and sends them to VES client.
-**What does it do?**
+2. What does it do?
-The manager processes notifications from NETCONF server. It does this by being a subscriber of a Kafka topic that is fed
-with NETCONF notifications. Incoming notifications are then processed and output of this processing is sent to VES client.
+ The manager process notifications from NETCONF server. It does this by being a subscriber of a Kafka topic that is fed with NETCONF notifications. Incoming notifications are then processed and output of this processing is sent to VES client.
4. PM HTTPS Server:
-------------------
-Server that is used in Bulk PM usecases over HTTPS
+1. Purpose of PM HTTPS Server
+
+ Server that is used in Bulk PM usecase over HTTPS
-**What does it do?**
+2. 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
+ - Support TLS (CMPv2) method of authentication (used during connection to Data File Collector)
+ - Allow to use custom certificates
+ - Expose REST API in order to manage PM files stored in HTTPS server
Guides