---
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# Required
version: 2
formats:
- htmlzip
build:
- image: latest
+ os: "ubuntu-22.04"
+ tools:
+ python: "3.7"
python:
- version: 3.7
install:
- requirements: docs/requirements-docs.txt
The VES Agent transmits events to the VES Collector in the VES Common Event Format v5.4.1. The Common Event Format is expressed in JSON schema v28.4.1.
VES Event Listener 5.4.1:
-<https://docs.onap.org/en/casablanca/submodules/vnfsdk/model.git/docs/files/VESEventListener.html>
+ earlier under h t t p s://docs.onap.org/en/casablanca/submodules/vnfsdk/model.git/docs/files/VESEventListener.html
JSON schema v28.4.1:
<https://github.com/nokia/ONAP-VESPA/blob/8e9d9e93bb00bed0f5402c9de9502385d5e80acc/doc/CommonEventFormat_28.4.1.json>
* VESMGR_NFNAMINGCODE - NF naming code as a string. Default: ricp.
* VESMGR_HB_INTERVAL - VES heartbeat interval as a string. For example: 30s.
* VESMGR_MEAS_INTERVAL - Measurement interval as a string. For example: 60s.
-* VESMGR_PROMETHEUS_ADDR - Prometheus address. For example: http://127.0.0.1:123
+* VESMGR_PROMETHEUS_ADDR - Prometheus address. For example: h t t p://127.0.0.1:123
* VESMGR_ALERTMANAGER_BIND_ADDR - Bind address to receive alerts from Prometheus AlertManager
* VESMGR_PRICOLLECTOR_ADDR - Primary collector FQDN as a string. For example: ricaux-entry.
sphinxcontrib-httpdomain
recommonmark
lfdocs-conf
+ urllib3~=1.26.15
commands =
sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals = echo
+allowlist_externals = echo
[testenv:docs-linkcheck]
passenv =
sphinxcontrib-httpdomain
recommonmark
lfdocs-conf
+ urllib3~=1.26.15
commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck