From 5a01ec4da9c004c8b74d2997ee7d3ffa77dfaf95 Mon Sep 17 00:00:00 2001 From: PatrikBuhr Date: Tue, 16 May 2023 10:54:58 +0200 Subject: [PATCH] Documentation of RAN PM Renamed kafka-pm-producer to pm-file-converter Signed-off-by: PatrikBuhr Issue-ID: NONRTRIC-868 Change-Id: Ib0af622e34d389dfe24667a08b4cec5e9e887b1c --- .readthedocs.yaml | 25 ++++++++++++++------- docs/conf.py | 2 +- docs/overview.rst | 8 +++---- .../.gitignore | 0 .../Dockerfile | 0 {kafka-pm-producer => pm-file-converter}/README.md | 0 .../application_configuration.json | 0 {kafka-pm-producer => pm-file-converter}/build.sh | 0 .../container.yaml | 0 .../docs/Architecture.png | Bin .../docs/Pictures.pptx | Bin .../docs/_static/logo.png | Bin .../docs/conf.py | 0 .../docs/conf.yaml | 0 .../docs/favicon.ico | Bin .../docs/index.rst | 4 ++-- .../docs/overview.rst | 4 ++-- .../docs/requirements-docs.txt | 0 .../gen-cert.sh | 0 {kafka-pm-producer => pm-file-converter}/go.mod | 0 {kafka-pm-producer => pm-file-converter}/go.sum | 0 {kafka-pm-producer => pm-file-converter}/main.go | 0 {kafka-pm-producer => pm-file-converter}/tox.ini | 0 tox.ini | 4 ++-- 24 files changed, 28 insertions(+), 19 deletions(-) rename {kafka-pm-producer => pm-file-converter}/.gitignore (100%) rename {kafka-pm-producer => pm-file-converter}/Dockerfile (100%) rename {kafka-pm-producer => pm-file-converter}/README.md (100%) rename {kafka-pm-producer => pm-file-converter}/application_configuration.json (100%) rename {kafka-pm-producer => pm-file-converter}/build.sh (100%) rename {kafka-pm-producer => pm-file-converter}/container.yaml (100%) rename {kafka-pm-producer => pm-file-converter}/docs/Architecture.png (100%) rename {kafka-pm-producer => pm-file-converter}/docs/Pictures.pptx (100%) rename {kafka-pm-producer => pm-file-converter}/docs/_static/logo.png (100%) rename {kafka-pm-producer => pm-file-converter}/docs/conf.py (100%) rename {kafka-pm-producer => pm-file-converter}/docs/conf.yaml (100%) rename {kafka-pm-producer => pm-file-converter}/docs/favicon.ico (100%) rename {kafka-pm-producer => pm-file-converter}/docs/index.rst (89%) rename {kafka-pm-producer => pm-file-converter}/docs/overview.rst (98%) rename {kafka-pm-producer => pm-file-converter}/docs/requirements-docs.txt (100%) rename {kafka-pm-producer => pm-file-converter}/gen-cert.sh (100%) rename {kafka-pm-producer => pm-file-converter}/go.mod (100%) rename {kafka-pm-producer => pm-file-converter}/go.sum (100%) rename {kafka-pm-producer => pm-file-converter}/main.go (100%) rename {kafka-pm-producer => pm-file-converter}/tox.ini (100%) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index ab5d752..6fcc5c8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -31,13 +31,22 @@ build: python: "3.7" jobs: pre_build: - - mkdir --parents _readthedocs/html/ - - mkdir --parents _readthedocs/tmp/doctrees - - sphinx-build -W -b html --keep-going -n -d _readthedocs/tmp/doctrees ./docs/ _readthedocs/html/ - - sphinx-build -W -b html --keep-going -n -d _readthedocs/tmp/doctrees/datafilecollector ./datafilecollector/docs/ _readthedocs/html/datafilecollector - - sphinx-build -W -b html --keep-going -n -d _readthedocs/tmp/doctrees/influxlogger ./influxlogger/docs/ _readthedocs/html/influxlogger - - sphinx-build -W -b html --keep-going -n -d _readthedocs/tmp/doctrees/pmproducer ./pmproducer/docs/ _readthedocs/html/pmproducer - - sphinx-build -W -b html --keep-going -n -d _readthedocs/tmp/doctrees/kafka-pm-producer ./kafka-pm-producer/docs/ _readthedocs/html/kafka-pm-producer + - mkdir --parents _readthedocs/html/ + - mkdir --parents _readthedocs/tmp/doctrees + - sphinx-build -W -b html --keep-going -n -d + _readthedocs/tmp/doctrees ./docs/ _readthedocs/html/ + - sphinx-build -W -b html --keep-going -n -d + _readthedocs/tmp/doctrees/datafilecollector ./datafilecollector/docs/ + _readthedocs/html/datafilecollector + - sphinx-build -W -b html --keep-going -n -d + _readthedocs/tmp/doctrees/influxlogger ./influxlogger/docs/ + _readthedocs/html/influxlogger + - sphinx-build -W -b html --keep-going -n -d + _readthedocs/tmp/doctrees/pmproducer ./pmproducer/docs/ + _readthedocs/html/pmproducer + - sphinx-build -W -b html --keep-going -n -d + _readthedocs/tmp/doctrees/pm-file-converter ./pm-file-converter/docs/ + _readthedocs/html/pm-file-converter python: install: @@ -45,7 +54,7 @@ python: - requirements: datafilecollector/docs/requirements-docs.txt - requirements: influxlogger/docs/requirements-docs.txt - requirements: pmproducer/docs/requirements-docs.txt - - requirements: kafka-pm-producer/docs/requirements-docs.txt + - requirements: pm-file-converter/docs/requirements-docs.txt sphinx: configuration: docs/conf.py diff --git a/docs/conf.py b/docs/conf.py index 8f9044f..ff87b2b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,6 +42,6 @@ intersphinx_mapping['nonrtric'] = ('%s/o-ran-sc-nonrtric/en/%s' %(baseurl, branc intersphinx_mapping['influxlogger'] = ('%s/influxlogger' % selfurl, None) intersphinx_mapping['datafilecollector'] = ('%s/datafilecollector' % selfurl, None) intersphinx_mapping['pmproducer'] = ('%s/pmproducer' % selfurl, None) -intersphinx_mapping['kafka-pm-producer'] = ('%s/kafka-pm-producer' % selfurl, None) +intersphinx_mapping['pm-file-converter'] = ('%s/pm-file-converter' % selfurl, None) intersphinx_disabled_reftypes = ["*"] diff --git a/docs/overview.rst b/docs/overview.rst index a107728..f6ea5ce 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -26,7 +26,7 @@ Components The picture illustrates the components involved. * The PM Data File Collector fetches the XML files from the RAN. -* The PM Data Converter converts these to a Json format. The structure and the contents +* The PM File Converter converts these to a Json format. The structure and the contents is the same as the XML format. * The PM Producer handles filtering and distribution of PM data to subscribers. These subscribers can be rApps. * The Influx Logger stores selected PM mesurements into a time series database. @@ -44,7 +44,7 @@ The third party products used are: For more detailed documentation of the components: * :doc:`Non-RT RIC - RAN PM - PM Data File Collector (Documentation site) `. -* :doc:`Non-RT RIC - RAN PM - PM Data Data Converter (Documentation site) `. +* :doc:`Non-RT RIC - RAN PM - PM File Converter (Documentation site) `. * :doc:`Non-RT RIC - RAN PM - PM Producer (Documentation site) `. * :doc:`Non-RT RIC - RAN PM - Influx Logger (Documentation site) `. * `Non-RT RIC - Information Coordinator Service (Documentation site) `_. @@ -65,7 +65,7 @@ The figure below gives an overview of the data flow through the components. 2. The VES event is put on a Kafka topic and picked up by the Data File Collector. 3. A PM report file is fetched from the RAN node by a file transfer protocol. Which protocol to use is defined in the VES event. 4. The collected file is stored -5. A File collected object is put on a Kafka topic and is picked up by the PM Data Converter. +5. A File collected object is put on a Kafka topic and is picked up by the PM File Converter. 6. The file data is read from the file store. 7. A PM report in json format is stored (compressed with gzip). 8. A message (a Json object) indicating that a new PM report (in Json format) is available is put on a Kafka topic and is picked up by the PM Data Producer. @@ -108,4 +108,4 @@ An application retrieving logged PM data from the Influx database needs to consi defined in :doc:`Non-RT RIC - RAN PM - Influx Logger (Documentation site) `. .. image:: ./DesignTimeDependencies.png - :width: 500pt \ No newline at end of file + :width: 500pt diff --git a/kafka-pm-producer/.gitignore b/pm-file-converter/.gitignore similarity index 100% rename from kafka-pm-producer/.gitignore rename to pm-file-converter/.gitignore diff --git a/kafka-pm-producer/Dockerfile b/pm-file-converter/Dockerfile similarity index 100% rename from kafka-pm-producer/Dockerfile rename to pm-file-converter/Dockerfile diff --git a/kafka-pm-producer/README.md b/pm-file-converter/README.md similarity index 100% rename from kafka-pm-producer/README.md rename to pm-file-converter/README.md diff --git a/kafka-pm-producer/application_configuration.json b/pm-file-converter/application_configuration.json similarity index 100% rename from kafka-pm-producer/application_configuration.json rename to pm-file-converter/application_configuration.json diff --git a/kafka-pm-producer/build.sh b/pm-file-converter/build.sh similarity index 100% rename from kafka-pm-producer/build.sh rename to pm-file-converter/build.sh diff --git a/kafka-pm-producer/container.yaml b/pm-file-converter/container.yaml similarity index 100% rename from kafka-pm-producer/container.yaml rename to pm-file-converter/container.yaml diff --git a/kafka-pm-producer/docs/Architecture.png b/pm-file-converter/docs/Architecture.png similarity index 100% rename from kafka-pm-producer/docs/Architecture.png rename to pm-file-converter/docs/Architecture.png diff --git a/kafka-pm-producer/docs/Pictures.pptx b/pm-file-converter/docs/Pictures.pptx similarity index 100% rename from kafka-pm-producer/docs/Pictures.pptx rename to pm-file-converter/docs/Pictures.pptx diff --git a/kafka-pm-producer/docs/_static/logo.png b/pm-file-converter/docs/_static/logo.png similarity index 100% rename from kafka-pm-producer/docs/_static/logo.png rename to pm-file-converter/docs/_static/logo.png diff --git a/kafka-pm-producer/docs/conf.py b/pm-file-converter/docs/conf.py similarity index 100% rename from kafka-pm-producer/docs/conf.py rename to pm-file-converter/docs/conf.py diff --git a/kafka-pm-producer/docs/conf.yaml b/pm-file-converter/docs/conf.yaml similarity index 100% rename from kafka-pm-producer/docs/conf.yaml rename to pm-file-converter/docs/conf.yaml diff --git a/kafka-pm-producer/docs/favicon.ico b/pm-file-converter/docs/favicon.ico similarity index 100% rename from kafka-pm-producer/docs/favicon.ico rename to pm-file-converter/docs/favicon.ico diff --git a/kafka-pm-producer/docs/index.rst b/pm-file-converter/docs/index.rst similarity index 89% rename from kafka-pm-producer/docs/index.rst rename to pm-file-converter/docs/index.rst index ac5b863..dde56a8 100644 --- a/kafka-pm-producer/docs/index.rst +++ b/pm-file-converter/docs/index.rst @@ -2,7 +2,7 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright (C) 2023 Nordix -Non-RT RIC PM Data Converter +Non-RT RIC PM File Converter ============================ .. toctree:: @@ -10,4 +10,4 @@ Non-RT RIC PM Data Converter :caption: Contents: ./overview.rst - + diff --git a/kafka-pm-producer/docs/overview.rst b/pm-file-converter/docs/overview.rst similarity index 98% rename from kafka-pm-producer/docs/overview.rst rename to pm-file-converter/docs/overview.rst index 906881a..438cdf1 100644 --- a/kafka-pm-producer/docs/overview.rst +++ b/pm-file-converter/docs/overview.rst @@ -3,7 +3,7 @@ .. Copyright (C) 2023 Nordix -PM Data Converter +PM File Converter ~~~~~~~~~~~~~~~~~ @@ -11,7 +11,7 @@ PM Data Converter Overview ******** -The task of the PM Data Converter is to convert PM Measurement report files, +The task of the PM File Converter is to convert PM Measurement report files, (XML formatted according to 3GPP TS 32.432 and 3GPP TS 32.435) into Json. The component receives objects from kafka that indicates that new PM Report files diff --git a/kafka-pm-producer/docs/requirements-docs.txt b/pm-file-converter/docs/requirements-docs.txt similarity index 100% rename from kafka-pm-producer/docs/requirements-docs.txt rename to pm-file-converter/docs/requirements-docs.txt diff --git a/kafka-pm-producer/gen-cert.sh b/pm-file-converter/gen-cert.sh similarity index 100% rename from kafka-pm-producer/gen-cert.sh rename to pm-file-converter/gen-cert.sh diff --git a/kafka-pm-producer/go.mod b/pm-file-converter/go.mod similarity index 100% rename from kafka-pm-producer/go.mod rename to pm-file-converter/go.mod diff --git a/kafka-pm-producer/go.sum b/pm-file-converter/go.sum similarity index 100% rename from kafka-pm-producer/go.sum rename to pm-file-converter/go.sum diff --git a/kafka-pm-producer/main.go b/pm-file-converter/main.go similarity index 100% rename from kafka-pm-producer/main.go rename to pm-file-converter/main.go diff --git a/kafka-pm-producer/tox.ini b/pm-file-converter/tox.ini similarity index 100% rename from kafka-pm-producer/tox.ini rename to pm-file-converter/tox.ini diff --git a/tox.ini b/tox.ini index e014a22..e26163d 100644 --- a/tox.ini +++ b/tox.ini @@ -29,13 +29,13 @@ deps = -r{toxinidir}/datafilecollector/docs/requirements-docs.txt -r{toxinidir}/influxlogger/docs/requirements-docs.txt -r{toxinidir}/pmproducer/docs/requirements-docs.txt - -r{toxinidir}/kafka-pm-producer/docs/requirements-docs.txt + -r{toxinidir}/pm-file-converter/docs/requirements-docs.txt commands = sphinx-build -W -b html --keep-going -n -d {envtmpdir}/datafilecollector/doctrees ./datafilecollector/docs/ {toxinidir}/docs/_build/html/datafilecollector sphinx-build -W -b html --keep-going -n -d {envtmpdir}/influxlogger/doctrees ./influxlogger/docs/ {toxinidir}/docs/_build/html/influxlogger sphinx-build -W -b html --keep-going -n -d {envtmpdir}/pmproducer/doctrees ./pmproducer/docs/ {toxinidir}/docs/_build/html/pmproducer - sphinx-build -W -b html --keep-going -n -d {envtmpdir}/kafka-pm-producer/doctrees ./kafka-pm-producer/docs/ {toxinidir}/docs/_build/html/kafka-pm-producer + sphinx-build -W -b html --keep-going -n -d {envtmpdir}/pm-file-converter/doctrees ./pm-file-converter/docs/ {toxinidir}/docs/_build/html/pm-file-converter sphinx-build -W -b html --keep-going -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html [testenv:docs-linkcheck] -- 2.16.6