diff options
| -rw-r--r-- | .gitreview | 1 | ||||
| -rw-r--r-- | docs/conf.py | 3 | ||||
| -rw-r--r-- | docs/platform/architecture.rst | 2 | ||||
| -rw-r--r-- | docs/platform/configuration.rst | 2 | ||||
| -rw-r--r-- | docs/platform/consumedapis.rst | 2 | ||||
| -rw-r--r-- | docs/platform/human-interfaces.rst | 2 | ||||
| -rw-r--r-- | docs/platform/installation.rst | 2 | ||||
| -rw-r--r-- | docs/platform/log-and-diagnostic-info.rst | 2 | ||||
| -rw-r--r-- | docs/release-notes.rst | 48 |
9 files changed, 58 insertions, 6 deletions
@@ -2,3 +2,4 @@ host=gerrit.onap.org port=29418 project=holmes/rule-management.git +defaultbranch=master diff --git a/docs/conf.py b/docs/conf.py index 13d37b9..db098a7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,8 @@ from docs_conf.conf import * +release = "master" +version = "master" + branch = 'latest' master_doc = 'index' diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst index e5d63e4..c952c20 100644 --- a/docs/platform/architecture.rst +++ b/docs/platform/architecture.rst @@ -5,7 +5,7 @@ Holmes Architecture ------------------- -Basically, Holmes itself is an independent component in ONAP, which means it could be deployed as an ONAP-level component. In the Jakarta release, Holmes is more generally a DCAE analytic application. It is deployed by DCAE and run as an analytic application on top of it. Also, it could be considered as a filter of the Policy component because it reduces the number of the input messages of Policy. +Basically, Holmes itself is an independent component in ONAP, which means it could be deployed as an ONAP-level component. In the Kohn release, Holmes is more generally a DCAE analytic application. It is deployed by DCAE and run as an analytic application on top of it. Also, it could be considered as a filter of the Policy component because it reduces the number of the input messages of Policy. .. image:: images/overall-architecture-in-onap.png diff --git a/docs/platform/configuration.rst b/docs/platform/configuration.rst index 7bbcf05..db3dda8 100644 --- a/docs/platform/configuration.rst +++ b/docs/platform/configuration.rst @@ -4,5 +4,5 @@ Configuration ------------- -No machanism for customized configurtions is provided in the Jakarta release. Such functionalities will be provided in the future if necessary. +No machanism for customized configurtions is provided in the Kohn release. Such functionalities will be provided in the future if necessary. diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst index 338dab0..c0e1691 100644 --- a/docs/platform/consumedapis.rst +++ b/docs/platform/consumedapis.rst @@ -4,7 +4,7 @@ Consumed APIs ------------- -In the Jakarta release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB. +In the Kohn release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB. DCAE ^^^^ diff --git a/docs/platform/human-interfaces.rst b/docs/platform/human-interfaces.rst index 3111c08..3a36f4c 100644 --- a/docs/platform/human-interfaces.rst +++ b/docs/platform/human-interfaces.rst @@ -7,7 +7,7 @@ Human Interfaces Target Users ^^^^^^^^^^^^ -The human interfaces provided in the Jakarta release by Holmes is intended for the developers rather than the end users. +The human interfaces provided in the Kohn release by Holmes is intended for the developers rather than the end users. Interface Type ^^^^^^^^^^^^^^ diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst index dad9cfd..26547d1 100644 --- a/docs/platform/installation.rst +++ b/docs/platform/installation.rst @@ -4,7 +4,7 @@ Installation ------------ -In the Jakarta release, Holmes could either be deployed as an analytics application of DCAE along with the whole ONAP or be deployed in a standalone mode for the sake of saving resources. +In the Kohn release, Holmes could either be deployed as an analytics application of DCAE along with the whole ONAP or be deployed in a standalone mode for the sake of saving resources. If a user wants to deploy Holmes using Helm, please refer to the OOM manual for help. diff --git a/docs/platform/log-and-diagnostic-info.rst b/docs/platform/log-and-diagnostic-info.rst index e588e11..73b5c5b 100644 --- a/docs/platform/log-and-diagnostic-info.rst +++ b/docs/platform/log-and-diagnostic-info.rst @@ -4,7 +4,7 @@ Logging & Diagnostic Information --------------------------------- -In the Jakarta release, the logs are kept inside the docker containers, which means that you can get the log information only when the docker is still running. +In the Kohn release, the logs are kept inside the docker containers, which means that you can get the log information only when the docker is still running. Where to Access Information ^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 9f5db0c..dd804b1 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -11,6 +11,54 @@ and services, including hosts, vims, VNFs and NSs. Holmes aims to find the root reason which causes the failure or degradation of services by digging into the ocean of events collected from different levels of the telecom cloud. +Version: 11.0.0 +--------------- + +:Release Date: 2022-11-10 + + +**New Features** + +- `Migrate from Dropwizard to Springboot <https://jira.onap.org/browse/HOLMES-511>`_ + +**Bug Fixes** + +- `Nginx stops working. Holmes UI is not available. <https://jira.onap.org/browse/HOLMES-565>`_ +- `Manually deployed rules are removed with no reason from Holmes. <https://jira.onap.org/browse/HOLMES-564>`_ +- `Holmes does not log the request ID and the transaction ID in the log file. <https://jira.onap.org/browse/HOLMES-563>`_ + +**Known Issues** + +- If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module. +- The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future. +- `Unable to perform CRUD operations on rules when multiple engine instances running <https://jira.onap.org/browse/HOLMES-493>`_ (a potential problem, not reproduced) +- `Inconsistency of alarm processing when multiple engine instances running <https://jira.onap.org/browse/HOLMES-494>`_ (a potential problem, not reproduced) + +**Security Issues** + +HOLMES code has been formally scanned during build time using NexusCloud and all critical vulnerabilities have been addressed. + +Quick Links: + +- `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ +- `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ + + +**Upgrade Notes** + +N/A + + +**Deprecation Notes** + +N/A + + +**Other** + +N/A + + Version: 10.0.0 --------------- |