aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--.readthedocs.yaml5
-rw-r--r--docs/Logging_Enhancements_Project/logging_enhancements_project.rst22
-rw-r--r--docs/ONAP_Log_Analytics/onap_log_analytics.rst3
-rw-r--r--docs/_static/css/ribbon.css2
-rw-r--r--docs/conf.py53
-rw-r--r--docs/conf.yaml7
-rw-r--r--docs/index.rst3
-rw-r--r--docs/release-notes.rst247
-rw-r--r--docs/requirements-docs.txt2
-rw-r--r--docs/tox.ini37
-rw-r--r--reference/logging-demo/pom.xml2
-rw-r--r--reference/logging-library/pom.xml2
-rw-r--r--reference/logging-slf4j-demo/pom.xml2
-rw-r--r--reference/logging-slf4j/pom.xml2
14 files changed, 215 insertions, 174 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 3797dc8..e442ca7 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -9,10 +9,11 @@ formats:
- htmlzip
build:
- image: latest
+ os: ubuntu-20.04
+ tools:
+ python: "3.8"
python:
- version: 3.7
install:
- requirements: docs/requirements-docs.txt
diff --git a/docs/Logging_Enhancements_Project/logging_enhancements_project.rst b/docs/Logging_Enhancements_Project/logging_enhancements_project.rst
index c74535a..81476f0 100644
--- a/docs/Logging_Enhancements_Project/logging_enhancements_project.rst
+++ b/docs/Logging_Enhancements_Project/logging_enhancements_project.rst
@@ -81,7 +81,7 @@ components involved in its processing.
A reference configuration of \ `*Elastic
Stack * <https://www.elastic.co/products>`__\ can be deployed
using \ `*ONAP Operations
-Manager* <https://wiki.onap.org/display/DW/ONAP+Operations+Manager+Project>`__.
+Manager* <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16230609/ONAP+Operations+Manager+Project>`__.
This document gives conventions you can follow to generate conformant,
indexable logging output from your component.
@@ -121,7 +121,7 @@ EELF is a facade, so logging output is configured in two ways:
2. By way of a provider configuration document,
typically \ **logback.xml** or **log4j.xml**.
- See \ `*Providers* <https://wiki.onap.org/display/DW/ONAP+Application+Logging+Guidelines+v1.1#ONAPApplicationLoggingGuidelinesv1.1-Providers>`__.
+ See \ `*Providers* <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16245051/ONAP+Application+Logging+Guidelines+v1.1>`__.
**SLF4J**
@@ -151,7 +151,7 @@ abstracted behind EELF or SLF4J, it may not be worth the effort.
Logback is the most commonly used provider. It is generally configured
by an XML document named \ **logback.xml**.
-See \ `*Configuration* <https://wiki.onap.org/display/DW/ONAP+Application+Logging+Guidelines+v1.1#ONAPApplicationLoggingGuidelinesv1.1-Configuration>`__.
+See \ `*Configuration* <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16245051/ONAP+Application+Logging+Guidelines+v1.1>`__.
**Log4j 2.X**
@@ -159,7 +159,7 @@ See \ `*Configuration* <https://wiki.onap.org/display/DW/ONAP+Application+Loggin
Log4j 2.X is somewhat less common than Logback, but equivalent. It is
generally configured by an XML document
-named \ **log4j.xml**. See \ `*Configuration* <https://wiki.onap.org/display/DW/ONAP+Application+Logging+Guidelines+v1.1#ONAPApplicationLoggingGuidelinesv1.1-Configuration>`__.
+named \ **log4j.xml**. See \ `*Configuration* <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16245051/ONAP+Application+Logging+Guidelines+v1.1>`__.
**Log4j 1.X**
@@ -171,10 +171,10 @@ machine-readable. See \ `*https://logging.apache.org/log4j/1.2/* <https://loggin
This affects existing OpenDaylight-based components like SDNC and APPC,
since ODL releases prior
-to \ `*Carbon* <https://www.opendaylight.org/what-we-do/current-release>`__ bundle
+to \ `*Carbon* <https://docs.opendaylight.org/en/latest/release-notes/>`__ bundle
Log4j 1.X, and make it difficult to replace. The \ `*Common Controller
SDK
-Project* <https://wiki.onap.org/display/DW/Common+Controller+SDK+Project>`__ project
+Project* <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16230653/Common+Controller+SDK+Project>`__ project
targets ODL Carbon, so the problem should resolve in time.
What to Log
@@ -231,7 +231,7 @@ A Mapped Diagnostic Context (MDC) allows an arbitrary string-valued
attribute to be attached to a Java thread. The MDC's value is then
emitted with each log message. The set of MDCs associated with a log
message is serialized as unordered name-value pairs (see `*Text
-Output* <https://wiki.onap.org/display/DW/ONAP+Application+Logging+Guidelines+v1.1#ONAPApplicationLoggingGuidelinesv1.1-TextOutput>`__).
+Output* <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16245051/ONAP+Application+Logging+Guidelines+v1.1>`__).
A good discussion of MDCs can be found
at \ `*https://logback.qos.ch/manual/mdc.html* <https://logback.qos.ch/manual/mdc.html>`__.
@@ -976,24 +976,24 @@ You must:
1. Choose a Logging provider and/or EELF. Decisions, decisions.
2. Create a configuration file based on an existing
- archetype. See \ `*Configuration* <https://wiki.onap.org/display/DW/ONAP+Application+Logging+Guidelines+v1.1#ONAPApplicationLoggingGuidelinesv1.1-Configuration>`__.
+ archetype. See \ `*Configuration* <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16245051/ONAP+Application+Logging+Guidelines+v1.1>`__.
3. Read your configuration file when your components initialize logging.
4. Write logs to a standard location so that they can be shipped by
Filebeat for indexing. See \ `*Output
- Location* <https://wiki.onap.org/display/DW/ONAP+Application+Logging+Guidelines+v1.1#ONAPApplicationLoggingGuidelinesv1.1-OutputLocation>`__.
+ Location* <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16245051/ONAP+Application+Logging+Guidelines+v1.1>`__.
5. Report transaction state:
a. Retrieve, default and propagate \ **RequestID**. See \ `*MDC -
- RequestID* <https://wiki.onap.org/display/DW/ONAP+Application+Logging+Guidelines+v1.1#ONAPApplicationLoggingGuidelinesv1.1-MDC-RequestID>`__.
+ RequestID* <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16245051/ONAP+Application+Logging+Guidelines+v1.1>`__.
b. At each invocation of one ONAP component by another:
i. Initialize and propagate \ **InvocationID**. See \ `*MDC -
Invocation
- ID* <https://wiki.onap.org/display/DW/ONAP+Application+Logging+Guidelines+v1.1#ONAPApplicationLoggingGuidelinesv1.1-MDC-InvocationID>`__.
+ ID* <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16245051/ONAP+Application+Logging+Guidelines+v1.1>`__.
ii. Report \ **INVOKE** and **SYNCHRONOUS** markers in caller.
diff --git a/docs/ONAP_Log_Analytics/onap_log_analytics.rst b/docs/ONAP_Log_Analytics/onap_log_analytics.rst
index 15ac9c5..656b9b1 100644
--- a/docs/ONAP_Log_Analytics/onap_log_analytics.rst
+++ b/docs/ONAP_Log_Analytics/onap_log_analytics.rst
@@ -222,7 +222,7 @@ The frontend UI, Kibana, can be accessed from a web browser on the port 30253. B
Follow the below steps to access Kibana UI and view the logs
------------------------------------------------------------
-1) To launch the Kibana UI, navigate to http://<vm-ip-address>:30253 in your browser. Refer the below screen shot for the same.
+1) To launch the Kibana UI, navigate to ``http://<vm-ip-address>:30253`` in your browser. Refer the below screen shot for the same.
|image1|
@@ -294,4 +294,3 @@ Follow the below steps to access Kibana UI and view the logs
.. |image12| image:: ../media/search-component-logs.png
.. |image13| image:: ../media/log-expand.png
.. |image14| image:: ../media/log-details.png
-
diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css
index 6008cb1..afb9480 100644
--- a/docs/_static/css/ribbon.css
+++ b/docs/_static/css/ribbon.css
@@ -59,5 +59,5 @@
/* fix width of the screen */
.wy-nav-content {
- max-width: none;
+ max-width: 800px;
}
diff --git a/docs/conf.py b/docs/conf.py
index 5371015..a9c42b6 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,15 +1,56 @@
-from docs_conf.conf import *
+project = "onap"
+release = "master"
+version = "master"
-branch = 'latest'
-master_doc = 'index'
+author = "Open Network Automation Platform"
+# yamllint disable-line rule:line-length
+copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
-linkcheck_ignore = [
- 'http://localhost',
+pygments_style = "sphinx"
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+ "style_nav_header_background": "white",
+ "sticky_navigation": "False" }
+html_logo = "_static/logo_onap_2017.png"
+html_favicon = "_static/favicon.ico"
+html_static_path = ["_static"]
+html_show_sphinx = False
+
+extensions = [
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.graphviz',
+ 'sphinxcontrib.blockdiag',
+ 'sphinxcontrib.seqdiag',
+ 'sphinxcontrib.swaggerdoc',
+ 'sphinxcontrib.plantuml'
]
+#
+# Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
+# Change to {releasename} after you have created the new 'doc' branch.
+#
+
+branch = 'latest'
+
intersphinx_mapping = {}
+doc_url = 'https://docs.onap.org/projects'
+master_doc = 'index'
+
+exclude_patterns = ['.tox']
+
+spelling_word_list_filename='spelling_wordlist.txt'
+spelling_lang = "en_GB"
+
+#
+# Example:
+# intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
+#
html_last_updated_fmt = '%d-%b-%y %H:%M'
def setup(app):
- app.add_stylesheet("css/ribbon.css")
+ app.add_css_file("css/ribbon.css")
+
+linkcheck_ignore = [
+ r'http://localhost:\d+/'
+]
diff --git a/docs/conf.yaml b/docs/conf.yaml
deleted file mode 100644
index ab59281..0000000
--- a/docs/conf.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
----
-project_cfg: onap
-project: onap
-
-# Change this to ReleaseBranchName to modify the header
-default-version: latest
-#
diff --git a/docs/index.rst b/docs/index.rst
index 3328fe2..4ae19e5 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,10 +2,11 @@
.. _master_index:
Logging Documentation Repository
-----------------------------
+--------------------------------
.. toctree::
:maxdepth: 2
+ release-notes.rst
Logging_Enhancements_Project/logging_enhancements_project.rst
Logging_User_Guide/logging_user_guide.rst
ONAP_Log_Analytics/onap_log_analytics.rst
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index fabe723..dcaa4af 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -3,9 +3,6 @@
.. Copyright 2017 Bell Canada & Amdocs Intellectual Property. All rights reserved.
.. _release_notes:
-.. Links
-.. _release-notes-label:
-
Log Enhancements Release Notes
==============================
Version: 5.0.1 El Alto Release
@@ -20,28 +17,28 @@ El Alto
None
**Bug Fixes**
- - `LOG-826 <https://jira.onap.org/browse/LOG-826>`_ Vulnerability issue: removed jackson-databind
- - `LOG-1060 <https://jira.onap.org/browse/LOG-1060>`_ Vulnerability issue: Logging CLM: fix/address/red-flag jackson-databind-2.8.6 SEC
- - `LOG-836 <https://jira.onap.org/browse/LOG-836>`_ Vulnerability issue: glassfish bean-validator-2.4.0-b34.jar SEC
- - `LOG-874 <https://jira.onap.org/browse/LOG-874>`_ Vulnerability issue: fix/address/red-flag License org.json:json-20140107.jar
+ - `LOG-826 <https://lf-onap.atlassian.net/browse/LOG-826>`__ Vulnerability issue: removed jackson-databind
+ - `LOG-1060 <https://lf-onap.atlassian.net/browse/LOG-1060>`__ Vulnerability issue: Logging CLM: fix/address/red-flag jackson-databind-2.8.6 SEC
+ - `LOG-836 <https://lf-onap.atlassian.net/browse/LOG-836>`__ Vulnerability issue: glassfish bean-validator-2.4.0-b34.jar SEC
+ - `LOG-874 <https://lf-onap.atlassian.net/browse/LOG-874>`__ Vulnerability issue: fix/address/red-flag License org.json:json-20140107.jar
**Known Issues**
- - `LOG-1159 <https://jira.onap.org/browse/LOG-1159>`_ Vulnerability issue: logging-analytics version 5.0.9.RELEASE
+ - `LOG-1159 <https://lf-onap.atlassian.net/browse/LOG-1159>`__ Vulnerability issue: logging-analytics version 5.0.9.RELEASE
**Known Security Issues**
- - `OJSI-200 <https://jira.onap.org/browse/OJSI-200>`_ Logging exposes unprotected APIs/UIs (CVE-2019-12125)
- - `OJSI-155 <https://jira.onap.org/browse/OJSI-155>`_ LOG demo target exposes plain text HTTP endpoint using port 30398
- - `OJSI-125 <https://jira.onap.org/browse/OJSI-125>`_ log-es exposes plain text HTTP endpoint using port 30254
- - `OJSI-124 <https://jira.onap.org/browse/OJSI-124>`_ log-kibana exposes plain text HTTP endpoint using port 30253
- - `LOG-1114 <https://jira.onap.org/browse/LOG-1114>`_ Need for "ReadWriteMany" access on storage when deploying on Kubernetes?
+ - `OJSI-200 <https://lf-onap.atlassian.net/browse/OJSI-200>`__ Logging exposes unprotected APIs/UIs (CVE-2019-12125)
+ - `OJSI-155 <https://lf-onap.atlassian.net/browse/OJSI-155>`__ LOG demo target exposes plain text HTTP endpoint using port 30398
+ - `OJSI-125 <https://lf-onap.atlassian.net/browse/OJSI-125>`__ log-es exposes plain text HTTP endpoint using port 30254
+ - `OJSI-124 <https://lf-onap.atlassian.net/browse/OJSI-124>`__ log-kibana exposes plain text HTTP endpoint using port 30253
+ - `LOG-1114 <https://lf-onap.atlassian.net/browse/LOG-1114>`__ Need for "ReadWriteMany" access on storage when deploying on Kubernetes?
Quick Links:
- - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
+ - `LOG project page <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16234179/Logging+Enhancements+Project>`__
- - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
+ - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`__
- - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=68541351>`_
+ - `Project Vulnerability Review Table for LOG <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16395047/Logging+Frankfurt+Scope>`__
**Upgrade Notes**
None
@@ -72,43 +69,43 @@ El Alto
- None
**Bug Fixes**
- - `LOG-826 <https://jira.onap.org/browse/LOG-826>`_ Vulnerability issue: upgraded jackson-databind to version 2.9.9
- - `LOG-1067 <https://jira.onap.org/browse/LOG-1067>`_ Vulnerability issue: confirm rather or not commons-codec is needed for logging projects
- - `LOG-832 <https://jira.onap.org/browse/LOG-832>`_ Vulnerability issue: removed jackson-databind-2.4.5.jar from pomba-audit-common
- - `LOG-831 <https://jira.onap.org/browse/LOG-831>`_ Vulnerability issue: pomba-context-aggregator with javax.jms:jms-1.1.jar
- - `LOG-1061 <https://jira.onap.org/browse/LOG-1061>`_ Vulnerability issue: POMBA-AUDIT-COMMON fix/address/red-flag jackson-databind-2.4.5
- - `LOG-1063 <https://jira.onap.org/browse/LOG-1063>`_ Vulnerability issue: POMBA-SDNC-CONTEXT-BUILDER: upgraded plexus-utils to version 3.1.0
- - `LOG-1064 <https://jira.onap.org/browse/LOG-1064>`_ Vulnerability issue: POMBA-SDNC-CONTEXT-BUILDER: removed commons-beanutils : 1.9.3
- - `LOG-1116 <https://jira.onap.org/browse/LOG-1116>`_ Vulnerability issue: POMBA-SDNC-CONTEXT-BUILDER: removed commons-beanutils : 1.9.3
- - `LOG-1062 <https://jira.onap.org/browse/LOG-1062>`_ Vulnerability issue: POMBA-SDNC-CONTEXT-BUILDER: removed struts-core
- - `LOG-1121 <https://jira.onap.org/browse/LOG-1121>`_ Vulnerability issue: POMBA-CONTEXT-AGGREGATOR and POMBA-SDNC-CONTEXT-BUILDER: upgraded logback-classic to version 1.2.3
- - `LOG-830 <https://jira.onap.org/browse/LOG-830>`_ Vulnerability issue: Logging/POMBA CLM: fix/address/red-flag License org.json:json-20140107.jar
+ - `LOG-826 <https://lf-onap.atlassian.net/browse/LOG-826>`__ Vulnerability issue: upgraded jackson-databind to version 2.9.9
+ - `LOG-1067 <https://lf-onap.atlassian.net/browse/LOG-1067>`__ Vulnerability issue: confirm rather or not commons-codec is needed for logging projects
+ - `LOG-832 <https://lf-onap.atlassian.net/browse/LOG-832>`__ Vulnerability issue: removed jackson-databind-2.4.5.jar from pomba-audit-common
+ - `LOG-831 <https://lf-onap.atlassian.net/browse/LOG-831>`__ Vulnerability issue: pomba-context-aggregator with javax.jms:jms-1.1.jar
+ - `LOG-1061 <https://lf-onap.atlassian.net/browse/LOG-1061>`__ Vulnerability issue: POMBA-AUDIT-COMMON fix/address/red-flag jackson-databind-2.4.5
+ - `LOG-1063 <https://lf-onap.atlassian.net/browse/LOG-1063>`__ Vulnerability issue: POMBA-SDNC-CONTEXT-BUILDER: upgraded plexus-utils to version 3.1.0
+ - `LOG-1064 <https://lf-onap.atlassian.net/browse/LOG-1064>`__ Vulnerability issue: POMBA-SDNC-CONTEXT-BUILDER: removed commons-beanutils : 1.9.3
+ - `LOG-1116 <https://lf-onap.atlassian.net/browse/LOG-1116>`__ Vulnerability issue: POMBA-SDNC-CONTEXT-BUILDER: removed commons-beanutils : 1.9.3
+ - `LOG-1062 <https://lf-onap.atlassian.net/browse/LOG-1062>`__ Vulnerability issue: POMBA-SDNC-CONTEXT-BUILDER: removed struts-core
+ - `LOG-1121 <https://lf-onap.atlassian.net/browse/LOG-1121>`__ Vulnerability issue: POMBA-CONTEXT-AGGREGATOR and POMBA-SDNC-CONTEXT-BUILDER: upgraded logback-classic to version 1.2.3
+ - `LOG-830 <https://lf-onap.atlassian.net/browse/LOG-830>`__ Vulnerability issue: Logging/POMBA CLM: fix/address/red-flag License org.json:json-20140107.jar
**Known Issues**
- - `LOG-1017 <https://jira.onap.org/browse/LOG-1017>`_ Violations are thrown on attributes that are same (or missing)
- - `LOG-1016 <https://jira.onap.org/browse/LOG-1016>`_ When comparing attributes from multiple sources, violations thrown do not accurately show the issue.
- - `LOG-769 <https://jira.onap.org/browse/LOG-769>`_ POMBA aai ctx pod reports HD full - but DF shows HD is OK
- - `LOG-827 <https://jira.onap.org/browse/LOG-827>`_ Vulnerability issue: POMBA-SDNC-CONTEXT-BUILDER handlebars 2.0.0
- - `LOG-1118 <https://jira.onap.org/browse/LOG-1118>`_ Vulnerability issue: POMBA-SDNC-CONTEXT-BUILDER and POMBA-NETWORK-DISCOVERY-CONTEXT-BUILDER js-yaml
- - `LOG-1117 <https://jira.onap.org/browse/LOG-1117>`_ Vulnerability issue: POMBA-SDNC-CONTEXT-BUILDER and POMBA-NETWORK-DISCOVERY-CONTEXT-BUILDER uikit
- - `LOG-1160 <https://jira.onap.org/browse/LOG-1160>`_ Vulnerability issue: jackson-databind 2.9.9
- - `LOG-1016 <https://jira.onap.org/browse/LOG-1016>`_ When comparing attributes from multiple sources, violations thrown do not accurately show the issue.
- - `LOG-1017 <https://jira.onap.org/browse/LOG-1017>`_ Violations are thrown on attributes that are same (or missing)
- - `LOG-1051 <https://jira.onap.org/browse/LOG-1051>`_ pomba-data-router do not start due to wrong AAi configuration (with Dublin release of the data router but works with the Casablanca version)
- - `LOG-1084 <https://jira.onap.org/browse/LOG-1084>`_ Need authentication for pomba-kibana (node port = 30234)
- - `LOG-1085 <https://jira.onap.org/browse/LOG-1085>`_ Need authentication for logging-elasticsearch (node port = 30254)
- - `LOG-1086 <https://jira.onap.org/browse/LOG-1086>`_ Need authentication for logging-kibana (node port = 30253)
- - `LOG-1114 <https://jira.onap.org/browse/LOG-1114>`_ Need for "ReadWriteMany" access on storage when deploying on Kubernetes?
+ - `LOG-1017 <https://lf-onap.atlassian.net/browse/LOG-1017>`__ Violations are thrown on attributes that are same (or missing)
+ - `LOG-1016 <https://lf-onap.atlassian.net/browse/LOG-1016>`__ When comparing attributes from multiple sources, violations thrown do not accurately show the issue.
+ - `LOG-769 <https://lf-onap.atlassian.net/browse/LOG-769>`__ POMBA aai ctx pod reports HD full - but DF shows HD is OK
+ - `LOG-827 <https://lf-onap.atlassian.net/browse/LOG-827>`__ Vulnerability issue: POMBA-SDNC-CONTEXT-BUILDER handlebars 2.0.0
+ - `LOG-1118 <https://lf-onap.atlassian.net/browse/LOG-1118>`__ Vulnerability issue: POMBA-SDNC-CONTEXT-BUILDER and POMBA-NETWORK-DISCOVERY-CONTEXT-BUILDER js-yaml
+ - `LOG-1117 <https://lf-onap.atlassian.net/browse/LOG-1117>`__ Vulnerability issue: POMBA-SDNC-CONTEXT-BUILDER and POMBA-NETWORK-DISCOVERY-CONTEXT-BUILDER uikit
+ - `LOG-1160 <https://lf-onap.atlassian.net/browse/LOG-1160>`__ Vulnerability issue: jackson-databind 2.9.9
+ - `LOG-1016 <https://lf-onap.atlassian.net/browse/LOG-1016>`__ When comparing attributes from multiple sources, violations thrown do not accurately show the issue.
+ - `LOG-1017 <https://lf-onap.atlassian.net/browse/LOG-1017>`__ Violations are thrown on attributes that are same (or missing)
+ - `LOG-1051 <https://lf-onap.atlassian.net/browse/LOG-1051>`__ pomba-data-router do not start due to wrong AAi configuration (with Dublin release of the data router but works with the Casablanca version)
+ - `LOG-1084 <https://lf-onap.atlassian.net/browse/LOG-1084>`__ Need authentication for pomba-kibana (node port = 30234)
+ - `LOG-1085 <https://lf-onap.atlassian.net/browse/LOG-1085>`__ Need authentication for logging-elasticsearch (node port = 30254)
+ - `LOG-1086 <https://lf-onap.atlassian.net/browse/LOG-1086>`__ Need authentication for logging-kibana (node port = 30253)
+ - `LOG-1114 <https://lf-onap.atlassian.net/browse/LOG-1114>`__ Need for "ReadWriteMany" access on storage when deploying on Kubernetes?
**Known Security Issues**
- - `OJSI-123 <https://jira.onap.org/browse/OJSI-123>`_ pomba-data-router exposes plain text HTTP endpoint using port 30249
- - `OJSI-115 <https://jira.onap.org/browse/OJSI-115>`_ pomba-kibana exposes plain text HTTP endpoint using port 30234
+ - `OJSI-123 <https://lf-onap.atlassian.net/browse/OJSI-123>`__ pomba-data-router exposes plain text HTTP endpoint using port 30249
+ - `OJSI-115 <https://lf-onap.atlassian.net/browse/OJSI-115>`__ pomba-kibana exposes plain text HTTP endpoint using port 30234
-POMBA code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/display/DW/El+Alto+Vulnerabilities>`_.
+POMBA code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16621956/Logging+El+Alto+Release>`__.
Quick Links:
- - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
+ - `POMBA project page <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16280439/POMBA>`__
**Upgrade Notes**
None
@@ -131,21 +128,21 @@ El Alto Early Drop
None
**Bug Fixes**
- - `LOG-1066 <https://jira.onap.org/browse/LOG-1066>`_ Vulnerability issue: upgrade org.apache.tomcat.embed.tomcat-embed-core to 8.5.42
- - `LOG-1067 <https://jira.onap.org/browse/LOG-1067>`_ Vulnerability issue: confirm rather or not commons-codec is needed for logging projects
+ - `LOG-1066 <https://lf-onap.atlassian.net/browse/LOG-1066>`__ Vulnerability issue: upgrade org.apache.tomcat.embed.tomcat-embed-core to 8.5.42
+ - `LOG-1067 <https://lf-onap.atlassian.net/browse/LOG-1067>`__ Vulnerability issue: confirm rather or not commons-codec is needed for logging projects
**Known Issues**
**Security Notes**
-LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/display/DW/El+Alto+Vulnerabilities>`_.
+LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16621956/Logging+El+Alto+Release>`__.
Quick Links:
- - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
+ - `LOG project page <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16234179/Logging+Enhancements+Project>`__
- - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
+ - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`__
- - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=68541351>`_
+ - `Project Vulnerability Review Table for LOG <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16395047/Logging+Frankfurt+Scope>`__
**Upgrade Notes**
None
@@ -176,34 +173,34 @@ El Alto Early Drop
- None
**Bug Fixes**
- - `LOG-1066 <https://jira.onap.org/browse/LOG-1066>`_ Vulnerability issue: upgrade org.apache.tomcat.embed.tomcat-embed-core to 8.5.42
- - `LOG-1067 <https://jira.onap.org/browse/LOG-1067>`_ Vulnerability issue: confirm rather or not commons-codec is needed for logging projects
+ - `LOG-1066 <https://lf-onap.atlassian.net/browse/LOG-1066>`__ Vulnerability issue: upgrade org.apache.tomcat.embed.tomcat-embed-core to 8.5.42
+ - `LOG-1067 <https://lf-onap.atlassian.net/browse/LOG-1067>`__ Vulnerability issue: confirm rather or not commons-codec is needed for logging projects
**Known Issues**
- - `LOG-1017 <https://jira.onap.org/browse/LOG-1017>`_ Violations are thrown on attributes that are same (or missing)
- - `LOG-1016 <https://jira.onap.org/browse/LOG-1016>`_ When comparing attributes from multiple sources, violations thrown do not accurately show the issue.
- - `LOG-836 <https://jira.onap.org/browse/LOG-836>`_ Logging/POMBA CLM: fix/address/red-flag glassfish bean-validator-2.4.0-b34.jar SEC
- - `LOG-874 <https://jira.onap.org/browse/LOG-874>`_ Logging CLM: fix/address/red-flag License org.json:json-20140107.jar
- - `LOG-832 <https://jira.onap.org/browse/LOG-832>`_ Logging/POMBA CLM: fix/address/red-flag SEC jackson-databind-2.4.5.jar - auditcommon - even 2.9.7 is still red
- - `LOG-831 <https://jira.onap.org/browse/LOG-831>`_ Logging/POMBA CLM: fix/address/red-flag License javax.jms:jms-1.1.jar
- - `LOG-769 <https://jira.onap.org/browse/LOG-769>`_ POMBA aai ctx pod reports HD full - but DF shows HD is OK
- - `LOG-826 <https://jira.onap.org/browse/LOG-826>`_ Logging/POMBA CLM: fix/address/red-flag jackson-databind-2.8.11.3 SEC
- - `LOG-1060 <https://jira.onap.org/browse/LOG-1060>`_ Logging CLM: fix/address/red-flag jackson-databind-2.8.6 SEC
- - `LOG-1061 <https://jira.onap.org/browse/LOG-1061>`_ POMBA-AUDIT-COMMON CLM: fix/address/red-flag jackson-databind-2.4.5 SEC
- - `LOG-1063 <https://jira.onap.org/browse/LOG-1063>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag plexus-utils : 3.0.22 SEC
- - `LOG-1064 <https://jira.onap.org/browse/LOG-1064>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag commons-beanutils : 1.9.3 SEC
- - `LOG-1062 <https://jira.onap.org/browse/LOG-1062>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag struts-core : 1.3.8-2.4.5 SEC
- - `LOG-827 <https://jira.onap.org/browse/LOG-827>`_ Logging/POMBA CLM: fix/address/red-flag handlebars-2.0.0.js SEC - upgrade to 4.0.0+
- - `LOG-830 <https://jira.onap.org/browse/LOG-830>`_ Logging/POMBA CLM: fix/address/red-flag License org.json:json-20140107.jar
+ - `LOG-1017 <https://lf-onap.atlassian.net/browse/LOG-1017>`__ Violations are thrown on attributes that are same (or missing)
+ - `LOG-1016 <https://lf-onap.atlassian.net/browse/LOG-1016>`__ When comparing attributes from multiple sources, violations thrown do not accurately show the issue.
+ - `LOG-836 <https://lf-onap.atlassian.net/browse/LOG-836>`__ Logging/POMBA CLM: fix/address/red-flag glassfish bean-validator-2.4.0-b34.jar SEC
+ - `LOG-874 <https://lf-onap.atlassian.net/browse/LOG-874>`__ Logging CLM: fix/address/red-flag License org.json:json-20140107.jar
+ - `LOG-832 <https://lf-onap.atlassian.net/browse/LOG-832>`__ Logging/POMBA CLM: fix/address/red-flag SEC jackson-databind-2.4.5.jar - auditcommon - even 2.9.7 is still red
+ - `LOG-831 <https://lf-onap.atlassian.net/browse/LOG-831>`__ Logging/POMBA CLM: fix/address/red-flag License javax.jms:jms-1.1.jar
+ - `LOG-769 <https://lf-onap.atlassian.net/browse/LOG-769>`__ POMBA aai ctx pod reports HD full - but DF shows HD is OK
+ - `LOG-826 <https://lf-onap.atlassian.net/browse/LOG-826>`__ Logging/POMBA CLM: fix/address/red-flag jackson-databind-2.8.11.3 SEC
+ - `LOG-1060 <https://lf-onap.atlassian.net/browse/LOG-1060>`__ Logging CLM: fix/address/red-flag jackson-databind-2.8.6 SEC
+ - `LOG-1061 <https://lf-onap.atlassian.net/browse/LOG-1061>`__ POMBA-AUDIT-COMMON CLM: fix/address/red-flag jackson-databind-2.4.5 SEC
+ - `LOG-1063 <https://lf-onap.atlassian.net/browse/LOG-1063>`__ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag plexus-utils : 3.0.22 SEC
+ - `LOG-1064 <https://lf-onap.atlassian.net/browse/LOG-1064>`__ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag commons-beanutils : 1.9.3 SEC
+ - `LOG-1062 <https://lf-onap.atlassian.net/browse/LOG-1062>`__ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag struts-core : 1.3.8-2.4.5 SEC
+ - `LOG-827 <https://lf-onap.atlassian.net/browse/LOG-827>`__ Logging/POMBA CLM: fix/address/red-flag handlebars-2.0.0.js SEC - upgrade to 4.0.0+
+ - `LOG-830 <https://lf-onap.atlassian.net/browse/LOG-830>`__ Logging/POMBA CLM: fix/address/red-flag License org.json:json-20140107.jar
**Security Notes**
- all nodeports for Kibana, context builders and data-router are open by default for now
-POMBA code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/display/DW/El+Alto+Vulnerabilities>`_.
+POMBA code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16621956/Logging+El+Alto+Release>`__.
Quick Links:
- - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
+ - `POMBA project page <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16280439/POMBA>`__
**Upgrade Notes**
None
@@ -229,14 +226,14 @@ Dublin
**Known Issues**
**Security Notes**
- - LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64008625>`_.
+ - LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16395047/Logging+Frankfurt+Scope>`__.
Quick Links:
- - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
+ - `LOG project page <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16234179/Logging+Enhancements+Project>`__
- - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
+ - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`__
- - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=51282493>`_
+ - `Project Vulnerability Review Table for LOG <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16395047/Logging+Frankfurt+Scope>`__
**Upgrade Notes**
None
@@ -272,29 +269,29 @@ Dublin
**Known Issues**
- - `LOG-1017 <https://jira.onap.org/browse/LOG-1017>`_ Violations are thrown on attributes that are same (or missing)
- - `LOG-1016 <https://jira.onap.org/browse/LOG-1016>`_ When comparing attributes from multiple sources, violations thrown do not accurately show the issue.
- - `LOG-836 <https://jira.onap.org/browse/LOG-836>`_ Logging/POMBA CLM: fix/address/red-flag glassfish bean-validator-2.4.0-b34.jar SEC
- - `LOG-874 <https://jira.onap.org/browse/LOG-874>`_ Logging CLM: fix/address/red-flag License org.json:json-20140107.jar
- - `LOG-832 <https://jira.onap.org/browse/LOG-832>`_ Logging/POMBA CLM: fix/address/red-flag SEC jackson-databind-2.4.5.jar - auditcommon - even 2.9.7 is still red
- - `LOG-831 <https://jira.onap.org/browse/LOG-831>`_ Logging/POMBA CLM: fix/address/red-flag License javax.jms:jms-1.1.jar
- - `LOG-769 <https://jira.onap.org/browse/LOG-769>`_ POMBA aai ctx pod reports HD full - but DF shows HD is OK
- - `LOG-826 <https://jira.onap.org/browse/LOG-826>`_ Logging/POMBA CLM: fix/address/red-flag jackson-databind-2.8.11.3 SEC
- - `LOG-1060 <https://jira.onap.org/browse/LOG-1060>`_ Logging CLM: fix/address/red-flag jackson-databind-2.8.6 SEC
- - `LOG-1061 <https://jira.onap.org/browse/LOG-1061>`_ POMBA-AUDIT-COMMON CLM: fix/address/red-flag jackson-databind-2.4.5 SEC
- - `LOG-1063 <https://jira.onap.org/browse/LOG-1063>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag plexus-utils : 3.0.22 SEC
- - `LOG-1064 <https://jira.onap.org/browse/LOG-1064>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag commons-beanutils : 1.9.3 SEC
- - `LOG-1062 <https://jira.onap.org/browse/LOG-1062>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag struts-core : 1.3.8-2.4.5 SEC
- - `LOG-827 <https://jira.onap.org/browse/LOG-827>`_ Logging/POMBA CLM: fix/address/red-flag handlebars-2.0.0.js SEC - upgrade to 4.0.0+
- - `LOG-830 <https://jira.onap.org/browse/LOG-830>`_ Logging/POMBA CLM: fix/address/red-flag License org.json:json-20140107.jar
+ - `LOG-1017 <https://lf-onap.atlassian.net/browse/LOG-1017>`__ Violations are thrown on attributes that are same (or missing)
+ - `LOG-1016 <https://lf-onap.atlassian.net/browse/LOG-1016>`__ When comparing attributes from multiple sources, violations thrown do not accurately show the issue.
+ - `LOG-836 <https://lf-onap.atlassian.net/browse/LOG-836>`__ Logging/POMBA CLM: fix/address/red-flag glassfish bean-validator-2.4.0-b34.jar SEC
+ - `LOG-874 <https://lf-onap.atlassian.net/browse/LOG-874>`__ Logging CLM: fix/address/red-flag License org.json:json-20140107.jar
+ - `LOG-832 <https://lf-onap.atlassian.net/browse/LOG-832>`__ Logging/POMBA CLM: fix/address/red-flag SEC jackson-databind-2.4.5.jar - auditcommon - even 2.9.7 is still red
+ - `LOG-831 <https://lf-onap.atlassian.net/browse/LOG-831>`__ Logging/POMBA CLM: fix/address/red-flag License javax.jms:jms-1.1.jar
+ - `LOG-769 <https://lf-onap.atlassian.net/browse/LOG-769>`__ POMBA aai ctx pod reports HD full - but DF shows HD is OK
+ - `LOG-826 <https://lf-onap.atlassian.net/browse/LOG-826>`__ Logging/POMBA CLM: fix/address/red-flag jackson-databind-2.8.11.3 SEC
+ - `LOG-1060 <https://lf-onap.atlassian.net/browse/LOG-1060>`__ Logging CLM: fix/address/red-flag jackson-databind-2.8.6 SEC
+ - `LOG-1061 <https://lf-onap.atlassian.net/browse/LOG-1061>`__ POMBA-AUDIT-COMMON CLM: fix/address/red-flag jackson-databind-2.4.5 SEC
+ - `LOG-1063 <https://lf-onap.atlassian.net/browse/LOG-1063>`__ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag plexus-utils : 3.0.22 SEC
+ - `LOG-1064 <https://lf-onap.atlassian.net/browse/LOG-1064>`__ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag commons-beanutils : 1.9.3 SEC
+ - `LOG-1062 <https://lf-onap.atlassian.net/browse/LOG-1062>`__ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag struts-core : 1.3.8-2.4.5 SEC
+ - `LOG-827 <https://lf-onap.atlassian.net/browse/LOG-827>`__ Logging/POMBA CLM: fix/address/red-flag handlebars-2.0.0.js SEC - upgrade to 4.0.0+
+ - `LOG-830 <https://lf-onap.atlassian.net/browse/LOG-830>`__ Logging/POMBA CLM: fix/address/red-flag License org.json:json-20140107.jar
**Security Notes**
- all nodeports for Kibana, context builders and data-router are open by default for now
-POMBA code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64008625>`_.
+POMBA code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16395047/Logging+Frankfurt+Scope>`__.
Quick Links:
- - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
+ - `POMBA project page <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16280439/POMBA>`__
**Upgrade Notes**
None
@@ -318,23 +315,23 @@ Casablanca
- NFS support for AWS EFS
**Bug Fixes**
- - `LOG-837 <https://jira.onap.org/browse/LOG-837>`_ Logging/POMBA CLM: fix/address/red-flag spring-mvc-5.1.2 pulls in spring-web-5.0.9
+ - `LOG-837 <https://lf-onap.atlassian.net/browse/LOG-837>`__ Logging/POMBA CLM: fix/address/red-flag spring-mvc-5.1.2 pulls in spring-web-5.0.9
**Known Issues**
- - `LOG-376 <https://jira.onap.org/browse/LOG-376>`_ Logstash load balancing is asymmetric wherever AAI is run
- - `LOG-895 <https://jira.onap.org/browse/LOG-895>`_ Upgrade Rancher to 1.6.25 to address CVE-2018-1002105 and move to Kubernetes 1.11.5 (server side)
+ - `LOG-376 <https://lf-onap.atlassian.net/browse/LOG-376>`__ Logstash load balancing is asymmetric wherever AAI is run
+ - `LOG-895 <https://lf-onap.atlassian.net/browse/LOG-895>`__ Upgrade Rancher to 1.6.25 to address CVE-2018-1002105 and move to Kubernetes 1.11.5 (server side)
**Security Notes**
-LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_.
+LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16395047/Logging+Frankfurt+Scope>`__.
Quick Links:
- - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
+ - `LOG project page <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16234179/Logging+Enhancements+Project>`__
- - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
+ - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`__
- - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_
+ - `Project Vulnerability Review Table for LOG <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16395047/Logging+Frankfurt+Scope>`__
**Upgrade Notes**
None
@@ -366,20 +363,20 @@ Casablanca
**Bug Fixes**
- - `LOG-892 <https://jira.onap.org/browse/LOG-892`_ PORT - POMBA Network Discovery Context Builder does not log
+ - `LOG-892 <https://lf-onap.atlassian.net/browse/LOG-892>`__ PORT - POMBA Network Discovery Context Builder does not log
**Known Issues**
- - `LOG-913 <https://jira.onap.org/browse/LOG-913>`_ POMBA: 1 of 11 pods failing on sequenced startup on 3.0.0-ONAP - pomba is 22 on the order - looks timing related
- - `LOG-950 <https://jira.onap.org/browse/LOG-950>`_ LOG-950 upped the numbers from 10 to 30 - for intermittent deploy timing - this is an issue for several projects since 3.0.0-ONAP - the solution is a sequenced 5h deploy via `cd.sh <https://git.onap.org/logging-analytics/tree/deploy/cd.sh#n228>`_ and/or better vms for now until the `dependencies <https://wiki.onap.org/display/DW/Log+Streaming+Compliance+and+API#LogStreamingComplianceandAPI-DeploymentDependencyTree-Containerlevel>`_ and jobs are refactored into helm hooks
+ - `LOG-913 <https://lf-onap.atlassian.net/browse/LOG-913>`__ POMBA: 1 of 11 pods failing on sequenced startup on 3.0.0-ONAP - pomba is 22 on the order - looks timing related
+ - `LOG-950 <https://lf-onap.atlassian.net/browse/LOG-950>`__ LOG-950 upped the numbers from 10 to 30 - for intermittent deploy timing - this is an issue for several projects since 3.0.0-ONAP - the solution is a sequenced 5h deploy via `cd.sh <https://git.onap.org/logging-analytics/tree/deploy/cd.sh#n228>`__ and/or better vms for now until the `dependencies <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16330353/Log+Streaming+Compliance+and+API>`__ and jobs are refactored into helm hooks
**Security Notes**
- all three nodeports for kibana, context builder and data-router are open by default for now
-POMBA code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_.
+POMBA code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16395047/Logging+Frankfurt+Scope>`__.
Quick Links:
- - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
+ - `POMBA project page <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16280439/POMBA>`__
**Upgrade Notes**
None
@@ -403,18 +400,18 @@ Version: 1.2.2 Casablanca
**Known Issues**
- - `Logstash load balancing is asymmetric wherever AAI is run <https://jira.onap.org/browse/LOG-376>`_
+ - `Logstash load balancing is asymmetric wherever AAI is run <https://lf-onap.atlassian.net/browse/LOG-376>`__
**Security Notes**
-LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_.
+LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16395047/Logging+Frankfurt+Scope>`__.
Quick Links:
- - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
+ - `LOG project page <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16234179/Logging+Enhancements+Project>`__
- - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
+ - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`__
- - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_
+ - `Project Vulnerability Review Table for LOG <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16395047/Logging+Frankfurt+Scope>`__
**Upgrade Notes**
None
@@ -456,10 +453,10 @@ Casablanca
**Security Notes**
- all three nodeports for kibana, context builder and data-router are open by default for now
-POMBA code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_.
+POMBA code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16395047/Logging+Frankfurt+Scope>`__.
Quick Links:
- - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
+ - `POMBA project page <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16280439/POMBA>`__
**Upgrade Notes**
None
@@ -477,7 +474,7 @@ Version: Beijing
**New Features**
- Logstash is a daemonset (clustered at 1 container per VM)
- - `The following applications send logs to the ELK stack - <https://jira.onap.org/browse/LOG-230>`_
+ - `The following applications send logs to the ELK stack - <https://lf-onap.atlassian.net/browse/LOG-230>`__
**Bug Fixes**
@@ -488,14 +485,14 @@ Version: Beijing
**Security Notes**
- all three nodeports for logstash, elasticsearch and kibana are open by default for now
-LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_.
+LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16395047/Logging+Frankfurt+Scope>`__.
Quick Links:
- - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
+ - `LOG project page <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16234179/Logging+Enhancements+Project>`__
- - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
+ - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`__
- - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_
+ - `Project Vulnerability Review Table for LOG <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16395047/Logging+Frankfurt+Scope>`__
**Upgrade Notes**
None
@@ -517,31 +514,31 @@ Version: 1.0.0
This release adds Elastic Stack analytics deployment to OOM, aligns logging provider configurations, and fixes issues with the propagation of transaction IDs and other contextual information.
- - `LOG-1 <https://jira.onap.org/browse/LOG-1>`_ Transaction ID propagation.
- - `LOG-2 <https://jira.onap.org/browse/LOG-2>`_ Standardized logging provider configuration.
- - `LOG-3 <https://jira.onap.org/browse/LOG-3>`_ Elastic Stack reference analytics pipeline.
- - `LOG-4 <https://jira.onap.org/browse/LOG-4>`_ Transaction ID conventions.
+ - `LOG-1 <https://lf-onap.atlassian.net/browse/LOG-1>`__ Transaction ID propagation.
+ - `LOG-2 <https://lf-onap.atlassian.net/browse/LOG-2>`__ Standardized logging provider configuration.
+ - `LOG-3 <https://lf-onap.atlassian.net/browse/LOG-3>`__ Elastic Stack reference analytics pipeline.
+ - `LOG-4 <https://lf-onap.atlassian.net/browse/LOG-4>`__ Transaction ID conventions.
**Bug Fixes**
- - `LOG-64 <https://jira.onap.org/browse/LOG-64>`_ Logger field has a length restriction of 36 which needs a fix.
- - `LOG-74 <https://jira.onap.org/browse/LOG-74>`_ Extract componentName from the source path of log files.
+ - `LOG-64 <https://lf-onap.atlassian.net/browse/LOG-64>`__ Logger field has a length restriction of 36 which needs a fix.
+ - `LOG-74 <https://lf-onap.atlassian.net/browse/LOG-74>`__ Extract componentName from the source path of log files.
**Known Issues**
- - `LOG-43 <https://jira.onap.org/browse/LOG-43>`_
+ - `LOG-43 <https://lf-onap.atlassian.net/browse/LOG-43>`__
Unable to find logback xml for DMaaP component.
Logging file for DMaaP is available in this jar "eelf-core-0.0.1.jar".
- - `LOG-65 <https://jira.onap.org/browse/LOG-65>`_
+ - `LOG-65 <https://lf-onap.atlassian.net/browse/LOG-65>`__
SO Logging Provider Config File need correction in Timestamp MDC.
Logging provider configuration file for SO i.e. logback files requires correction in Timestamp MDC for correct MDC generation in log.
The current pattern prints Timestamp as 2017-09-25 05:30:07,832. Expected pattern is - 2017-09-25T05:30:07.832Z.
- - `LOG-80 <https://jira.onap.org/browse/LOG-80>`_ Kibana does not seem to show all the logs from application pods.
+ - `LOG-80 <https://lf-onap.atlassian.net/browse/LOG-80>`__ Kibana does not seem to show all the logs from application pods.
The content of the log directories (/var/log/onap/mso) are not 100% reflected in Kibana.
- - `LOG-88 <https://jira.onap.org/browse/LOG-88>`_
+ - `LOG-88 <https://lf-onap.atlassian.net/browse/LOG-88>`__
SO log format error during Health Check - blocking tracking jira for SO-246.
**Security Issues**
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index b3188dd..d7f6b82 100644
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -4,7 +4,7 @@ doc8
docutils
setuptools
six
-sphinx_rtd_theme>=0.4.3
+sphinx_rtd_theme>=1.0.0
sphinxcontrib-blockdiag
sphinxcontrib-needs>=0.2.3
sphinxcontrib-nwdiag
diff --git a/docs/tox.ini b/docs/tox.ini
index edac8c3..46075fa 100644
--- a/docs/tox.ini
+++ b/docs/tox.ini
@@ -1,22 +1,31 @@
[tox]
minversion = 1.6
-envlist = docs,
+envlist = docs,docs-linkcheck,docs-spellcheck
skipsdist = true
[testenv:docs]
-basepython = python3
-deps = -r{toxinidir}/requirements-docs.txt
+basepython = python3.8
+deps =
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://releases.openstack.org/constraints/upper/yoga
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
commands =
- sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
- echo "Generated docs available in {toxinidir}/_build/html"
-whitelist_externals =
- echo
- git
- sh
+ sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
[testenv:docs-linkcheck]
-basepython = python3
-#deps = -r{toxinidir}/requirements-docs.txt
-commands = echo "Link Checking not enforced"
-#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
-whitelist_externals = echo
+basepython = python3.8
+deps =
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://releases.openstack.org/constraints/upper/yoga
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
+commands =
+ sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
+
+[testenv:docs-spellcheck]
+basepython = python3.8
+deps =
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://releases.openstack.org/constraints/upper/yoga
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
+commands =
+ sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck
diff --git a/reference/logging-demo/pom.xml b/reference/logging-demo/pom.xml
index cb0baf7..2ecdc72 100644
--- a/reference/logging-demo/pom.xml
+++ b/reference/logging-demo/pom.xml
@@ -17,7 +17,7 @@
<jackson-2-version>2.8.6</jackson-2-version>
<!-- https://mvnrepository.com/artifact/org.springframework/spring-aop/5.0.5.RELEASE -->
<spring.version>5.1.2.RELEASE</spring.version>
- <logback.version>1.2.3</logback.version>
+ <logback.version>1.2.13</logback.version>
</properties>
<dependencies>
diff --git a/reference/logging-library/pom.xml b/reference/logging-library/pom.xml
index a7b7ba2..b326c22 100644
--- a/reference/logging-library/pom.xml
+++ b/reference/logging-library/pom.xml
@@ -15,7 +15,7 @@
<properties>
<spring.version>5.1.2.RELEASE</spring.version>
- <logback.version>1.2.3</logback.version>
+ <logback.version>1.2.13</logback.version>
</properties>
<dependencies>
diff --git a/reference/logging-slf4j-demo/pom.xml b/reference/logging-slf4j-demo/pom.xml
index 63830b6..50a8de7 100644
--- a/reference/logging-slf4j-demo/pom.xml
+++ b/reference/logging-slf4j-demo/pom.xml
@@ -19,7 +19,7 @@
- which spring-boot 1.5.15 brings in spring-expression 4.3.14 goes to 4.3.17 under 1.5.15 1.5.17 ups jackson-databind from 2.8.11.2 - but we will likely need 2.9+ -->
<springframework.boot.version>1.5.22.RELEASE</springframework.boot.version>
<spring.version>5.1.2.RELEASE</spring.version>
- <logback.version>1.2.3</logback.version>
+ <logback.version>1.2.13</logback.version>
</properties>
<dependencyManagement>
diff --git a/reference/logging-slf4j/pom.xml b/reference/logging-slf4j/pom.xml
index 57a7107..0a926e1 100644
--- a/reference/logging-slf4j/pom.xml
+++ b/reference/logging-slf4j/pom.xml
@@ -15,7 +15,7 @@
<properties>
<spring.version>5.0.9.RELEASE</spring.version>
- <logback.version>1.2.3</logback.version>
+ <logback.version>1.2.13</logback.version>
</properties>
<dependencyManagement>