From 7a629fc3b0f667d67f5b2b7dcdbf2eccc526f004 Mon Sep 17 00:00:00 2001 From: elinuxhenrik Date: Fri, 21 May 2021 15:46:47 +0200 Subject: [PATCH] Add O-RU closed loop use case info to docs Isue-ID: NONRTRIC-507 Signed-off-by: elinuxhenrik Change-Id: I63c7f6b7725abe4528949c932659612ad41d556a --- docs/api-docs.rst | 8 ++++---- docs/use-cases.rst | 13 +++++++++++++ .../config/LinkMonitorConfigDmaap2RestJsonEvent.json | 0 .../LinkMonitor/config/o-ru-to-o-du-map.json | 0 .../LinkMonitor/events/LinkClearedEvent.json | 0 .../LinkMonitor/events/LinkFailureEvent.json | 0 .../LinkMonitor/events/SomeOtherEvent.json | 0 .../LinkMonitor/models/CreateLinkClearedOutfieldsLogic.js | 0 .../LinkMonitor/models/CreateLinkFailureOutfieldsLogic.js | 0 .../LinkMonitor/models/LinkClearedLogic.js | 0 .../LinkMonitor/models/LinkFailureLogic.js | 0 .../models/LinkMonitorModelJavascript_0.0.1.apex | 0 .../LinkMonitor/models/NoPolicyDefinedLogic.js | 0 .../LinkMonitor/models/TaskSelectionLogic.js | 0 .../apexpolicyversion}/LinkMonitor/models/ToscaPolicy.json | 0 .../LinkMonitor/schemas/LinkFailureInputSchema.avsc | 0 .../LinkMonitor/schemas/LinkFailureOutputSchema.avsc | 0 .../apexpolicyversion}/LinkMonitor/tosca/ToscaTemplate.json | 0 .../scriptversion}/README.md | 0 .../scriptversion}/app/Dockerfile | 0 .../scriptversion}/app/main.py | 0 .../scriptversion}/app/o-ru-to-o-du-map.txt | 0 .../scriptversion}/app/requirements.txt | 0 .../scriptversion}/docker-compose/docker-compose.yaml | 0 .../scriptversion}/docker-compose/start.sh | 0 .../scriptversion}/simulators/Dockerfile-message-generator | 0 .../scriptversion}/simulators/Dockerfile-sdnr-sim | 0 .../scriptversion}/simulators/message_generator.py | 0 .../scriptversion}/simulators/requirements.txt | 0 .../scriptversion}/simulators/sdnr_simulator.py | 0 30 files changed, 17 insertions(+), 4 deletions(-) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/config/LinkMonitorConfigDmaap2RestJsonEvent.json (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/config/o-ru-to-o-du-map.json (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/events/LinkClearedEvent.json (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/events/LinkFailureEvent.json (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/events/SomeOtherEvent.json (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/models/CreateLinkClearedOutfieldsLogic.js (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/models/CreateLinkFailureOutfieldsLogic.js (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/models/LinkClearedLogic.js (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/models/LinkFailureLogic.js (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/models/LinkMonitorModelJavascript_0.0.1.apex (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/models/NoPolicyDefinedLogic.js (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/models/TaskSelectionLogic.js (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/models/ToscaPolicy.json (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/schemas/LinkFailureInputSchema.avsc (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/schemas/LinkFailureOutputSchema.avsc (100%) rename test/usecases/{ => oruclosedlooprecovery/apexpolicyversion}/LinkMonitor/tosca/ToscaTemplate.json (100%) rename test/usecases/{linkfailure => oruclosedlooprecovery/scriptversion}/README.md (100%) rename test/usecases/{linkfailure => oruclosedlooprecovery/scriptversion}/app/Dockerfile (100%) rename test/usecases/{linkfailure => oruclosedlooprecovery/scriptversion}/app/main.py (100%) rename test/usecases/{linkfailure => oruclosedlooprecovery/scriptversion}/app/o-ru-to-o-du-map.txt (100%) rename test/usecases/{linkfailure => oruclosedlooprecovery/scriptversion}/app/requirements.txt (100%) rename test/usecases/{linkfailure => oruclosedlooprecovery/scriptversion}/docker-compose/docker-compose.yaml (100%) rename test/usecases/{linkfailure => oruclosedlooprecovery/scriptversion}/docker-compose/start.sh (100%) rename test/usecases/{linkfailure => oruclosedlooprecovery/scriptversion}/simulators/Dockerfile-message-generator (100%) rename test/usecases/{linkfailure => oruclosedlooprecovery/scriptversion}/simulators/Dockerfile-sdnr-sim (100%) rename test/usecases/{linkfailure => oruclosedlooprecovery/scriptversion}/simulators/message_generator.py (100%) rename test/usecases/{linkfailure => oruclosedlooprecovery/scriptversion}/simulators/requirements.txt (100%) rename test/usecases/{linkfailure => oruclosedlooprecovery/scriptversion}/simulators/sdnr_simulator.py (100%) diff --git a/docs/api-docs.rst b/docs/api-docs.rst index 9e438f67..77bbd0d8 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -43,19 +43,19 @@ See `ECS API <./ecs-api.html>`_ for how to use the API. "ECS API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`" -rAPP Catalogue -============== +Service Catalogue +================= The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover. -See `RAC API <./rac-api.html>`_ for how to use the API. +See `SC API <./rac-api.html>`_ for how to use the API. .. csv-table:: :header: "API name", "|swagger-icon|", "|yaml-icon|" :widths: 10,5, 5 - "RAC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`" + "SC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`" Complementary tools =================== diff --git a/docs/use-cases.rst b/docs/use-cases.rst index a6d9cc5c..3d18fcb2 100644 --- a/docs/use-cases.rst +++ b/docs/use-cases.rst @@ -17,3 +17,16 @@ statistics for these regular checks. For more information about it, see the README file in the use case's folder. .. image:: ./images/healtcheck.png + +O-RU closed loop recovery +------------------------- +Non-RT RIC provides two implementation versions of the recovery part of the use case. One in the form of a python +script, and one utilizing the Policy Framework. + +Script version +++++++++++++++ +The script version consists of a python script that performs the tasks needed for the use case. There are also two +simulators. One message generator that generates alarm messages, and one SDN-R simulator that recieves the config +change messages sent from the script and responds with alarm cleared messages to MR. + +All parts are Dockerized and can be started as individual containers, in the same network, in Docker. diff --git a/test/usecases/LinkMonitor/config/LinkMonitorConfigDmaap2RestJsonEvent.json b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/config/LinkMonitorConfigDmaap2RestJsonEvent.json similarity index 100% rename from test/usecases/LinkMonitor/config/LinkMonitorConfigDmaap2RestJsonEvent.json rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/config/LinkMonitorConfigDmaap2RestJsonEvent.json diff --git a/test/usecases/LinkMonitor/config/o-ru-to-o-du-map.json b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/config/o-ru-to-o-du-map.json similarity index 100% rename from test/usecases/LinkMonitor/config/o-ru-to-o-du-map.json rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/config/o-ru-to-o-du-map.json diff --git a/test/usecases/LinkMonitor/events/LinkClearedEvent.json b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/events/LinkClearedEvent.json similarity index 100% rename from test/usecases/LinkMonitor/events/LinkClearedEvent.json rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/events/LinkClearedEvent.json diff --git a/test/usecases/LinkMonitor/events/LinkFailureEvent.json b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/events/LinkFailureEvent.json similarity index 100% rename from test/usecases/LinkMonitor/events/LinkFailureEvent.json rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/events/LinkFailureEvent.json diff --git a/test/usecases/LinkMonitor/events/SomeOtherEvent.json b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/events/SomeOtherEvent.json similarity index 100% rename from test/usecases/LinkMonitor/events/SomeOtherEvent.json rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/events/SomeOtherEvent.json diff --git a/test/usecases/LinkMonitor/models/CreateLinkClearedOutfieldsLogic.js b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/CreateLinkClearedOutfieldsLogic.js similarity index 100% rename from test/usecases/LinkMonitor/models/CreateLinkClearedOutfieldsLogic.js rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/CreateLinkClearedOutfieldsLogic.js diff --git a/test/usecases/LinkMonitor/models/CreateLinkFailureOutfieldsLogic.js b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/CreateLinkFailureOutfieldsLogic.js similarity index 100% rename from test/usecases/LinkMonitor/models/CreateLinkFailureOutfieldsLogic.js rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/CreateLinkFailureOutfieldsLogic.js diff --git a/test/usecases/LinkMonitor/models/LinkClearedLogic.js b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/LinkClearedLogic.js similarity index 100% rename from test/usecases/LinkMonitor/models/LinkClearedLogic.js rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/LinkClearedLogic.js diff --git a/test/usecases/LinkMonitor/models/LinkFailureLogic.js b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/LinkFailureLogic.js similarity index 100% rename from test/usecases/LinkMonitor/models/LinkFailureLogic.js rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/LinkFailureLogic.js diff --git a/test/usecases/LinkMonitor/models/LinkMonitorModelJavascript_0.0.1.apex b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/LinkMonitorModelJavascript_0.0.1.apex similarity index 100% rename from test/usecases/LinkMonitor/models/LinkMonitorModelJavascript_0.0.1.apex rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/LinkMonitorModelJavascript_0.0.1.apex diff --git a/test/usecases/LinkMonitor/models/NoPolicyDefinedLogic.js b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/NoPolicyDefinedLogic.js similarity index 100% rename from test/usecases/LinkMonitor/models/NoPolicyDefinedLogic.js rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/NoPolicyDefinedLogic.js diff --git a/test/usecases/LinkMonitor/models/TaskSelectionLogic.js b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/TaskSelectionLogic.js similarity index 100% rename from test/usecases/LinkMonitor/models/TaskSelectionLogic.js rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/TaskSelectionLogic.js diff --git a/test/usecases/LinkMonitor/models/ToscaPolicy.json b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/ToscaPolicy.json similarity index 100% rename from test/usecases/LinkMonitor/models/ToscaPolicy.json rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/models/ToscaPolicy.json diff --git a/test/usecases/LinkMonitor/schemas/LinkFailureInputSchema.avsc b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/schemas/LinkFailureInputSchema.avsc similarity index 100% rename from test/usecases/LinkMonitor/schemas/LinkFailureInputSchema.avsc rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/schemas/LinkFailureInputSchema.avsc diff --git a/test/usecases/LinkMonitor/schemas/LinkFailureOutputSchema.avsc b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/schemas/LinkFailureOutputSchema.avsc similarity index 100% rename from test/usecases/LinkMonitor/schemas/LinkFailureOutputSchema.avsc rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/schemas/LinkFailureOutputSchema.avsc diff --git a/test/usecases/LinkMonitor/tosca/ToscaTemplate.json b/test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/tosca/ToscaTemplate.json similarity index 100% rename from test/usecases/LinkMonitor/tosca/ToscaTemplate.json rename to test/usecases/oruclosedlooprecovery/apexpolicyversion/LinkMonitor/tosca/ToscaTemplate.json diff --git a/test/usecases/linkfailure/README.md b/test/usecases/oruclosedlooprecovery/scriptversion/README.md similarity index 100% rename from test/usecases/linkfailure/README.md rename to test/usecases/oruclosedlooprecovery/scriptversion/README.md diff --git a/test/usecases/linkfailure/app/Dockerfile b/test/usecases/oruclosedlooprecovery/scriptversion/app/Dockerfile similarity index 100% rename from test/usecases/linkfailure/app/Dockerfile rename to test/usecases/oruclosedlooprecovery/scriptversion/app/Dockerfile diff --git a/test/usecases/linkfailure/app/main.py b/test/usecases/oruclosedlooprecovery/scriptversion/app/main.py similarity index 100% rename from test/usecases/linkfailure/app/main.py rename to test/usecases/oruclosedlooprecovery/scriptversion/app/main.py diff --git a/test/usecases/linkfailure/app/o-ru-to-o-du-map.txt b/test/usecases/oruclosedlooprecovery/scriptversion/app/o-ru-to-o-du-map.txt similarity index 100% rename from test/usecases/linkfailure/app/o-ru-to-o-du-map.txt rename to test/usecases/oruclosedlooprecovery/scriptversion/app/o-ru-to-o-du-map.txt diff --git a/test/usecases/linkfailure/app/requirements.txt b/test/usecases/oruclosedlooprecovery/scriptversion/app/requirements.txt similarity index 100% rename from test/usecases/linkfailure/app/requirements.txt rename to test/usecases/oruclosedlooprecovery/scriptversion/app/requirements.txt diff --git a/test/usecases/linkfailure/docker-compose/docker-compose.yaml b/test/usecases/oruclosedlooprecovery/scriptversion/docker-compose/docker-compose.yaml similarity index 100% rename from test/usecases/linkfailure/docker-compose/docker-compose.yaml rename to test/usecases/oruclosedlooprecovery/scriptversion/docker-compose/docker-compose.yaml diff --git a/test/usecases/linkfailure/docker-compose/start.sh b/test/usecases/oruclosedlooprecovery/scriptversion/docker-compose/start.sh similarity index 100% rename from test/usecases/linkfailure/docker-compose/start.sh rename to test/usecases/oruclosedlooprecovery/scriptversion/docker-compose/start.sh diff --git a/test/usecases/linkfailure/simulators/Dockerfile-message-generator b/test/usecases/oruclosedlooprecovery/scriptversion/simulators/Dockerfile-message-generator similarity index 100% rename from test/usecases/linkfailure/simulators/Dockerfile-message-generator rename to test/usecases/oruclosedlooprecovery/scriptversion/simulators/Dockerfile-message-generator diff --git a/test/usecases/linkfailure/simulators/Dockerfile-sdnr-sim b/test/usecases/oruclosedlooprecovery/scriptversion/simulators/Dockerfile-sdnr-sim similarity index 100% rename from test/usecases/linkfailure/simulators/Dockerfile-sdnr-sim rename to test/usecases/oruclosedlooprecovery/scriptversion/simulators/Dockerfile-sdnr-sim diff --git a/test/usecases/linkfailure/simulators/message_generator.py b/test/usecases/oruclosedlooprecovery/scriptversion/simulators/message_generator.py similarity index 100% rename from test/usecases/linkfailure/simulators/message_generator.py rename to test/usecases/oruclosedlooprecovery/scriptversion/simulators/message_generator.py diff --git a/test/usecases/linkfailure/simulators/requirements.txt b/test/usecases/oruclosedlooprecovery/scriptversion/simulators/requirements.txt similarity index 100% rename from test/usecases/linkfailure/simulators/requirements.txt rename to test/usecases/oruclosedlooprecovery/scriptversion/simulators/requirements.txt diff --git a/test/usecases/linkfailure/simulators/sdnr_simulator.py b/test/usecases/oruclosedlooprecovery/scriptversion/simulators/sdnr_simulator.py similarity index 100% rename from test/usecases/linkfailure/simulators/sdnr_simulator.py rename to test/usecases/oruclosedlooprecovery/scriptversion/simulators/sdnr_simulator.py -- 2.16.6