diff options
-rwxr-xr-x | docs/Chapter7/Monitoring-And-Management.rst | 21 | ||||
-rw-r--r-- | docs/conf.py | 5 | ||||
-rw-r--r-- | tox.ini | 2 |
3 files changed, 23 insertions, 5 deletions
diff --git a/docs/Chapter7/Monitoring-And-Management.rst b/docs/Chapter7/Monitoring-And-Management.rst index 9144850..659d28b 100755 --- a/docs/Chapter7/Monitoring-And-Management.rst +++ b/docs/Chapter7/Monitoring-And-Management.rst @@ -116,7 +116,7 @@ ONAP. The VNF or PNF **MAY** leverage ONAP's High Volume VNF Event Streaming (HV-VES) when there is a need to deliver large volumes of real-time performance management metrics. See - `HV-VES Collector <https://onap-doc.readthedocs.io/projects/onap-dcaegen2/en/latest/sections/services/ves-hv/index.html>`__ + :doc:`HV-VES collector <dcae:sections/services/ves-hv/index>` service details for more information. .. req:: @@ -128,8 +128,9 @@ ONAP. :impacts: DCAE VNF or PNF Provider **MUST** have agreement with the Service Provider before - utilizing the HV-VES option for monitoring as this option does not fully - integrate with the ONAP's DCAE event processing capabilities. + utilizing the :doc:`HV-VES option <dcae:sections/services/ves-hv/index>` + for monitoring as this option does not fully integrate with the ONAP's DCAE + event processing capabilities. .. req:: :id: R-908291 @@ -150,6 +151,20 @@ ONAP. `5G - Bulk PM ONAP Development <https://wiki.onap.org/display/DW/5G+-+Bulk+PM>`__ Wiki page. +.. req:: + :id: R-63105 + :target: VNF or PNF + :keyword: MAY + :introduced: guilin + :impacts: dcae + + The VNF or PNF **MAY** produce telemetry data using the + :doc:`RESTConf Collector <dcae:sections/services/restconf/index>`, but this + requires additional coordination with the operator to appropriately + map the data internally to a VES-like structure used within ONAP. If this + option is needed, then the VNF or PNF Provider must coordinate with with the + Operator for the data to be successfully collected and processed by DCAE. + .. _snmp_monitoring_requirements: SNMP Monitoring Requirements diff --git a/docs/conf.py b/docs/conf.py index 1a9f9ce..55f10d7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -8,10 +8,13 @@ linkcheck_ignore = [ 'http://localhost', ] -intersphinx_mapping = {} +intersphinx_mapping = { + 'dcae': ('https://docs.onap.org/projects/onap-dcaegen2/en/latest/', None) +} html_last_updated_fmt = '%d-%b-%y %H:%M' + def setup(app): app.add_stylesheet("css/ribbon.css") @@ -24,9 +24,9 @@ skipsdist = true basepython = python3 deps = -r{toxinidir}/etc/requirements.txt commands = + python check.py sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html echo "Generated docs available in {toxinidir}/_build/html" - python check.py whitelist_externals = echo git |